1. 接口描述
接口请求域名： dcdb.tencentcloudapi.com 。
本接口（DescribeDCDBShards）用于查询云数据库实例的分片信息。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeDCDBShards。 |
| Version | 是 | String | 公共参数，本接口取值：2018-04-11。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| InstanceId | 是 | String | 实例ID，形如：dcdbt-ow728lmc。 示例值：dcdbt-ovulpcjf |
| ShardInstanceIds.N | 否 | Array of String | 分片ID列表。 示例值：["shard-5zf65smf","shard-ngbrea6b"] |
| Offset | 否 | Integer | 偏移量，默认为 0 示例值：0 |
| Limit | 否 | Integer | 返回数量，默认为 20，最大值为 100。 示例值：20 |
| OrderBy | 否 | String | 排序字段， 目前仅支持 createtime 示例值：createtime |
| OrderByType | 否 | String | 排序类型， desc 或者 asc 示例值：desc |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 符合条件的分片数量 示例值：2 |
| Shards | Array of DCDBShardInfo | 分片信息列表 |
| DcnFlag | Integer | 灾备标志，0-无，1-主实例，2-灾备实例 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 无
输入示例
POST / HTTP/1.1
Host: dcdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDCDBShards
<公共请求参数>
{
"InstanceId": "dcdbt-21dfpcv1"
}输出示例
{
"Response": {
"DcnFlag": 0,
"RequestId": "f976f43c-6dd3-4dbf-869b-a1b0eac50506",
"Shards": [
{
"Cpu": 2,
"CreateTime": "2021-12-01 11:49:54",
"InstanceId": "dcdbt-21dfpcv1",
"Memory": 4,
"MemoryUsage": 0.94,
"NodeCount": 2,
"Paymode": "prepaid",
"PeriodEndTime": "2023-01-01 11:12:24",
"Pid": 1002231,
"ProjectId": 0,
"ProxyVersion": "\"1.17.6-M-V2.0R723D002\"",
"Range": "0-31",
"Region": "ap-guangzhou",
"ShardId": 434,
"ShardInstanceId": "shard-ngbrea6b",
"ShardMasterZone": "ap-guangzhou-1",
"ShardSerialId": "set_1643096858_1",
"ShardSlaveZones": [
"ap-guangzhou-1"
],
"Status": 2,
"StatusDesc": "运行中",
"Storage": 10,
"StorageUsage": 0.01,
"SubnetId": "subnet-ovkcc9x6",
"VpcId": "vpc-j97vcvb5",
"Zone": "ap-guangzhou-2"
},
{
"Cpu": 1,
"CreateTime": "2021-12-01 11:49:54",
"InstanceId": "dcdbt-21dfpcv1",
"Memory": 2,
"MemoryUsage": 0.99,
"NodeCount": 2,
"Paymode": "prepaid",
"PeriodEndTime": "2023-01-01 11:12:24",
"Pid": 1002231,
"ProjectId": 0,
"ProxyVersion": "\"1.17.6-M-V2.0R723D002\"",
"Range": "32-63",
"Region": "ap-guangzhou",
"ShardId": 435,
"ShardInstanceId": "shard-5zf65smf",
"ShardMasterZone": "ap-guangzhou-1",
"ShardSerialId": "set_1643096949_3",
"ShardSlaveZones": [
"ap-guangzhou-1"
],
"Status": 2,
"StatusDesc": "运行中",
"Storage": 10,
"StorageUsage": 0.011,
"SubnetId": "subnet-ovkcc9x6",
"VpcId": "vpc-j97vcvb5",
"Zone": "ap-guangzhou-2"
}
],
"TotalCount": 2
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError.CamAuthFailed | CAM鉴权请求失败。 |
| InternalError.DbOperationFailed | 查询数据库失败。 |
| InternalError.FenceError | 查询独享集群信息失败。 |
| InternalError.GetInstanceDetailFailed | 获取实例详情失败。 |
| InternalError.GetInstanceInfoFailed | 获取实例信息失败。 |
| InternalError.GetVpcFailed | 查询虚拟私有网络信息失败。 |
| InternalError.InnerSystemError | 内部系统错误。 |
| InvalidParameter.GenericParameterError | 参数合法性校验错误。 |
| InvalidParameter.InstanceNotFound | 未找到请求的实例。 |
| InvalidParameterValue.IllegalExclusterID | 找不到数据库实例所属的独享集群。 |
| InvalidParameterValue.SpecIdIllegal | 找不到数据库实例对应的规格信息。 |
| UnauthorizedOperation.PermissionDenied | 没有权限操作该接口或资源。 |
