产品概述
产品功能
应用场景
Domain name for API request: rum.tencentcloudapi.com.
This API is used to query instance information.
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.
This document describes the parameters for Signature V1. It's recommended to use the V3 signature, which provides higher security. Note that for Signature V3, the common parameters need to be placed in the HTTP Header. See details.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common parameter. The value used for this API: DescribeTawInstances. |
| Version | Yes | String | Common parameter. The value used for this API: 2021-06-22. |
| Region | No | String | Common parameter. This parameter is not required for this API. |
| ChargeStatuses.N | No | Array of Integer | Billing status |
| ChargeTypes.N | No | Array of Integer | Billing type |
| Limit | No | Integer | Pagination limit |
| Offset | No | Integer | Pagination offset |
| AreaIds.N | No | Array of Integer | Region ID |
| InstanceStatuses.N | No | Array of Integer | Instance status (1: creating; 2: running; 3: exceptional; 4: restarting; 5: stopping; 6: stopped; 7: terminating; 8: terminated) |
| InstanceIds.N | No | Array of String | Instance ID |
| Filters.N | No | Array of Filter | Filter parameter |
| Parameter Name | Type | Description |
|---|---|---|
| InstanceSet | Array of RumInstanceInfo | Instance list |
| TotalCount | Integer | Total number of instances |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: rum.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTawInstances
<Common request parameters>
{}
{
"Response": {
"InstanceSet": [
{
"AreaId": "1",
"ChargeStatus": 1,
"ChargeType": 1,
"ClusterId": "1",
"CreatedAt": "2021-04-29 20:51:05",
"DataRetentionDays": "30",
"InstanceDesc": "",
"InstanceId": "taw-VJ2mHDEb",
"InstanceName": "test",
"InstanceStatus": 2,
"Tags": [],
"UpdatedAt": "2021-04-29 20:51:05"
},
{
"AreaId": "1",
"ChargeStatus": 1,
"ChargeType": 1,
"ClusterId": "1",
"CreatedAt": "2021-04-29 20:59:15",
"DataRetentionDays": "30",
"InstanceDesc": "",
"InstanceId": "taw-mE08H4Ez",
"InstanceName": "test",
"InstanceStatus": 2,
"Tags": [],
"UpdatedAt": "2021-04-29 20:59:15"
}
],
"RequestId": "d356e035-ac3d-4237-add9-50a44c01dd39",
"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 |
|---|---|
| AuthFailure | Error with CAM signature/authentication. |
| FailedOperation | Operation failed. |
| InternalError | Internal error. |
| InvalidParameter | Incorrect parameter. |
文档反馈