文档

DescribeDatabases - 查询PolarDB指定集群的数据库详情

更新时间:

查询PolarDB指定集群的数据库详情。

调试

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

授权信息

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

请求参数

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

集群 ID。

pc-**************
DBNamestring

数据库名。

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

页码,取值范围为大于 0 但不超过 Integer 最大值的整数,默认值为 1

1
PageSizeinteger

每页记录数,取值范围如下:

  • 30
  • 50
  • 100

默认值为 30

30

返回参数

名称类型描述示例值
object
PageRecordCountinteger

本页记录数。

1
Databasesobject []

数据库信息详情。

DBDescriptionstring

数据库备注。

test_des
DBStatusstring

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

  • Creating:创建中
  • Running:使用中
  • Deleting:删除中
Running
DBNamestring

数据库名称。

test_db
Enginestring

数据库引擎类型,取值范围如下:

  • MySQL
  • Oracle
  • PostgreSQL
MySQL
MasterIDstring

多主集群(库表)版的数据库所对应的主节点 ID。

2
CharacterSetNamestring

字符集,详情请参见字符集表

utf8mb4
Accountsobject []

数据库账号信息详情。

说明 当集群为 PolarDB MySQL 版时,不含高权限账号。
PrivilegeStatusstring

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

  • Empowering:授权中
  • Empowered:授权完成
  • Removing:移除权限中
Empowered
AccountStatusstring

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

  • Creating:创建中
  • Available:可用
  • Deleting:删除中
Available
AccountPrivilegestring

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

  • ReadWrite:读写
  • ReadOnly:只读
  • DMLOnly:只允许 DML
  • DDLOnly:只允许 DDL
  • ReadIndex:只读+索引
ReadOnly
AccountNamestring

账号名称。

说明 当集群为 PolarDB MySQL 版时,不含高权限账号。
test_acc
RequestIdstring

请求 ID。

E1DF8CA6-2300-448B-9ABF-760C4B******
PageNumberinteger

页码。

1

示例

正常返回示例

JSON格式

{
  "PageRecordCount": 1,
  "Databases": {
    "Database": [
      {
        "DBDescription": "test_des",
        "DBStatus": "Running",
        "DBName": "test_db",
        "Engine": "MySQL",
        "MasterID": "2",
        "CharacterSetName": "utf8mb4",
        "Accounts": {
          "Account": [
            {
              "PrivilegeStatus": "Empowered",
              "AccountStatus": "Available",
              "AccountPrivilege": "ReadOnly",
              "AccountName": "test_acc"
            }
          ]
        }
      }
    ]
  },
  "RequestId": "E1DF8CA6-2300-448B-9ABF-760C4B******",
  "PageNumber": 1
}

错误码

HTTP status code错误码错误信息描述
400InvalidDBClusterId.MalformedThe specified parameter DBClusterId is not valid.指定的参数DBClusterId无效
400InvalidPageSize.MalformedThe specified parameter PageSize is not valid.指定的参数PageSize无效
400InvalidPageNumber.MalformedThe specified parameter PageNumber is not valid.指定的参数PageNumber无效
400Database.ConnectErrordb instance %s connect failed, please check instance status and database processlist数据库实例连接失败,请检查实例状态和数据库进程列表
404InvalidDBCluster.NotFoundThe DBClusterId provided does not exist in our records.当前的记录中不存在提供的DBClusterId。
404InvalidDBClusterId.NotFoundThe DBInstanceId provided does not exist in our records.当前的记录中不存在提供的DBClusterId。

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

变更历史

变更时间变更内容概要操作
2023-09-12OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 404 变更
    删除错误码:400