CreateDispatchRule_应用实时监控服务ARMS_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

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

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
arms:CreateDispatchRule
None
全部资源
*

请求参数

字段名称字段详情
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"] }, ], }参考取值来源:
    ListDispatchRule
    DescribeDispatchRule
    UpdatePrometheusAlertRule
    CreatePrometheusAlertRule
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:告警等级

返回参数

字段名称字段详情
DispatchRuleIdinteger<int64>

分派策略 ID。

注意 请注意,该值为 Long 类型,在某些语言中可能存在精度丢失的风险,请小心使用。
示例值:10413
RequestIdstring

请求 ID。

示例值:A5EC8221-08F2-4C95-9AF1-49FD998C****

返回示例

变更历史

暂无变更历史

相关示例