Domain name for API request: redis.intl.tencentcloudapi.com.
This API is used to query the details of a Redis node.
A maximum of 20 requests can be initiated per second for this API.
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 Params. The value used for this API: DescribeInstanceZoneInfo. |
Version | Yes | String | Common Params. The value used for this API: 2018-04-12. |
Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
InstanceId | No | String | ID of a specified instance, such as "crs-xjhsdj****" Log in to the Redis console and copy the instance ID in the instance list. |
Parameter Name | Type | Description |
---|---|---|
TotalCount | Integer | Number of instance node groups |
ReplicaGroups | Array of ReplicaGroup | List of instance node groups |
RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
This example shows you how to query the node information of a specified instance.
https://redis.intl.tencentcloudapi.com/?Action=DescribeInstanceZoneInfo&InstanceId=crs-6tl7****&<Common request parameters>
{
"Response": {
"ReplicaGroups": [
{
"GroupId": 125101,
"GroupName": "",
"ZoneId": "ap-guangzhou-2",
"Role": "master",
"RedisNodes": [
{
"Keys": 39,
"Slot": "0-16383",
"Status": "normal",
"Role": "master",
"NodeId": "5f83a663d58f092f4791630065cb3a76c50b40a5"
}
]
},
{
"GroupId": 125102,
"GroupName": "ng-1",
"ZoneId": "ap-guangzhou-3",
"Role": "replica",
"RedisNodes": [
{
"Keys": 0,
"Slot": "",
"Status": "normal",
"Role": "replica",
"NodeId": "bdc6d645f4741948cf51f93f7013edd64f44c3ba"
}
]
}
],
"RequestId": "e3d683fc-f2ff-43c9-980d-fae7a1166abc",
"TotalCount": 2
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
Was this page helpful?