调用DescribeDatabases API查询数据库详情-云原生数据库 PolarDB-阿里云

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

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

polardb:DescribeDatabases

get

*DBCluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}

无

请求参数

名称	类型	必填	描述	示例值
DBClusterId	string	是	集群 ID。	pc-**************
DBName	string	否	数据库名。说明不支持填入多个数据库名称。	test_db
PageNumber	integer	否	页码，取值范围为大于 0 但不超过 Integer 最大值的整数，默认值为 1。	1
PageSize	integer	否	每页记录数，取值范围如下： 30 50 100 默认值为 30。	30

返回参数

名称	类型	描述	示例值
	object
PageRecordCount	integer	本页记录数。	1
Databases	object
Database	array<object>	数据库信息详情。
	array<object>
DBDescription	string	数据库备注。	test_des
DBStatus	string	数据库状态，取值范围如下： Creating：创建中 Running：使用中 Deleting：删除中	Running
DBName	string	数据库名称。	test_db
Engine	string	数据库引擎类型，取值范围如下： MySQL Oracle PostgreSQL	MySQL
MasterID	string	多主集群（库表）版的数据库所对应的主节点 ID。	2
CharacterSetName	string	字符集，详情请参见字符集表。	utf8mb4
Accounts	object
Account	array<object>	数据库账号信息详情。说明当集群为 PolarDB MySQL 版时，不含高权限账号。
	object
PrivilegeStatus	string	授权状态，取值范围如下： Empowering：授权中 Empowered：授权完成 Removing：移除权限中	Empowered
AccountStatus	string	账号状态，取值范围如下： Creating：创建中 Available：可用 Deleting：删除中	Available
AccountPrivilege	string	账号权限，取值范围如下： ReadWrite：读写 ReadOnly：只读 DMLOnly：只允许 DML DDLOnly：只允许 DDL ReadIndex：只读+索引	ReadOnly
AccountName	string	账号名称。说明当集群为 PolarDB MySQL 版时，不含高权限账号。	test_acc
RequestId	string	请求 ID。	E1DF8CA6-2300-448B-9ABF-760C4B******
PageNumber	integer	页码。	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	错误码	错误信息	描述
400	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.
400	InvalidPageSize.Malformed	The specified parameter PageSize is not valid.	指定的参数PageSize无效
400	InvalidPageNumber.Malformed	The specified parameter PageNumber is not valid.	指定的参数PageNumber无效
400	Database.ConnectError	db instance %s connect failed, please check instance status and database processlist	数据库实例连接失败，请检查实例状态和数据库进程列表
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	当前的记录中不存在提供的DBClusterId。
404	InvalidDBClusterId.NotFound	The DBInstanceId provided does not exist in our records.	当前的记录中不存在提供的DBClusterId。

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

变更历史

更多信息，参考变更详情。