使用ListDIAlarmRules获取数据集成任务的告警规则列表-大数据开发治理平台 DataWorks-阿里云-大数据开发治理平台 DataWorks(DataWorks)-阿里云帮助中心

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

接口说明

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

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dataworks:*

list

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
DIJobId	integer	是	任务 ID，是告警规则关联的任务 ID。可通过 ListDIJobs 响应中的 DIJobPaging.DIJobs[].DIJobId 获取。	11260
PageNumber	integer	否	页码，默认为 1。	1
PageSize	integer	否	分页大小，默认为 10。	10

返回参数

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

示例

正常返回示例

JSON格式

{
  "RequestId": "74C2FECD-5B3A-554A-BCF5-35****",
  "DIAlarmRulePaging": {
    "TotalCount": 2,
    "PageNumber": 1,
    "PageSize": 10,
    "DIJobAlarmRules": [
      {
        "DIAlarmRuleId": 41998,
        "DIJobId": 11260,
        "Description": "mysql synchronizes to hologres heartbeat alert",
        "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	错误码	错误信息	描述
500	InternalError.System	An internal system error occurred. Try again later.
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.
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.
429	Throttling.User	Your request is too frequent. Try again later.

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

变更历史

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