Domain name for API request: rum.intl.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.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: DescribeTawInstances. |
| Version | Yes | String | Common Params. The value used for this API: 2021-06-22. |
| Region | No | String | Common Params. This parameter is not required. |
| 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 |
| 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, 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. |
Query RUM Business System Information
POST / HTTP/1.1
Host: run.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTawInstances
{
"Offset": 0,
"Limit": 1,
"Filters": [
{
"Name": "Region",
"Values": [
"ap-guangzhou"
]
},
{
"Name": "InstanceType",
"Values": [
"1"
]
}
]
}
{
"Response": {
"InstanceSet": [
{
"AreaId": 1,
"ChargeStatus": 1,
"ChargeType": 1,
"ClusterId": 0,
"CreatedAt": "2024-12-17 11:12:55",
"DataRetentionDays": 30,
"InstanceDesc": "test333",
"InstanceId": "****6GmpbKG4",
"InstanceName": "test-333",
"InstanceStatus": 2,
"InstanceType": 1,
"Tags": [
{
"Key": "SecondaryBusiness",
"Value": "UnassignedBusiness_200003722"
}
],
"UpdatedAt": "2024-12-18 18:22:01"
}
],
"RequestId": "8c3247ac-bafa-4e62-a73b-0b8c88e05202",
"TotalCount": 1
}
}
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. |
| FailedOperation.DataBaseException | Exceptional data operation. |
| InternalError | Internal error. |
| InvalidParameter | Incorrect parameter. |
피드백