调用DescribeDrdsShardingDbs接口查询PolarDB-X下的水平拆分数据库。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| drds:DescribeDrdsShardingDbs | get | *instance acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/{#DbName} |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DrdsInstanceId | string | 是 | PolarDB-X 的实例 ID。 | drdshbgaf3c63qbo |
| DbName | string | 是 | PolarDB-X 实例的数据库名称。 | drds_test |
| DbNamePattern | string | 否 | 数据库匹配格式。 | test |
| PageNumber | long | 否 | 当前页数。 | 1 |
| PageSize | long | 否 | 每页大小。 | 20 |
返回参数
示例
正常返回示例
JSON格式
{
"Success": true,
"RequestId": "509BDE17-505A-4B3B-854D-30D3F092502F",
"ShardingDbs": {
"ShardingDb": [
{
"MinPoolSize": 5,
"MaxPoolSize": 60,
"DbInstanceId": "rm-bp1hjzn0yv5j2****",
"ConnectUrl": "100.100.64.100:11569",
"GroupName": "TEMP1_1568171495522SABE_KUP4_0000",
"DbType": "mysql",
"IdleTimeOut": 30,
"ShardingDbName": "temp1_zhk1_0000",
"BlockingTimeout": 5000,
"PreparedStatementCacheSize": 0,
"ConnectionProperties": "connectTimeout=3000;autoReconnect=true;failOverReadOnly=false;socketTimeout=900000;rewriteBatchedStatements=true;characterEncoding=utf8",
"UserName": "pg284mi8",
"DbStatus": "running"
}
]
},
"PageNumber": 1,
"PageSize": 20,
"Total": 1
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | ActionUnauthorized | The specified action is not available for you | 指定的action未授权，请您先做RAM授权再进行操作。 |
| 400 | ServiceUnable | The service is not available now, please try again later | - |
| 400 | InvalidParameter.Mismatch | The specified parameter does not match. | - |
| 400 | InvalidDbname.MalFormed | The specified db name does not match. | - |
| 400 | InvalidDRDSInstanceId.NotFound | The DrdsInstanceId provided does not exist in our records | - |
| 400 | InvalidDbName.NotFound | The Drds DbName provided does not exist in our records | - |
| 404 | InvalidDRDSInstanceId.NotFound | The DrdsInstanceId provided does not exist in our records. | - |
| 404 | InvalidDbName.NotFound | The Drds DbName provided does not exist in our records. | - |
| 500 | InternalError | The request processing has failed due to some unknown error. | 请求失败，内部错误 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|
暂无变更历史