Domain name for API request: cls.intl.tencentcloudapi.com.
This API is used to obtain the list of RemoteWrite delivery tasks.
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: DescribeRemoteWriteTasks. |
| Version | Yes | String | Common Params. The value used for this API: 2020-10-16. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| Filters.N | No | Array of Filter | - taskId Filter by [task ID]. Type: String Required: No - topicId Filter by [Log topic]. Type: String Required: No - taskStatus Filter by [task running status]. Supports 1: running, 2: stop, 3: exception.Type: String Required: No - name Filter by [task name] using fuzzy filtering. Type: String Required: No Each request can have up to 10 Filters. The maximum of Filter.Values is 10. |
| Offset | No | Integer | Page offset. Default value: 0 |
| Limit | No | Integer | Maximum number of entries per page. Default value: 20. Maximum value: 100. |
| Parameter Name | Type | Description |
|---|---|---|
| Infos | Array of RemoteWriteInfo | RemoteWrite information list. |
| TotalCount | Integer | Total number of RemoteWrite tasks. |
| 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. |
POST / HTTP/1.1
Host: cls.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRemoteWriteTasks
<Common request parameters>
{
"Offset": 0,
"Limit": 1
}
{
"Response": {
"Infos": [
{
"AuthInfo": null,
"AuthType": 0,
"CreateTime": "2023-09-07 11:16:50",
"Enable": 1,
"LogsetId": "e1111113-e816-4ae8-a8f7-edde0e2fc963",
"Name": "111111111",
"NetType": 1,
"RemoteWriteURL": "http://10.2.10.27:8080/api/v1/write",
"Status": 3,
"Target": "Prometheus",
"TaskId": "a2d1111-afae-467e-8816-0bc405283bec",
"TopicId": "376011111-76e0-48c7-bfff-018afc9bca48",
"UpdateTime": "2024-10-30 21:01:35",
"VirtualGatewayType": 0,
"VpcId": "vpc-11111"
}
],
"RequestId": "e02371b7-5ef0-4ae7-8a33-f703b9d5f564",
"TotalCount": 6
}
}
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 | Operation failed. |
| InternalError | Internal error. |
| InvalidParameter | Incorrect parameter. |
| InvalidParameter.TopicConflict | There is already a log topic with the same name in the specified logset. |
| LimitExceeded | The quota limit has been reached. |
| OperationDenied | Operation denied. |
| OperationDenied.ACLFailed | ACL verification failed. |
| OperationDenied.AccountDestroy | The account has been terminated. |
| OperationDenied.AccountIsolate | The account has overdue payments. |
| OperationDenied.AccountNotExists | The account does not exist. |
| ResourceNotFound | The resource does not exist. |
| ResourceNotFound.TopicNotExist | The log topic does not exist. |
피드백