ListDatabases - 查询指定堡垒机实例下的数据库列表

查询指定堡垒机实例下的数据库列表。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
yundun-bastionhost:ListDatabases
  • 全部资源
    *

请求参数

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

指定要查询的堡垒机的实例 ID。

说明 您可以调用 DescribeInstances 接口获取该参数。
bastionhost-cn-7mz28f5tk0o
RegionIdstring

指定要查询的堡垒机所在的区域 ID。

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

指定分页查询时,当前页的页码。默认值为 1。

1
PageSizestring

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

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

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

  • MySQL
  • Oracle
  • PostgreSQL
  • SQLServer
MySQL
NetworkDomainIdstring

指定要查询的数据库所属的网络域 ID。

2
Sourcestring

指定要查询数据库的来源。取值:

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

指定要查询的资产组 ID。

说明 您可以调用 ListHostGroups 接口获取该参数。
20

返回参数

名称类型描述示例值
object
Databasesarray<object>

查询到的数据库列表。

itemobject
ActiveAddressTypestring

数据库地址类型。取值:

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

数据库的备注信息。

comment
DatabaseIdstring

数据库实例 ID。

9
DatabaseNamestring

数据库实例名称。

MySQL0
DatabasePortinteger

数据库的端口。

3306
DatabasePrivateAddressstring

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

rm-wz973w7******
DatabasePublicAddressstring

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

rm-uf65n2******
DatabaseTypestring

数据库类型,取值:

  • MySQL
  • Oracle
  • PostgreSQL
  • SQLServer
MySQL
NetworkDomainIdstring

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

8
Sourcestring

数据库的来源。取值:

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

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

说明 SourceLocal 时,该参数返回值为空。
i-wz9ejupczf41******
SourceInstanceRegionIdstring

数据库对应的 RDS 实例或 PolarDB 实例所在地域 ID。

cn-hangzhou
SourceInstanceStatestring

数据库实例状态。取值:

  • Normal :正常
  • Release: 已释放
Normal
RequestIdstring

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

EC9BF0F4-8983-491A-BC8C-1B4DD94976DE
TotalCountlong

查询到的数据库总数量。

4

示例

正常返回示例

JSON格式

{
  "Databases": [
    {
      "ActiveAddressType": "Public",
      "Comment": "comment",
      "DatabaseId": "9",
      "DatabaseName": "MySQL0",
      "DatabasePort": 3306,
      "DatabasePrivateAddress": "rm-wz973w7******",
      "DatabasePublicAddress": "rm-uf65n2******",
      "DatabaseType": "MySQL",
      "NetworkDomainId": "8",
      "Source": "Local",
      "SourceInstanceId": "i-wz9ejupczf41******",
      "SourceInstanceRegionId": "cn-hangzhou",
      "SourceInstanceState": "Normal"
    }
  ],
  "RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE",
  "TotalCount": 4
}

错误码

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

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