文档

CreateDispatchRule - 创建分派策略

更新时间:

创建分派策略。

接口说明

当前接口已不再维护,请使用新版告警管理的 CreateOrUpdateNotificationPolicy 接口创建或修改通知策略。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
arms:CreateDispatchRuleWrite
  • 全部资源
    *

请求参数

名称类型必填描述示例值
DispatchRulestring

分派条件的配置 JSON 串。关于此字段的详细说明参见下文关于参数 DispatchRule 的补充说明

{ "system": false, "ruleid": 10282, "name": "Prometheus Alert", "labelMatchExpressionGrid": { "labelMatchExpressionGroups": [ { "labelMatchExpressions": [ { "key": "_aliyun_arms_involvedObject_kind", "value": "app", "operator": "eq" } ] } ] }, "dispatchType": "CREATE_ALERT/DISCARD_ALERT", "isRecover": true, "groupRules": [ { "groupId": 1, "groupingFields": [ "alertname" ], "groupWait": 10, "groupInterval": 15, "repeatInterval": 20 } ], "notifyRules": [ { "notifyObjects": [ { "notifyType": "ARMS_CONTACT", "name": "JohnDoe", "notifyObjectId": 1 }, { "notifyType": "ARMS_CONTACT_GROUP", "name": "JohnDoe_group", "notifyObjectId": 2 } ], "notifyChannels":["dingTalk","wechat","webhook","email"] }, ], }
RegionIdstring

地域 ID。

cn-hangzhou

关于参数 DispatchRule 的补充说明

JSON 串示例及说明

{
  "system": false,        //分派条件是否可编辑。true:不可编辑;false:可编辑。
  "ruleid": 10282,           //分派规则 ID。
  "name": "Prometheus Alert",   //分派策略名称。
  "labelMatchExpressionGrid": {
    "labelMatchExpressionGroups": [     //设置分派条件。
      {
        "labelMatchExpressions": [
          {
            "key": "_aliyun_arms_involvedObject_kind",   //分派条件标签,详见下一节。
            "value": "app",                              //标签取值。
            "operator": "eq"                             //eq:等于;re:匹配正则。
          }
        ]
      }
    ]
  },
  "dispatchType": "CREATE_ALERT/DISCARD_ALERT",    //告警处理方式。CREATE_ALERT:就是生成报警;DISCARD_ALERT:丢弃报警事件,即不告警。
  "isRecover": true,               //是否发送恢复的告警。true:发送;false:不发送。
  "groupRules": [                  //设置事件分组。
    {
      "groupId": 1,               //分组 ID。
      "groupingFields": [         //指定相同字段内容的事件分到一个组:设置分组字段,相同字段的告警内容会分别通过独立信息发送给处理人。
        "alertname"
      ],
      "groupWait": 10,                 //分组等待时间:收到第一个告警后会等待设置的时间,等待分组时间后收到的所有告警会以一条信息发送给处理人。
      "groupInterval": 15,             //分组间隔时间:在重复告警静默时间内,如果有新告警产生,等待设置的时间后就会直接发送新的告警信息。
      "repeatInterval": 20             //重复告警静默时间:所有告警会以设置的时间间隔循环发送告警信息直至告警消失。
    }
  ],
  "notifyRules": [            //设置通知规则。
    {
      "notifyObjects": [
        {
          "notifyType": "ARMS_CONTACT",     //ARMS_CONTACT:联系人;ARMS_CONTACT_GROUP:联系人组。
          "name": "JohnDoe",                //联系人或联系人组的名称。
          "notifyObjectId": 1               //联系人或联系人组的 ID。
        },
        {
          "notifyType": "ARMS_CONTACT_GROUP",
          "name": "JohnDoe_group",
          "notifyObjectId": 2
        }
      ],
      "notifyChannels":["dingTalk","wechat","webhook","email"]     //通知方式:dingTalk( 钉钉)、sms(短信)、webhook、email(邮件)、wechat(微信)。
    },
  ],
}

分派标签取值枚举

  • _aliyun_arms_userid:用户 ID
  • _aliyun_arms_involvedObject_kind:关联对象类型
  • _aliyun_arms_involvedObject_id:关联对象 ID
  • _aliyun_arms_involvedObject_name:关联对象名称
  • _aliyun_arms_alert_name:告警名称
  • _aliyun_arms_alert_rule_id:告警规则对应的 ID
  • _aliyun_arms_alert_type:告警类型
  • _aliyun_arms_alert_level:告警等级

返回参数

名称类型描述示例值
object
DispatchRuleIdlong

分派策略 ID。

10413
RequestIdstring

请求 ID。

A5EC8221-08F2-4C95-9AF1-49FD998C****

示例

正常返回示例

JSON格式

{
  "DispatchRuleId": 10413,
  "RequestId": "A5EC8221-08F2-4C95-9AF1-49FD998C****"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
文档反馈