ListDIAlarmRules - 查询告警规则_大数据开发治理平台 DataWorks(DataWorks)-阿里云帮助中心

查看数据集成报警规则。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
JobId	long	否	任务 ID。	1000001
PageNumber	integer	否	请求的数据页数，用于翻页。	1
PageSize	integer	否	每页显示的条数，默认为 10 条，最大 100 条。	10
DIAlarmRuleId	long	否	指定查询特定的告警规则 ID，如为空，则查询 JobId 下的所有告警规则。	34988

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求的 ID。用于定位日志，排查问题。	74C2FECD-5B3A-554A-BCF5-351A36DE9815
PagingInfo	object	分页信息
TotalCount	long	满足条件的数据总条数。	90
PageNumber	long	分页页码，从 1 开始。	1
PageSize	long	每页显示的条数	10
DIJobAlarmRules	array<object>	告警规则列表。
DIJobAlarmRules	object	单个告警规则详情。
DIAlarmRuleId	long	告警规则 ID。	72402
DIJobId	long	任务 ID。	32594
Description	string	告警规则描述。	rule descrition
MetricType	string	告警指标类型，可选的枚举值： Heartbeat（任务状态报警） FailoverCount（failover 次数报警） Delay（任务延迟报警） DdlReport（DDL 通知） ResourceUtilization（资源组使用率）	Heartbeat
Name	string	告警规则名称。	rule_name
Enabled	boolean	告警规则是否启用。	True
TriggerConditions	array<object>	告警触发条件列表，支持多条件。
TriggerConditions	object	告警触发条件。
Severity	string	严重程度，可选的枚举值： Warning Critical	Critical
Duration	long	告警计算时间区间，单位分钟。	1
Threshold	long	告警阈值。任务状态报警：无阈值。 failover 次数报警：阈值为 failover 次数。任务延迟报警：阈值为延迟时长，单位秒。	5
DdlReportTags	array	在 MetricType 配置为 DdlReport 时才返回需要生效的 DDL 列表。
DdlReportTags	string	在 MetricType 配置为 DdlReport 时才返回需要生效的 DDL 列表，包括 AlterAddColumn 加列 AlterDropColumn 删列 AlterRenameColumn 修改列名 AlterRenameTable 修改表名 AlterTableModify 其他修改表	ALTERADDCOLUMN
NotificationSettings	object	告警通知渠道和接收人设置。
NotificationChannels	array<object>	告警通知渠道数组。
NotificationChannels	object	单个告警通知渠道。
Severity	string	严重程度，可选的枚举值： Warning Critical	Critical
Channels	array	告警通道设置数组。
Channels	string	通道，可选的枚举值; Mail（邮件） Phone（电话） Sms（短信） Ding（钉钉）	Ding
NotificationReceivers	array<object>	告警通知接收方。
NotificationReceiver	object	告警通知接收方。
ReceiverType	string	接收方类型，取值范围：AliyunUid/DingToken/FeishuToken/WebHookUrl	DingToken
ReceiverValues	array	接收方取值。当接收方类型为阿里云 ID 时，接收方取值为具体阿里云用户 ID。当接收方类型为钉钉 token 时，接收方取值为具体钉钉 token 值。
ReceiverValue	string	接收方取值。当接收方类型为阿里云 ID 时，接收方取值为具体阿里云用户 ID。当接收方类型为钉钉 token 时，接收方取值为具体钉钉 token 值。	token1
InhibitionInterval	long	告警抑制间隔时长，单位分钟。	5

示例

正常返回示例

JSON格式

{
  "RequestId": "74C2FECD-5B3A-554A-BCF5-351A36DE9815",
  "PagingInfo": {
    "TotalCount": 90,
    "PageNumber": 1,
    "PageSize": 10,
    "DIJobAlarmRules": [
      {
        "DIAlarmRuleId": 72402,
        "DIJobId": 32594,
        "Description": "rule descrition",
        "MetricType": "Heartbeat",
        "Name": "rule_name",
        "Enabled": true,
        "TriggerConditions": [
          {
            "Severity": "Critical",
            "Duration": 1,
            "Threshold": 5,
            "DdlReportTags": [
              "ALTERADDCOLUMN"
            ]
          }
        ],
        "NotificationSettings": {
          "NotificationChannels": [
            {
              "Severity": "Critical",
              "Channels": [
                "Ding"
              ]
            }
          ],
          "NotificationReceivers": [
            {
              "ReceiverType": "DingToken",
              "ReceiverValues": [
                "token1"
              ]
            }
          ],
          "InhibitionInterval": 5
        }
      }
    ]
  }
}

错误码

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