调用DescribeDatabases接口查询PolarDB指定集群的数据库列表信息。

如果查询参数类型错误,将返回错误提示,返回数据为空。

调试

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

请求参数

名称 位置 类型 是否必选 示例值 描述
Action Query String DescribeDatabases

系统规定参数,取值为DescribeDatabases

DBClusterId Query String pc-**************

集群ID。

DBName Query String test_db_4

数据库名。

说明 不支持填入多个数据库名称。

返回数据

名称 类型 示例值 描述
Databases Array of Database

数据库组成的集合。

Database
Accounts Array of Account

账号组成的集合。

说明 不含高权限账号。
Account
AccountName String test_admin

账号名。

说明 不含高权限账号。
AccountPrivilege String ReadWrite

账号权限,取值范围如下。

  • ReadWrite:读写。
  • ReadOnly:只读 。
  • DMLOnly:只允许DML。
  • DDLOnly:只允许DDL。
AccountStatus String Available

账号状态,取值范围如下:

  • Creating:创建中。
  • Available:可用。
  • Deleting:删除中。
PrivilegeStatus String Empowered

授权状态,取值范围如下:

  • Empowering:授权中。
  • Empowered:授权完成。
  • Removing:移除权限中。
CharacterSetName String utf8

字符集,参见字符集表

DBDescription String test_db

数据库备注。

DBName String test_db_4

数据库名。

DBStatus String Running

数据库状态,取值范围如下:

  • Creating:创建中。
  • Running:使用中。
  • Deleting:删除中。
Engine String POLARDB

引擎。

RequestId String EB88083B-AEE7-44B1-9AEB-E76337******

请求ID。

示例

请求示例

http(s)://polardb.aliyuncs.com/?Action=DescribeDatabases
&DBClusterId=pc-**************
&<公共请求参数>

正常返回示例

XML 格式

<code>200</code>
<data>
    <Databases>
        <Database>
            <CharacterSetName>utf8</CharacterSetName>
            <DBDescription/>
            <DBName>test_db_2</DBName>
            <DBStatus>Running</DBStatus>
            <Accounts>
                <Account>
                    <AccountStatus>Available</AccountStatus>
                    <AccountPrivilege>ReadWrite</AccountPrivilege>
                    <PrivilegeStatus>Empowered</PrivilegeStatus>
                    <AccountName>test_a</AccountName>
                </Account>
                <Account>
                    <AccountStatus>Available</AccountStatus>
                    <AccountPrivilege>ReadOnly</AccountPrivilege>
                    <PrivilegeStatus>Empowered</PrivilegeStatus>
                    <AccountName>test_acc</AccountName>
                </Account>
            </Accounts>
            <Engine>POLARDB</Engine>
        </Database>
        <Database>
            <CharacterSetName>utf8mb4</CharacterSetName>
            <DBDescription/>
            <DBName>test_db_5</DBName>
            <DBStatus>Running</DBStatus>
            <Accounts>
                <Account>
                    <AccountStatus>Available</AccountStatus>
                    <AccountPrivilege>ReadWrite</AccountPrivilege>
                    <PrivilegeStatus>Empowered</PrivilegeStatus>
                    <AccountName>test_acc</AccountName>
                </Account>
            </Accounts>
            <Engine>POLARDB</Engine>
        </Database>
    </Databases>
    <RequestId>EB88083B-AEE7-44B1-9AEB-E76337******</RequestId>
</data>
<requestId>EB88083B-AEE7-44B1-9AEB-E76337******</requestId>
<successResponse>true</successResponse>

JSON 格式

{
  "code": "200",
  "data": {
    "Databases": {
      "Database": [
        {
          "CharacterSetName": "utf8",
          "DBDescription": "",
          "DBName": "test_db_2",
          "DBStatus": "Running",
          "Accounts": {
            "Account": [
              {
                "AccountStatus": "Available",
                "AccountPrivilege": "ReadWrite",
                "PrivilegeStatus": "Empowered",
                "AccountName": "test_a"
              },
              {
                "AccountStatus": "Available",
                "AccountPrivilege": "ReadOnly",
                "PrivilegeStatus": "Empowered",
                "AccountName": "test_acc"
              }
            ]
          },
          "Engine": "POLARDB"
        },
        {
          "CharacterSetName": "utf8mb4",
          "DBDescription": "",
          "DBName": "test_db_5",
          "DBStatus": "Running",
          "Accounts": {
            "Account": [
              {
                "AccountStatus": "Available",
                "AccountPrivilege": "ReadWrite",
                "PrivilegeStatus": "Empowered",
                "AccountName": "test_acc"
              }
            ]
          },
          "Engine": "POLARDB"
        }
      ]
    },
    "RequestId": "EB88083B-AEE7-44B1-9AEB-E76337******"
  },
  "requestId": "EB88083B-AEE7-44B1-9AEB-E76337******",
  "successResponse": true
}

错误码

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