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

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

调试

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

请求参数

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

系统规定参数,取值:DescribeDatabases

DBClusterId String pc-xxxxxxxxxxxxxxx

集群ID。

DBName String test_db_4

数据库名。

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

返回数据

名称 类型 示例值 描述
Databases Array

数据库组成的集合。

Database
Accounts Array

账号组成的集合。

说明 不含高权限账号。
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-E76337B1B236

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeDatabases
&DBClusterId=pc-xxxxxxxxxxxxxxx
&<公共请求参数>

正常返回示例

XML 格式

<DescribeDatabasesResponse>
      <Databases>
            <Database>
                  <Accounts>
                        <Account>
                              <AccountPrivilege>ReadWrite</AccountPrivilege>
                              <AccountStatus>Available</AccountStatus>
                              <AccountName>test_admin</AccountName>
                              <PrivilegeStatus>Empowered</PrivilegeStatus>
                        </Account>
                  </Accounts>
                  <DBStatus>Running</DBStatus>
                  <DBDescription></DBDescription>
                  <DBName>test_db_4</DBName>
                  <Engine>POLARDB</Engine>
                  <CharacterSetName>utf8</CharacterSetName>
            </Database>
      </Databases>
      <RequestId>6A83E8E9-D5C4-45CE-85CD-B0A3B2F21F5E</RequestId>
</DescribeDatabasesResponse>

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-E76337B1B236"
  },
  "requestId": "EB88083B-AEE7-44B1-9AEB-E76337B1B236",
  "successResponse": true
}

错误码

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