通过ListDIAlarmRules查询数据集成同步任务的告警规则-大数据开发治理平台 DataWorks-阿里云-大数据开发治理平台 DataWorks(DataWorks)-阿里云帮助中心

查看数据集成报警规则。

接口说明

需要购买 DataWorks 基础版及以上版本才能使用。

调试

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

调试

授权信息

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

请求参数

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

返回参数

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

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

更多信息，参考变更详情。