文档

ListDatabasesForUser - 查询用户已授权的数据库列表

更新时间:

查询用户已授权的数据库列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
InstanceIdstring

堡垒机的实例 ID。

说明 可通过调用 DescribeInstances 接口获取堡垒机实例 ID。
bastionhost-cn-tl32swayw7o
RegionIdstring

堡垒机的地域 ID。

说明 地域 ID 和地域名称的对应关系,请参见地域和可用区
cn-hangzhou
UserIdstring

要查询已授权数据库的用户 ID。

3
PageNumberstring

设置从返回结果的第几页开始显示查询结果。默认值为 1,表示从第 1 页开始显示。

1
PageSizestring

指定分页查询时,每页显示的数据最大条数。
PageSize 参数最大取值为 100。每页默认显示的数据条数为 20 条,PageSize 参数值为空时,将默认返回 20 条数据。

说明 建议 PageSize 取值不要为空。
20
DatabaseNamestring

要查询的数据库实例名称。

MySQL-8.0
DatabaseAddressstring

指定要查询的数据库地址。仅支持精确查询。

47.101.**.**
DatabaseTypestring

指定要查询的数据库类型,取值:

  • MySQL
  • Oracle
  • PostgreSQL
  • SQLServer
MySQL
NetworkDomainIdstring

指定要查询已授权数据库列表的网络域 ID。

5

返回参数

名称类型描述示例值
object
Databasesobject []

查询到的数据库列表。

ActiveAddressTypestring

数据库地址类型。取值:

  • Public :公网地址
  • Private :私网地址
Private
Commentstring

数据库实例的备注信息。

comment
DatabaseIdstring

数据库实例 ID。

36
DatabaseNamestring

数据库实例名称。

MySQL56
DatabasePortlong

数据库的端口。

3306
DatabasePrivateAddressstring

数据库的私网地址,可为域名或 ip 地址。

rm-wz97******
DatabasePublicAddressstring

数据库的公网地址,可为域名或 ip 地址。

rm-uf65******
DatabaseTypestring

数据库类型,取值:

  • MySQL
  • Oracle
  • PostgreSQL
  • SQLServer
MySQL
NetworkDomainIdstring

数据库所属的网络域的 ID。

2
Sourcestring

数据库的来源。取值:

  • Local:本地数据库实例
  • Rds:RDS 类型数据库实例
  • PolarDB: PolarDB 类型数据库实例
Local
SourceInstanceIdstring

数据库对应的 RDS 实例 ID 或 PolarDB 实例 ID。

说明 SourceLocal 时,该参数返回值为空。
i-wz9fv2hwux78x9h1pmje
RequestIdstring

阿里云为该请求生成的唯一标识符。

A8A665B9-8550-4942-9DEE-73198051856B
TotalCountlong

查询到的数据库总数量。

15

示例

正常返回示例

JSON格式

{
  "Databases": [
    {
      "ActiveAddressType": "Private",
      "Comment": "comment",
      "DatabaseId": "36",
      "DatabaseName": "MySQL56",
      "DatabasePort": 3306,
      "DatabasePrivateAddress": "rm-wz97******",
      "DatabasePublicAddress": "rm-uf65******",
      "DatabaseType": "MySQL",
      "NetworkDomainId": "2",
      "Source": "Local",
      "SourceInstanceId": "i-wz9fv2hwux78x9h1pmje"
    }
  ],
  "RequestId": "A8A665B9-8550-4942-9DEE-73198051856B",
  "TotalCount": 15
}

错误码

HTTP status code错误码错误信息描述
400InvalidParameterThe argument is invalid.参数错误
500InternalErrorAn unknown error occurred.未知错误

访问错误中心查看更多错误码。

  • 本页导读 (1)
文档反馈