You need to enable JavaScript to run this app.
导航
托管 Prometheus
  • 文档首页
    • /
  • 托管 Prometheus

CreateAlertingRule

最近更新时间：2024.04.19 11:53:54

首次发布时间：2023.06.30 15:23:34

我的收藏

创建告警规则。

请求说明

  • 请求方式：POST
  • 请求地址：https://open.volcengineapi.com/?Action=CreateAlertingRule&Version=2021-03-03

请求参数

参数名称类型是否必选示例值描述
ActionString是CreateAlertingRule公共参数，本接口值：CreateAlertingRule。
VersionString是2021-03-03公共参数，本接口值：2021-03-03。
NameString是test告警规则名称，账户内唯一。
DescriptionString否这是一段描述告警规则描述信息。
TypeString是vmp/PromQL告警规则类型，固定值为vmp/PromQL。
QueryObject AlertingRuleQuery是-告警配置。
LevelsArray of AlertingRuleLevel是-告警等级。
NotifyPolicyIdString是8cd7b480-6387-44e5-aea4-db4ca2c4b47a告警通知策略 ID。
NotifyGroupPolicyIdString是ce4d942a-bac3-4ef6-b3a0-b7845b3b53bf告警聚合策略 ID。

AlertingRuleQuery

参数名称类型是否必选示例值描述
WorkspaceIdString是e28ae750-bbb8-4ff4-abf4-1e0e0f88808c工作区 ID。
PromQLString是sum(up)查询语句。

AlertingRuleLevel

参数名称类型是否必选示例值描述
LevelString是P0告警规则等级，包括：P0、P1 和 P2。

For

String

是

5m

告警持续时间，取值：

  • 0s：立即触发
  • 1m：1分钟
  • 2m：2分钟
  • 5m：5分钟
  • 10m：10分钟

Comparator

String

是

>

告警规则比较条件，取值：

  • > ：大于
  • >= ：大于等于
  • < ：小于
  • <= ：小于等于
  • == ：等于
  • != ：不等于
ThresholdFloat64是1.0告警规则阈值。

注意

Levels.Level 的值不能重复。

请求示例

POST /?Action=CreateAlertingRule&Version=2021-03-03
Content-Type:application/json
{
    "Name": "test",
    "Description": "这是一段描述",
    "Type": "vmp/PromQL",
    "Query": {
        "WorkspaceId": "e28ae750-bbb8-4ff4-abf4-1e0e0f88808c",
        "PromQL": "sum(up)"
    },
    "Levels": [
        {
            "Level": " P0",
            "For": " 5m",
            "Comparator": " >",
            "Threshold": 1.0
        }
    ],
    "NotifyPolicyId": "8cd7b480-6387-44e5-aea4-db4ca2c4b47a",
    "NotifyGroupPolicyId": "ce4d942a-bac3-4ef6-b3a0-b7845b3b53bf"
}

返回参数

参数名称类型示例值描述
IdString90b5a3da-3464-4718-92e4-039bf41d3cff告警规则 ID。

返回示例

HTTP/1.1 200 OK
Content-Type:application/json
{
    "ResponseMetadata": {
        "RequestId": "202211302208xxxx",
        "Action": "CreateAlertingRule",
        "Version": "2021-03-03",
        "Service": "vmp",
        "Region": "cn-beijing"
    },
    "Result": {
        "Id": "90b5a3da-3464-4718-92e4-039bf41d3cff"
    }
}

错误码

本接口错误码如下表所示，公共错误码请参见 公共错误码。

HTTP 状态码错误码错误信息描述
409Conflict.NameThe specified name conflicts with existing AlertingRule.同一账号下不能有同名告警规则。