查询分片信息

最近更新时间:2018-09-28 14:59:50

1. 接口描述

接口请求域名: dcdb.tencentcloudapi.com 。

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

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

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi )时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:dcdb.ap-shanghai-fsi.tencentcloudapi.com 。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeDCDBShards
Version String 公共参数,本接口取值:2018-04-11
Region String 公共参数,详见产品支持的地域列表
InstanceId String 实例ID,形如:dcdbt-ow728lmc。
ShardInstanceIds.N Array of String 分片Id列表。
Offset Integer 偏移量,默认为 0
Limit Integer 返回数量,默认为 20,最大值为 100。
OrderBy String 排序字段, 目前仅支持 createtime
OrderByType String 排序类型, desc 或者 asc

3. 输出参数

参数名称 类型 描述
TotalCount Integer 符合条件的分片数量
Shards Array of DCDBShardInfo 分片信息列表
RequestId String 唯一请求ID,每次请求都会返回。定位问题时需要提供该次请求的RequestId。

4. 示例

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

输入示例

https://dcdb.tencentcloudapi.com/?Action=DescribeDCDBShards
&InstanceId=dcdbt-ovulpcjf
&<公共请求参数>

输出示例

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

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、 SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集( SDK ),支持多种编程语言,能更方便的调用 API 。

命令行工具

6. 错误码

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

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