Domain name for API request: cls.intl.tencentcloudapi.com.
Creating a Metric Pre-Aggregation Task Through a YAML File
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: CreateRecordingRuleYamlTask. |
| 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. |
| TopicId | Yes | String | Source metric topic id For reference: |
| DstTopicId | Yes | String | Target metric topic id, which can be the same as TopicId. |
| EnableFlag | Yes | Integer | Task status. Valid values: 1: enabled; 2: disabled. |
| ProcessStartTime | Yes | Integer | Execution start time, Unix timestamp. Unit: ms. |
| ProcessPeriod | Yes | Integer | Scheduling period (minutes). Supported range (0,1440] minutes. Measurement unit: minutes Can also use interval: duration in YAML to set execution interval individually for each group. |
| ProcessDelay | Yes | Integer | Execution delay. Set it to 30 seconds to avoid inaccuracy in pre-aggregation task calculation results due to latency in metric reporting. Unit: seconds |
| YamlConfigName | Yes | String | yaml configuration name |
| YamlContent | Yes | String | yaml configuration content Compatible with Prometheus Recording Rules configuration files. Please note the line breaks and indent in the string during API calls. |
| HasServicesLog | No | Integer | Whether to enable the delivery service log. 1: Disabled, 2: Enabled. |
| Parameter Name | Type | Description |
|---|---|---|
| YamlId | String | Yaml configuration id, can be associated with multiple subtasks |
| 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. |
Creating a Metric Pre-Aggregation Task Through a YAML File
POST / HTTP/1.1
Host: cls.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateRecordingRuleYamlTask
<Common request parameters>
{
"TopicId": "e66648c8-0d90-4a32-8009-b4ee9f4b3c7c",
"YamlConfigName": "demo",
"EnableFlag": 1,
"HasServicesLog": 2,
"ProcessPeriod": 1,
"ProcessDelay": 30,
"YamlContent": "groups:\n - name: example\n rules:\n - record: code:prometheus_http_requests_total:sum\n expr: sum by (code) (prometheus_http_requests_total)",
"DstTopicId": "e66648c8-0d90-4a32-8009-b4ee9f4b3c7c",
"ProcessStartTime": 1778309756421
}
{
"Response": {
"YamlId": "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.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. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback