调用ListDatabases接口，获取一个实例下的数据库列表详情信息。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 ListDatabases

系统规定参数。取值：ListDatabases。

Tid Long 是 3***

租户ID。

说明 取自系统右上角头像处悬停展示的租户ID信息，详情请参见查看租户信息。
InstanceId String 是 12***

实例ID，取值来自ListInstances接口返回的实例信息中的实例ID，注意不是RDS的实例ID。
PageNumber Integer 是 1

第几页。
PageSize Integer 否 10

每页记录数。

返回数据

名称 类型 示例值 描述
TotalCount Long 1

实例下面库的个数。
RequestId String 5541CDA6-F674-435C-81BD-40C2FB926CE3

请求ID。
DatabaseList Array of Database

数据库详情列表。
Database
DatabaseId String 1

库ID
Host String xxx.xxx.xxx.xxx

库所属实例的连接地址。
CatalogName String 1

数据库目录名。
DbaName String dba_user

库所属DBA昵称。
State String NORMAL

库状态，取值和说明如下：

  • NORMAL： 正常
  • DISABLE：禁用
  • OFFLINE：下线
  • NOT_EXIST：不存在
DbaId String 1

DBA的ID。
SchemaName String test

库名。
InstanceId String 1

库所属实例的ID。
Port Integer 3306

库所属实例连接端口。
EnvType String dev

库所属环境类型。
Sid String test

库所属实例的Sid。
OwnerIdList Array of String 1

库Owner ID。
Encoding String utf-8

库编码。
DbType String mysql

数据库类型。
OwnerNameList Array of String owner_name

库Owner昵称。
SearchName String test@xxx.xxx.xxx.xxx:3306

搜索数据库的名称。
ErrorCode String UnknownError

错误码。
ErrorMessage String UnknownError

错误信息。
Success Boolean true

请求是否成功。

示例

请求示例

http(s)://dms-enterprise.aliyuncs.com/?Action=ListDatabases
&Tid=3***
&InstanceId=12***
&PageNumber=1
&公共请求参数

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<TotalCount>1</TotalCount>
<RequestId>5541CDA6-F674-435C-81BD-40C2FB926CE3</RequestId>
<Success>true</Success>
<DatabaseList>
    <Database>
        <Encoding>utf8</Encoding>
        <Host>pc-xxx.rwlb.rds.aliyuncs.com</Host>
        <InstanceId>24710</InstanceId>
        <DbType>polardb</DbType>
        <EnvType>product</EnvType>
        <OwnerIdList>
            <OwnerIds>88653</OwnerIds>
        </OwnerIdList>
        <DbaId>104442</DbaId>
        <OwnerNameList>
            <OwnerNames>dmstest</OwnerNames>
        </OwnerNameList>
        <Port>3306</Port>
        <DatabaseId>116366</DatabaseId>
        <State>NORMAL</State>
        <SearchName>xxx_test@pc-xxx.rwlb.rds.aliyuncs.com:3306【xxx_test】</SearchName>
        <DbaName>xxx[子账号]</DbaName>
        <SchemaName>xxx_test</SchemaName>
    </Database>
</DatabaseList>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalCount" : 1,
  "RequestId" : "5541CDA6-F674-435C-81BD-40C2FB926CE3",
  "Success" : true,
  "DatabaseList" : {
    "Database" : [ {
      "Encoding" : "utf8",
      "Host" : "pc-xxx.rwlb.rds.aliyuncs.com",
      "InstanceId" : 24710,
      "DbType" : "polardb",
      "EnvType" : "product",
      "OwnerIdList" : {
        "OwnerIds" : [ 88653 ]
      },
      "DbaId" : 104442,
      "OwnerNameList" : {
        "OwnerNames" : [ "dmstest" ]
      },
      "Port" : 3306,
      "DatabaseId" : 116366,
      "State" : "NORMAL",
      "SearchName" : "xxx_test@pc-xxx.rwlb.rds.aliyuncs.com:3306【xxx_test】",
      "DbaName" : "xxx[子账号]",
      "SchemaName" : "xxx_test"
    } ]
  }
}

错误码

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