查询分片信息

最近更新时间: 2026-09-17 00:05:09

1. 接口描述

接口请求域名： dcdb.api3.fincloud.tencent.cn。

本接口（DescribeDCDBShards）用于查询云数据库实例的分片信息。

默认接口请求频率限制：20次/秒。

接口更新时间：2023-11-15 12:33:13。

接口只验签名不鉴权。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：DescribeDCDBShards
Version	是	否	String	公共参数，本接口取值：2018-04-11
Region	是	否	String	公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
InstanceId	是	否	String	实例ID，形如：dcdbt-ow728lmc。示例值： tdsqlshard-mfktr7ji
ShardInstanceIds	否	否	Array of String	分片ID列表。示例值： [" shard-g7mxngqu"," shard-g7mxngqu"]
Offset	否	否	Int64	偏移量，默认为 0 示例值： 0
Limit	否	否	Int64	返回数量，默认为 20，最大值为 100。示例值： 20
OrderBy	否	否	String	排序字段，目前仅支持 createtime 示例值： createtime
OrderByType	否	否	String	排序类型， desc 或者 asc 示例值： desc

3. 输出参数

参数名称	类型	描述
TotalCount	Int64	符合条件的分片数量示例值： 2
Shards	Array of DCDBShardInfo	分片信息列表示例值：查看
DcnFlag	Int64	灾备标志，0-无，1-主实例，2-灾备实例示例值： 0
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
InternalError.CamAuthFailed	CAM鉴权请求失败。
InternalError.DbOperationFailed	查询数据库失败。
InternalError.FenceError	查询独享集群信息失败。
InternalError.GetInstanceDetailFailed	获取实例详情失败。
InternalError.GetInstanceInfoFailed	获取实例信息失败。
InternalError.GetVpcFailed	查询虚拟私有网络信息失败。
InternalError.InnerSystemError	内部系统错误。
InvalidParameter.GenericParameterError	参数合法性校验错误。
InvalidParameterValue.IllegalExclusterID	找不到数据库实例所属的独享集群。
InvalidParameterValue.SpecIdIllegal	找不到数据库实例对应的规格信息。
UnauthorizedOperation.PermissionDenied	没有权限操作该接口或资源。

5. 示例

示例1 查询云数据库分片信息

输入示例

https://dcdb.api3.fincloud.tencent.cn/?Action=DescribeDCDBShards
&InstanceId=dcdbt-ovulpcjf
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "09d5c691-c180-4c7f-8bcf-1ef6d1bab40c",
        "TotalCount": 2,
        "Shards": [
            {
                "ShardId": 10244,
                "InstanceId": "dcdbt-ovulpcjf",
                "ShardSerialId": "set_1536756357_1",
                "ShardInstanceId": "shard-5d4efnj7",
                "Status": 2,
                "StatusDesc": "运行中",
                "CreateTime": "2018-09-12 20:44:47",
                "VpcId": "vpc-5rkcp0wb",
                "SubnetId": "subnet-6ffate6q",
                "ProjectId": 0,
                "Region": "ap-region1",
                "Zone": "ap-region1-1",
                "Memory": 2,
                "Storage": 10,
                "PeriodEndTime": "2018-10-12 20:44:47",
                "NodeCount": 2,
                "StorageUsage": 0.1,
                "MemoryUsage": 37.2
            },
            {
                "ShardId": 10245,
                "InstanceId": "dcdbt-ovulpcjf",
                "ShardSerialId": "set_1536756415_3",
                "ShardInstanceId": "shard-8huhv1y9",
                "Status": 2,
                "StatusDesc": "运行中",
                "CreateTime": "2018-09-12 20:44:47",
                "VpcId": "vpc-5rkcp0wb",
                "SubnetId": "subnet-6ffate6q",
                "ProjectId": 0,
                "Region": "ap-region1",
                "Zone": "ap-region1-1",
                "Memory": 2,
                "Storage": 10,
                "PeriodEndTime": "2018-10-12 20:44:47",
                "NodeCount": 2,
                "StorageUsage": 0.1,
                "MemoryUsage": 15.1
            }
        ]
    }
}