Domain name for API request: monitor.tencentcloudapi.com.
This API is used to update a Prometheus alerting rule.
Note that alert object and alert message are special fields of Prometheus Rule Annotations, which need to be passed in through annotations
and correspond to summary
and description
keys respectively. For more information, see Alerting rules.
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: UpdateAlertRule. |
Version | Yes | String | Common Params. The value used for this API: 2018-07-24. |
Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley. |
RuleId | Yes | String | Prometheus alerting rule ID |
InstanceId | Yes | String | Prometheus instance ID |
RuleState | Yes | Integer | Rule status code. Valid values: Default value: 2 (enabled). |
RuleName | Yes | String | Alerting rule name |
Expr | Yes | String | Alerting rule expression |
Duration | Yes | String | Alerting rule duration |
Receivers.N | Yes | Array of String | List of alerting rule recipient groups |
Labels.N | No | Array of PrometheusRuleKV | List of alerting rule tags |
Annotations.N | No | Array of PrometheusRuleKV | List of alerting rule annotations. Alert object and alert message are special fields of Prometheus Rule Annotations, which need to be passed in through annotations and correspond to summary and description keys respectively. |
Type | No | String | Alerting rule template category |
Parameter Name | Type | Description |
---|---|---|
RuleId | String | Rule ID |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
https://monitor.tencentcloudapi.com/?Action=UpdateAlertRule
&InstanceId=my-prom-gg
&RuleId=arule-omq28fcm
&RuleState=2
&RuleName=exampleName
&Expr=job:request_latency_seconds:mean5m{job=\"myjob\"}>0.5
&Duration=1m
&Receivers.0=33432
&<Common request parameters>
{
"Response": {
"RequestId": "qyh38g1ium4-41o5k994o7hcxuq96zab",
"RuleId": "arule-omq28fcm"
}
}
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.BadYamlFormat | The YAML format is incorrect. |
FailedOperation.DbQueryFailed | Failed to query the database. |
FailedOperation.DbRecordCreateFailed | Failed to create the database record. |
FailedOperation.DbRecordDeleteFailed | Failed to delete the database record. |
FailedOperation.DbRecordUpdateFailed | Failed to update the database record. |
FailedOperation.GenerateInstanceIDFailed | An error occurred while generating the resource ID. |
FailedOperation.ResourceExist | The resource already exists. |
FailedOperation.ResourceNotFound | The resource does not exist. |
InternalError | Internal error. |
InvalidParameter | Invalid parameter. |
Was this page helpful?