文档首页/ 数据治理中心 DataArts Studio/ API参考/ 数据开发API(V2)/ 通知管理/ 批量删除通知规则 - BatchDeleteAlarmRules
更新时间:2026-09-10 GMT+08:00
分享

批量删除通知规则 - BatchDeleteAlarmRules

功能介绍

批量删除通知规则。

调用方法

请参见如何调用API

授权信息

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

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

URI

DELETE /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

错误描述。

请求示例

批量删除通知规则,根据node_id和remind_type匹配删除,同时级联删除关联的恢复通知子规则。

DELETE /v2/62099355b894428e8916573ae635f1f9/factory/alarm/rules

{
  "alarm_rule_list" : [ {
    "node_id" : 935258,
    "remind_type" : 1
  } ]
}

响应示例

状态码:200

状态码:400

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

状态码

状态码

描述

200

成功,无返回信息。

400

失败,返回的错误信息。

相关文档