ListDIAlarmRules - 查询数据集成新版任务告警规则列表 - 大数据开发治理平台 DataWorks

查询数据集成新版任务告警规则列表，当前支持的任务类型包括：MySQL到Hologres整库实时解决方案。

接口说明

当您的任务同步类型中包含实时同步时，支持设置告警规则。

调试

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

调试

授权信息

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

请求参数

名称	类型	必填	描述	示例值
DIJobId	long	是	任务 ID，是告警规则关联的任务 ID。	11260
PageNumber	long	否	页码，默认为 1。	1
PageSize	long	否	分页大小，默认为 10。	10

返回参数

名称	类型	描述	示例值
	object	响应。
RequestId	string	请求 ID。	74C2FECD-5B3A-554A-BCF5-351A36DE9815
DIAlarmRulePaging	object	告警规则分页结果。
TotalCount	long	总记录数。	2
PageNumber	long	页码。	1
PageSize	long	分页大小。	10
DIJobAlarmRules	array<object>	告警规则列表。
DIJobAlarmRule	object	告警规则。
DIAlarmRuleId	long	告警规则 ID。	41998
DIJobId	long	任务 ID，是告警规则关联的任务 ID。	11260
Description	string	描述。	mysql同步到hologres心跳告警
MetricType	string	告警指标类型，可选的枚举值： Heartbeat（任务状态报警） FailoverCount（failover 次数报警） Delay（任务延迟报警）	Heartbeat
Enabled	boolean	告警规则是否启用。	true
TriggerConditions	array<object>	告警触发条件列表，支持多条件。
TriggerCondition	object	告警触发条件。
Severity	string	严重程度，可选的枚举值： Warning Critical	Warning
Duration	long	告警计算时间区间，单位分钟。	15
Threshold	long	告警阈值。任务状态报警：无阈值。 failover 次数报警：阈值为 failover 次数。任务延迟报警：阈值为延迟时长，单位秒。	5
NotificationSettings	object	告警通知设置。
NotificationChannels	array<object>	告警通知渠道，支持多值。
NotificationChannel	object	告警通知渠道。
Severity	string	严重程度，可选的枚举值： Warning Critical	Warning
Channels	array	通道列表。
Channel	string	通道，可选的枚举值： Mail（邮件） Phone（电话） Sms（短信） Ding（钉钉）	Ding
NotificationReceivers	array<object>	告警通知接收方，支持多值。
NotificationReceiver	object	告警通知接收方。
ReceiverType	string	接收方类型。当告警通知渠道为邮件、电话、短信时，接收方类型为阿里云用户 ID。当告警通知渠道为钉钉时，接收方类型为钉钉 token。	DingToken
ReceiverValues	array	接收方取值列表。
ReceiverValue	string	接收方取值。当接收方类型为阿里云 ID 时，接收方取值为具体阿里云用户 ID。当接收方类型为钉钉 token 时，接收方取值为具体钉钉 token 值。	token1
InhibitionInterval	integer	告警抑制间隔时长，单位分钟。	5

示例

正常返回示例

JSON格式

{
  "RequestId": "74C2FECD-5B3A-554A-BCF5-351A36DE9815",
  "DIAlarmRulePaging": {
    "TotalCount": 2,
    "PageNumber": 1,
    "PageSize": 10,
    "DIJobAlarmRules": [
      {
        "DIAlarmRuleId": 41998,
        "DIJobId": 11260,
        "Description": "mysql同步到hologres心跳告警",
        "MetricType": "Heartbeat",
        "Enabled": true,
        "TriggerConditions": [
          {
            "Severity": "Warning",
            "Duration": 15,
            "Threshold": 5
          }
        ],
        "NotificationSettings": {
          "NotificationChannels": [
            {
              "Severity": "Warning",
              "Channels": [
                "Ding"
              ]
            }
          ],
          "NotificationReceivers": [
            {
              "ReceiverType": "DingToken",
              "ReceiverValues": [
                "token1"
              ]
            }
          ],
          "InhibitionInterval": 5
        }
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
403	Forbidden.Access	Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.	没有权限，请授权
429	Throttling.Api	The request for this resource has exceeded your available limit.	对该资源的请求已超过您的可用上限。
429	Throttling.System	The DataWorks system is busy. Try again later.	DataWorks系统繁忙，请稍后再试。
429	Throttling.User	Your request is too frequent. Try again later.	您的请求过于频繁，请尝试放缓请求速度。
500	InternalError.System	An internal system error occurred. Try again later.	系统内部错误，请稍后再试。
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.	系统内部错误，请稍后再试。

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史