文档首页/ 数据治理中心 DataArts Studio/ API参考/ 数据开发API（V2）/ 通知管理/ 批量创建通知规则 - BatchCreateAlarmRules
更新时间：2026-09-10 GMT+08:00
在线调试
CLI示例
查看PDF
分享

批量创建通知规则 - BatchCreateAlarmRules

功能介绍

批量创建通知规则。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，当前API调用无需身份策略权限。

URI

POST /v2/{project_id}/factory/alarm/rules

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方法请参见项目ID和账号ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

workspace

是

String

工作空间ID，获取方法请参见实例ID和工作空间ID。

X-Auth-Token

否

String

IAM Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值），使用Token认证时必选，最小长度：0，最大长度：4096。

X-Project-Id

否

String

project_id，项目编号。获取方法请参见项目ID和账号ID。

多project场景采用AK/SK认证的接口请求，则该字段必选。

Content-Type

是

String

默认值：application/json;charset=UTF-8

可选，有Body体的情况下必选，没有Body体则无需填写和校验。
表3 请求Body参数

参数

是否必选

参数类型

描述

alarm_rule_list

否

Array of AlarmRulesV2 objects

通知规则列表，单次请求最多500条。
表4 AlarmRulesV2

参数

是否必选

参数类型

描述

node_id

是

Long

作业ID。

notify_type

否

Integer

通知方式，0：消息；1：语音呼叫。默认为0。

remind_type

是

Integer

通知类型：

  • 0：运行成功。

  • 1：运行异常/失败。

  • 2：成功和失败。

  • 3：未完成。

  • 4：资源繁忙。

  • 13：运行取消。

  • 15：作业改动。

不支持12（周期未完成），如需创建周期未完成规则请使用V1接口。

setting_time

否

String

完成时间阈值。remind_type为3（未完成）时填写。

topic_name

否

String

SMN主题名称。notify_method为SUBJECT时填写。

topic_urn

否

String

SMN主题URN。notify_method为SUBJECT时填写。

node_type

是

String

节点类型，固定值1。

exceed_duration

否

Long

超时时长，单位分钟。remind_type为3（未完成）时填写。

display_number

否

String

主叫号码。notify_type为1（语音呼叫）时填写。

callee_number

否

String

被叫号码。notify_type为1（语音呼叫）时填写。

use_flag

是

Integer

是否启用，0：禁用；1：启用。

rule_name

否

String

规则名称。

notify_method

否

String

告警方式：

  • SUBJECT：主题

  • OWNER：责任人

  • DUTY_SCHEDULE：值班表

  • DINGDING：钉钉机器人

默认为SUBJECT。

protocol

否

String

告警协议，示例：["email","sms","callnotify"]。email：邮件，sms：短信，callnotify：语音。

other_persons

否

String

抄送人。

max_send_times

否

Integer

最大告警次数，取值范围[1, 50]。

不填写时默认为1（单次告警）。如需持续告警，请使用enable_persistent_alarm=true，不要直接传9999。

enable_persistent_alarm

否

Boolean

是否开启持续告警。开启后告警将持续发送，直到作业恢复。

开启后系统自动将max_send_times设置为9999（内部值），无需填写max_send_times。不允许直接传max_send_times=9999。

send_interval

否

Integer

告警间隔，取值范围[5, 60]，单位：分钟。

duty_schedule_id

否

Long

值班表ID。notify_method为DUTY_SCHEDULE时填写。

smn_config_id

否

String

SMN配置ID。notify_method为DINGDING时填写。

enable_recovery

否

Boolean

是否开启恢复通知。开启后，当作业失败后重跑成功时发送恢复通知。

仅对remind_type=1（运行异常）的规则生效，其他类型不创建恢复子规则。删除主规则时会自动级联删除恢复子规则。

响应参数

状态码：200

无

状态码：400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

批量创建通知规则，支持持续告警和恢复通知。

POST /v2/62099355b894428e8916573ae635f1f9/factory/alarm/rules

{
  "alarm_rule_list" : [ {
    "node_id" : 935258,
    "notify_type" : 0,
    "remind_type" : 1,
    "node_type" : "1",
    "use_flag" : 1,
    "notify_method" : "SUBJECT",
    "topic_name" : "HEHAO",
    "topic_urn" : "urn:smn:cn-north-7:62099355b894428e8916573ae635f1f9:HEHAO",
    "max_send_times" : 5,
    "send_interval" : 10,
    "enable_persistent_alarm" : false,
    "enable_recovery" : true
  } ]
}

响应示例

状态码：200

无

状态码：400

{
  "error_code" : "DLF.5013",
  "error_msg" : "The request param is invalid."
}

状态码

状态码

描述

200

成功，无返回信息。

400

失败，返回的错误信息。
父主题： 通知管理

相关文档