查询分片信息
最近更新时间: 2024-09-03 18:49:56
1. 接口描述
接口请求域名： dcdb.api3.cloud.sunhongs.com。
本接口（DescribeDCDBShards）用于查询云数据库实例的分片信息。
默认接口请求频率限制：20次/秒。
接口更新时间：2020-08-27 16:08:46。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeDCDBShards |
| Version | 是 | 否 | String | 公共参数，本接口取值：2018-04-11 |
| Region | 是 | 否 | String | 公共参数，详见产品支持的地域列表(TODO) |
| InstanceId | 是 | 否 | String | 实例ID，形如：dcdbt-ow728lmc。 |
| ShardInstanceIds | 否 | 否 | Array of String | 分片ID列表。 |
| Offset | 否 | 否 | Int64 | 偏移量，默认为 0 |
| Limit | 否 | 否 | Int64 | 返回数量，默认为 20，最大值为 100。 |
| OrderBy | 否 | 否 | String | 排序字段， 目前仅支持 createtime |
| OrderByType | 否 | 否 | String | 排序类型， desc 或者 asc |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Int64 | 此参数对外不可见。 符合条件的分片数量 |
| Shards | DCDBShardInfo | 此参数对外不可见。 分片信息列表 |
| DcnFlag | Int64 | 此参数对外不可见。 灾备标志，0-无，1-主实例，2-灾备实例 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError.CamAuthFailed | |
| InternalError.DbOperationFailed | |
| InternalError.FenceError | |
| InternalError.GetInstanceDetailFailed | |
| InternalError.GetInstanceInfoFailed | |
| InternalError.GetVpcFailed | |
| InternalError.InnerSystemError | |
| InvalidParameter.GenericParameterError | |
| InvalidParameterValue.IllegalExclusterID | |
| InvalidParameterValue.SpecIdIllegal | |
| UnauthorizedOperation.PermissionDenied |