Help & DocumentationTencentDB for RedisAPI DocumentationInstance APIsDescribeInstanceShards

DescribeInstanceShards

Last updated: 2020-03-20 17:05:47

PDF

Contents：

1. API Description

Domain name for API request: redis.tencentcloudapi.com.

This API is used to get the information of cluster edition instance shards.

A maximum of 20 requests can be initiated per second for this API.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: redis.ap-shanghai-fsi.tencentcloudapi.com

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: DescribeInstanceShards.
Version Yes String Common parameter. The value used for this API: 2018-04-12.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
InstanceId Yes String Instance ID
FilterSlave No Boolean Whether to filter out the slave node information

3. Output Parameters

Parameter Name Type Description
InstanceShards Array of InstanceClusterShard Information list of instance shards
TotalCount Integer Total number of instance shard nodes
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Request Example

Input Example

https://redis.tencentcloudapi.com/?Action=DescribeInstanceShards
&InstanceId=crs-7ponppu3
&<common request parameters>

Output Example

{
  "Response": {
    "InstanceShards": [
      {
        "Keys": 0,
        "Role": 0,
        "ShardId": "1",
        "ShardName": "crs-7ponppu3-003-01",
        "Slots": "[\"0-5460\"]",
        "Storage": 3096688,
        "StorageSlope": -0.002399486489594
      },
      {
        "Keys": 0,
        "Role": 1,
        "ShardId": "1",
        "ShardName": "crs-7ponppu3-003-02",
        "Slots": "[]",
        "Storage": 3035608,
        "StorageSlope": 0
      },
      {
        "Keys": 0,
        "Role": 0,
        "ShardId": "2",
        "ShardName": "crs-7ponppu3-001-01",
        "Slots": "[\"5461-10922\"]",
        "Storage": 3160280,
        "StorageSlope": 0.018086727708578
      },
      {
        "Keys": 0,
        "Role": 1,
        "ShardId": "2",
        "ShardName": "crs-7ponppu3-001-02",
        "Slots": "[]",
        "Storage": 3036632,
        "StorageSlope": 0
      },
      {
        "Keys": 0,
        "Role": 0,
        "ShardId": "3",
        "ShardName": "crs-7ponppu3-002-01",
        "Slots": "[\"10923-16383\"]",
        "Storage": 3055440,
        "StorageSlope": -0.015687562525272
      },
      {
        "Keys": 0,
        "Role": 1,
        "ShardId": "3",
        "ShardName": "crs-7ponppu3-002-02",
        "Slots": "[]",
        "Storage": 3035608,
        "StorageSlope": 0
      }
    ],
    "RequestId": "ca3000b6-bb8a-41fd-9074-11b5fda52d9f"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
FailedOperation.SystemError Internal system error, which is irrelevant to the business.
InvalidParameter.PermissionDenied The API has no CAM permissions.
InvalidParameterValue.UnSupportedType The instance type is not supported.