DescribeInstanceZoneInfo

最后更新时间:2021-11-18 10:45:39

1. API Description

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

This API is used to query Redis node information.

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: DescribeInstanceZoneInfo.
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 No String Instance ID, such as crs-6ubhgouj

3. Output Parameters

Parameter Name Type Description
TotalCount Integer The number of instance node groups
ReplicaGroups Array of ReplicaGroup The list of instance node groups
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=DescribeInstanceZoneInfo
&InstanceId=crs-6tl7uxxd
&<Common request parameters>

Output Example

{
  "Response": {
    "ReplicaGroups": [
      {
        "GroupId": 125101,
        "GroupName": "",
        "ZoneId": "ap-guangzhou-2",
        "Role": "master",
        "RedisNodes": [
          {
            "Keys": 39,
            "Slot": "0-16383",
            "Status": "normal",
            "NodeId": "5f83a663d58f092f4791630065cb3a76c50b40a5"
          }
        ]
      },
      {
        "GroupId": 125102,
        "GroupName": "ng-1",
        "ZoneId": "ap-guangzhou-3",
        "Role": "replica",
        "RedisNodes": [
          {
            "Keys": 0,
            "Slot": "",
            "Status": "normal",
            "NodeId": "bdc6d645f4741948cf51f93f7013edd64f44c3ba"
          }
        ]
      }
    ],
    "RequestId": "e3d683fc-f2ff-43c9-980d-fae7a1166abc",
    "TotalCount": 2
  }
}

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

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.
FailedOperation.UnSupportError The instance does not support this API.
FailedOperation.Unknown Invalid data is entered for weekday.
InternalError.DbOperationFailed Internal system error with the database operation, which may be update, insert, select, etc.
InvalidParameter Incorrect parameter.
InvalidParameter.EmptyParam The parameter is empty.
InvalidParameter.InvalidParameter Invalid service parameter.
InvalidParameter.PermissionDenied The API has no CAM permissions.
UnauthorizedOperation.NoCAMAuthed No CAM permissions.