查询DRDS逻辑库下PolarDB集群具体信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| drds:DescribeDrdsDBCluster | get | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DrdsInstanceId | string | 是 | DRDS 实例 ID。 | drds********* |
| DbName | string | 是 | DRDS 数据库名称。 | drds_test |
| DbInstanceId | string | 是 | PolarDB 集群 ID。 | pc-***************** |
返回参数
示例
正常返回示例
JSON格式
{
"Success": true,
"RequestId": "60A77FD6-0DE4-4A34-B6FB-9C2673******",
"DbInstance": {
"ExpireTime": "2019-09-27 11:22:33",
"PayType": "Postpaid",
"DBInstanceStatus": 1,
"NetworkType": "VPC",
"Port": 3306,
"EngineVersion": 8,
"RdsInstType": "ignore",
"RemainDays": 0,
"DBInstanceId": "pc-*****************",
"DbInstType": "POLARDB",
"Engine": "POLARDB",
"ReadMode": "CUSTOM",
"Endpoints": {
"Endpoint": [
{
"ReadWeight": 85,
"EndpointId": "pe-*****************",
"NodeIds": "pi-*****************,pi-*****************"
}
]
},
"DBNodes": {
"DBNode": [
{
"DBNodeRole": "Reader",
"ZoneId": "cn-hangzhou-i",
"DBNodeId": "pi-***************",
"DBNodeStatus": "Running"
}
]
}
}
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | InvalidParameter.MasterDbInstanceRelease | The master db instance has been released | - |
| 500 | InternalError | The request processing has failed due to some unknown error. | 请求失败，内部错误 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|
暂无变更历史