文档

DescribeDispatchRule - 查询分派策略信息

更新时间:

调用DescribeDispatchRule接口查询分派策略信息。

接口说明

当前接口已不再维护,请使用新版告警管理的 ListNotificationPolicies 接口查询通知策略信息。

调试

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

授权信息

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

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

请求参数

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

分派策略 ID。

12345
RegionIdstring

地域 ID。

cn-hangzhou

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

34ED024E-9E31-434A-9E4E-D9D15C3****
DispatchRuleobject

返回结构体。

Namestring

分派策略名称。

Prometheus Alert
IsRecoverboolean

是否发送恢复的告警。

  • true:发送
  • false:不发送
true
DispatchTypestring

告警处理方式。

  • CREATE_ALERT:生成报警。
  • DISCARD_ALERT:丢弃报警事件,即不告警。
CREATE_ALERT
Statestring

是否启用该分派策略。

  • true:启用
  • false:关闭
true
RuleIdlong

分派规则 ID。

10282
GroupRulesobject []

事件分组。

RepeatIntervallong

重复告警静默时间。所有告警会以设置的时间间隔循环发送告警信息直至告警消失,单位为秒。

20
GroupIdlong

分组 ID。

1
GroupWaitTimelong

分组等待时间。

10
GroupIntervallong

分组间隔时间。

15
GroupingFieldsarray

分组字段列表。

string

分组字段列表。

_aliyun_arms_involvedObject_kind
NotifyRulesobject []

通知方式集合。

NotifyObjectsobject []

通知对象集合。

NotifyObjectIdstring

联系人或联系人组的 ID。

1
NotifyTypestring

通知对象类型:

  • CONTACT:联系人
  • CONTACT_GROUP:联系人组
CONTACT
Namestring

联系人或联系人组的名称。

JohnDoe
NotifyChannelsarray

通知方式列表。

string

通知方式:

  • dingTalk
  • sms
  • webhook
  • email
  • wechat
email
LabelMatchExpressionGridobject

分派规则。

LabelMatchExpressionGroupsobject []

分派条件集合。

LabelMatchExpressionsobject []

分派规则的条件。

Keystring

分派条件标签:

  • _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:告警等级
_aliyun_arms_involvedObject_kind
Valuestring

标签取值。

app
Operatorstring

选项:

  • eq:等于
  • re:匹配正则
eq

示例

正常返回示例

JSON格式

{
  "RequestId": "34ED024E-9E31-434A-9E4E-D9D15C3****",
  "DispatchRule": {
    "Name": "Prometheus Alert",
    "IsRecover": true,
    "DispatchType": "CREATE_ALERT",
    "State": "true",
    "RuleId": 10282,
    "GroupRules": [
      {
        "RepeatInterval": 20,
        "GroupId": 1,
        "GroupWaitTime": 10,
        "GroupInterval": 15,
        "GroupingFields": [
          "_aliyun_arms_involvedObject_kind"
        ]
      }
    ],
    "NotifyRules": [
      {
        "NotifyObjects": [
          {
            "NotifyObjectId": "1",
            "NotifyType": "CONTACT",
            "Name": "JohnDoe"
          }
        ],
        "NotifyChannels": [
          "email"
        ]
      }
    ],
    "LabelMatchExpressionGrid": {
      "LabelMatchExpressionGroups": [
        {
          "LabelMatchExpressions": [
            {
              "Key": "_aliyun_arms_involvedObject_kind",
              "Value": "app",
              "Operator": "eq"
            }
          ]
        }
      ]
    }
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2022-05-05API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
  • 本页导读 (1)
文档反馈