tencent cloud

Feedback

DescribeCommonDBInstances

Last updated: 2022-08-23 15:52:24

1. API Description

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

This API has been disused. It was used to query the list of Redis instance 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 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 List of instance IDs
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

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Number of instances
InstanceDetails Array of RedisCommonInstanceList Instance information
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=DescribeCommonDBInstances
&PayMode=0
&InstanceIds.0=crs-nh47ubwr
&<Common request parameters>

Output Example

{
    "Response": {
        "InstanceDetails": [
            {
                "AppId": 251006366,
                "Createtime": "2020-05-06 19:38:19",
                "InstanceId": "crs-nh47ubwr",
                "InstanceName": "crs-nh47ubwr",
                "NetType": 1,
                "PayMode": 1,
                "ProjectId": 1075668,
                "Region": "ap-guangzhou",
                "Status": "1",
                "SubnetId": 1210162,
                "Vips": [
                    "172.16.1.84"
                ],
                "VpcId": "79963",
                "Vport": 6379,
                "Zone": ""
            }
        ],
        "RequestId": "e306be36-f01b-477a-bdfb-e63d9b16d0a5",
        "TotalCount": 1
    }
}

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.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.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support