tencent cloud

All product documents
APIs
DocumentationAPIsTencent Cloud TCHouse-PInformation Query APIsDescribeSimpleInstances
DescribeSimpleInstances
Last updated: 2025-03-04 16:51:53
DescribeSimpleInstances
Last updated: 2025-03-04 16:51:53

1. API Description

Domain name for API request: cdwpg.intl.tencentcloudapi.com.

This API is used to get a list of instance

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: DescribeSimpleInstances.
Version Yes String Common Params. The value used for this API: 2020-12-30.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
SearchInstanceId No String Search Instance Id
SearchInstanceName No String Search Instance Name
Offset No Integer
Offset
Limit No Integer Limit
SearchTags.N No Array of String Search Tags

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Total Count
Note: This field may return null, indicating that no valid values can be obtained.
InstancesList Array of InstanceSimpleInfoNew Instances List
Note: This field may return null, indicating that no valid values can be obtained.
ErrorMsg String Error Message
Note: This field may return null, indicating that no valid values can be obtained.
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.

4. Example

Example1 Get Instance List

Get Instance List

Input Example

POST / HTTP/1.1
Host: cdwpg.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSimpleInstances
<Common request parameters>

{
  "SearchInstanceId": null,
  "SearchInstanceName": null,
  "Offset":0,
  "Limit":5,
}

Output Example

{
    "Response": {
        "ErrorMsg": "",
        "InstancesList": [
            {
                "AccessInfo": "[{\"address\":\"192.168.22.104:9000\",\"protocol\":\"tcp\"}]",
                "CreateTime": "2025-03-03 14:25:01",
                "ExpireTime": "0000.00.00 00:00:00",
                "ID": 595,
                "InstanceId": "cdwpg-4dwmcu5n",
                "InstanceName": "cdwpg_test100",
                "PayMode": "POSTPAID_BY_HOUR",
                "Region": "eu-frankfurt",
                "RenewFlag": false,
                "SubnetId": "subnet-d05spb5o",
                "Version": "3.16.9.3",
                "VpcId": "vpc-5wsen2rn",
                "Zone": "eu-frankfurt-1"
            }
        ],
        "RequestId": "0b001664-c41d-4f33-920d-bea733b1f315",
        "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
InternalError.SystemError InternalError.SystemError
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

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

Contact Us
Technical Support

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

Submit a Ticket
7x24 Phone Support