查询PolarDB指定集群的数据库详情。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DBClusterId | string | 是 | 集群 ID。 | pc-************** |
| DBName | string | 否 | 数据库名。 说明
不支持填入多个数据库名称。
| test_db |
| PageNumber | integer | 否 | 页码，取值范围为大于 0 但不超过 Integer 最大值的整数，默认值为 1。 | 1 |
| PageSize | integer | 否 | 每页记录数，取值范围如下：
默认值为 30。 | 30 |
返回参数
示例
正常返回示例
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. | 指定的参数DBClusterId无效 |
| 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。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 | ||||||
|---|---|---|---|---|---|---|---|---|
| 2023-09-12 | OpenAPI 错误码发生变更 | 看变更集 | ||||||
|