DescribeInstanceShards

Prev Next

search by keyword

Recent Pages

Documentation

Download PDF

Last updated: 2021-11-18 10:45:39

Download PDF

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.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

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 secondary 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 Sample request

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,
        "Runid": "af8945d6271e030ea17829b07c08e6c417bbff3d",
        "Connected": 1
      },
      {
        "Keys": 0,
        "Role": 1,
        "ShardId": "1",
        "ShardName": "crs-7ponppu3-003-02",
        "Slots": "[]",
        "Storage": 3035608,
        "StorageSlope": 0,
        "Runid": "0711f42e392386674313f264f371b1288d2f800f",
        "Connected": 1
      },
      {
        "Keys": 0,
        "Role": 0,
        "ShardId": "2",
        "ShardName": "crs-7ponppu3-001-01",
        "Slots": "[\"5461-10922\"]",
        "Storage": 3160280,
        "StorageSlope": 0.018086727708578,
        "Runid": "abf321a8ee9d4117f55b84ad9d70c3ef53f485af",
        "Connected": 1
      },
      {
        "Keys": 0,
        "Role": 1,
        "ShardId": "2",
        "ShardName": "crs-7ponppu3-001-02",
        "Slots": "[]",
        "Storage": 3036632,
        "StorageSlope": 0,
        "Runid": "9b8d9ec9ac452ab5a866cc8331a92c16e95e9dda",
        "Connected": 1
      },
      {
        "Keys": 0,
        "Role": 0,
        "ShardId": "3",
        "ShardName": "crs-7ponppu3-002-01",
        "Slots": "[\"10923-16383\"]",
        "Storage": 3055440,
        "StorageSlope": -0.015687562525272,
        "Runid": "3f299a51ad59fe7781e98b9ce6c807332931119b",
        "Connected": 1
      },
      {
        "Keys": 0,
        "Role": 1,
        "ShardId": "3",
        "ShardName": "crs-7ponppu3-002-02",
        "Slots": "[]",
        "Storage": 3035608,
        "StorageSlope": 0,
        "Runid": "0498c543d7a49d8f7fc27706edbaf5b38fcb31f6",
        "Connected": 1
      }
    ],
    "TotalCount": 6,
    "RequestId": "ca3000b6-bb8a-41fd-9074-11b5fda52d9f"
  }
}

5. Developer Resources

SDK

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

Command Line Interface

Tencent Cloud CLI 3.0

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.

Recent Pages