产品动态
Domain name for API request: monitor.intl.tencentcloudapi.com.
This API is used to create an alerting rule.
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: CreatePrometheusAlertPolicy. |
| Version | Yes | String | Common Params. The value used for this API: 2018-07-24. |
| Region | No | String | Common Params. This parameter is not required for this API. |
| InstanceId | Yes | String | Instance ID |
| AlertRule | Yes | PrometheusAlertPolicyItem | Alert configuration |
| Parameter Name | Type | Description |
|---|---|---|
| Id | String | Alerting rule ID |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
This example shows you how to create an alerting rule.
POST / HTTP/1.1
Host: monitor.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreatePrometheusAlertPolicy
<Common request parameters>
{
"InstanceId": "xx",
"AlertRule": {
"Name": "xx",
"Rules": [
{
"Describe": "xx",
"Name": "xx",
"For": "xx",
"Labels": [
{
"Name": "xx",
"Value": "xx"
}
],
"Rule": "xx",
"Template": "xx",
"Annotations": [
{
"Name": "xx",
"Value": "xx"
}
]
}
],
"Notification": {
"AlertManager": {
"Url": "xx",
"ClusterId": "xx",
"ClusterType": "xx"
},
"RepeatInterval": "xx",
"WebHook": "xx",
"Enabled": true,
"PhoneNotifyOrder": [
1
],
"PhoneInnerInterval": 0,
"PhoneCircleInterval": 0,
"NotifyWay": [
"xx"
],
"ReceiverGroups": [
1
],
"PhoneArriveNotice": true,
"PhoneCircleTimes": 0,
"TimeRangeStart": "xx",
"Type": "xx",
"TimeRangeEnd": "xx"
},
"TemplateId": "xx",
"ClusterId": "xx",
"UpdatedAt": "xx",
"Id": "xx"
}
}{
"Response": {
"Id": "xx",
"RequestId": "xx"
}
}This example shows you how to create an alerting rule, with AlertManager being the alert channel.
POST / HTTP/1.1
Host: monitor.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreatePrometheusAlertPolicy
<Common request parameters>
{
"InstanceId": "xx",
"AlertRule": {
"Name": "xx",
"Rules": [
{
"Describe": "xx",
"Name": "xx",
"For": "xx",
"Labels": [
{
"Name": "xx",
"Value": "xx"
}
],
"Rule": "xx",
"Template": "xx",
"RuleState": 0,
"Annotations": [
{
"Name": "xx",
"Value": "xx"
}
]
}
],
"Notification": {
"AlertManager": {
"Url": "xx",
"ClusterId": "xx",
"ClusterType": "xx"
},
"RepeatInterval": "xx",
"WebHook": "xx",
"Enabled": true,
"PhoneNotifyOrder": [
1
],
"PhoneInnerInterval": 0,
"PhoneCircleInterval": 0,
"NotifyWay": [
"xx"
],
"ReceiverGroups": [
"xx"
],
"PhoneArriveNotice": true,
"PhoneCircleTimes": 0,
"TimeRangeStart": "xx",
"Type": "xx",
"TimeRangeEnd": "xx"
},
"TemplateId": "xx",
"ClusterId": "xx",
"UpdatedAt": "xx",
"Id": "xx"
}
}{
"Response": {
"Id": "alert-xxx",
"RequestId": "3dfe620f-11b8-4301-b279-1fdadedf7a59"
}
}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.ComponentClientUnpack | FailedOperation.ComponentClientUnpack |
| FailedOperation.Db | FailedOperation.Db |
| FailedOperation.DoTRPCTransferFailed | DoTRPCTransferFailed |
| FailedOperation.KubeClientConf | FailedOperation.KubeClientConf |
| FailedOperation.KubeCommon | FailedOperation.KubeCommon |
| InternalError | Internal error. |
| InternalError.Param | InternalError.Param |
| InternalError.UnexpectedInternal | InternalError.UnexpectedInternal |
| InvalidParameter.Param | InvalidParameter.Param |
| InvalidParameter.PromClusterNotFound | InvalidParameter.PromClusterNotFound |
| InvalidParameter.PromInstanceNotFound | InvalidParameter.PromInstanceNotFound |
| ResourceNotFound | The resource is not found. |
文档反馈