Domain name for API request: redis.intl.tencentcloudapi.com.
This API is used to query the list of Redis instances. It is now deprecated.
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: DescribeCommonDBInstances. |
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. |
VpcIds.N | No | Array of Integer | List of VPC IDs |
SubnetIds.N | No | Array of Integer | List of subnet IDs |
PayMode | No | Integer | List of billing modes. 0: monthly subscription; 1: pay-as-you-go |
InstanceIds.N | No | Array of String | Instance ID filter information list, with a maximum array length of 100. |
InstanceNames.N | No | Array of String | List of instance names |
Status.N | No | Array of String | List of instance status |
OrderBy | No | String | Sorting field |
OrderByType | No | String | Sorting order |
Vips.N | No | Array of String | List of instance VIPs |
UniqVpcIds.N | No | Array of String | List of VPC IDs |
UniqSubnetIds.N | No | Array of String | List of unique subnet IDs |
Limit | No | Integer | Quantity limit. Recommended default value: 100. |
Offset | No | Integer | Offset. Default value: 0 |
Parameter Name | Type | Description |
---|---|---|
TotalCount | Integer | Number of instances |
InstanceDetails | Array of RedisCommonInstanceList | Instance information |
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. |
Disused APIs
https://redis.intl.tencentcloudapi.com/?Action=DescribeCommonDBInstances&PayMode=0&InstanceIds.0=crs-nh47ubwr&<Common request parameters>
{
"Response": {
"TotalCount": 0,
"InstanceDetails": [
{
"InstanceName": "abc",
"InstanceId": "abc",
"AppId": 0,
"ProjectId": 0,
"Region": "abc",
"Zone": "abc",
"VpcId": "abc",
"SubnetId": "abc",
"Status": "abc",
"Vips": [
"abc"
],
"Vport": 0,
"Createtime": "abc",
"PayMode": 0,
"NetType": 0
}
],
"RequestId": "abc"
}
}
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.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. |
Was this page helpful?