Domain name for API request: cls.intl.tencentcloudapi.com.
This API is used to modify a scheduled pre-aggregation task.
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: ModifyRecordingRuleTask. |
| 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. |
| TaskId | Yes | String | Task ID. |
| TopicId | Yes | String | Source metric topic id |
| DstTopicId | No | String | Target metric topic id. |
| Name | No | String | Task Name |
| EnableFlag | No | Integer | Task start status. 1: Enabled, 2: Disabled |
| ProcessStartTime | No | Integer | Schedule start time, Unix timestamp, in milliseconds |
| ProcessPeriod | No | Integer | Scheduling interval (minutes), supported range (0,1440] minutes. |
| ProcessDelay | No | Integer | Execution Delay (Seconds) |
| MetricName | No | String | Metric name |
| RecordingRuleContent | No | String | Execution statement (PromQL) |
| CustomMetricLabels.N | No | Array of MetricLabel | Custom metric name |
| HasServicesLog | No | Integer | Whether to enable service log shipping. Valid values: 1: disable; 2: enable. |
| Parameter Name | Type | Description |
|---|---|---|
| TaskId | String | Pre-aggregation task id. |
| 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. |
This API is used to modify a pre-aggregation task.
POST / HTTP/1.1
Host: cls.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyRecordingRuleTask
<Common request parameters>
{
"TaskId": "abdcebec-0242-43af-bb20-270359fb54a7",
"TopicId": "e66648c8-0d90-xxxx-8009-b4ee9f4b3c7c",
"Name": "demo",
"EnableFlag": 1,
"RecordingRuleContent": "sum by (code)(prometheus_http_requests_total)",
"MetricName": "demo_metric",
"CustomMetricLabels": [
{
"Key": "demo_key",
"Value": "demo_value"
}
],
"HasServicesLog": 2,
"ProcessPeriod": 1,
"ProcessDelay": 30,
"DstTopicId": "e66648c8-0d90-xxxx-8009-b4ee9f4b3c7c",
"ProcessStartTime": 1778308263665
}
{
"Response": {
"TaskId": "abdcebec-0242-43af-bb20-270359fb54a7",
"RequestId": "6ef60bec-0242-43af-bb20-270359fb54a7"
}
}
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. |
| MissingParameter | Missing parameter. |
| 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. |
文档反馈