更新通知配置 - UpdateAlarmRule

project_id

是

String

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

id

是

String

参数解释：

告警规则ID，用于唯一标识一条告警规则，在更新通知配置场景中指定要修改的告警规则。可以通过调用"查询告警规则列表"接口获取。

约束限制：

字符长度1-64。

取值范围：

数字、字母、中横线。

默认取值：

不涉及。

X-Auth-Token

否

String

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

workspace

是

String

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

node_id

是

Long

参数解释：

节点ID，用于标识告警规则关联的节点。配置后告警将监控该节点的运行状态。

约束限制：

必填参数。

取值范围：

按规则类型不同，取值不同。

• 作业规则：取值为作业id。

• 所有作业（通知类型非周期未完成）：固定取值-1。

• 目录规则或所有作业（通知类型是周期未完成）：固定取值-2。

默认取值：

不涉及。

node_name

否

String

参数解释：

节点名，用于标识告警规则关联的节点。配置后告警将监控该节点的运行状态。

约束限制：

最大128字符。

取值范围：

中文、英文、中横线、下划线和点号。

默认取值：

不涉及。

node_type

是

String

参数解释：

节点类型，指定告警规则关联的节点类型。固定值为1，表示作业节点。

约束限制：

只能取值1，必填参数。

取值范围：

1（作业节点）。

默认取值：

不涉及。

notify_type

否

Integer

参数解释：

提醒类型，指定告警提醒的发送方式。配置后系统将按照该方式发送告警通知。

约束限制：

无。

取值范围：

• 0：消息。

• 1：语音呼叫。

默认取值：

0。

remind_type

是

Integer

参数解释：

通知类型。配置后系统将按照该方式在告警触发时发送提醒。

约束限制：

必填参数。

取值范围：

• 0：运行成功。

• 1：运行异常/失败。

• 3：未完成。

• 4：资源繁忙。

• 12：周期未完成。

• 13：运行取消。

• 14：失败重跑作业成功。

• 15：作业改动。

• 16：yarn执行超时查杀。

• 17: 未启动。

• 18：超过7天平均时长。

默认取值：

不涉及。

use_flag

是

Integer

参数解释：

启用标志，指定告警规则是否启用。配置为0表示禁用告警规则，配置为1表示启用告警规则。

约束限制：

必填参数。

取值范围：

0（禁用）或1（启用）。

默认取值：

不涉及。

notify_method

否

String

参数解释：

告警方式。支持主题、责任人、值班表和钉钉机器人。

• SUBJECT：主题。

• OWNER：责任人。

• DUTY_SCHEDULE：值班表。

• DINGDING：钉钉机器人。

• SUBJECT：主题。

• OWNER：责任人。

• DUTY_SCHEDULE：值班表。

• DINGDING：钉钉机器人。

约束限制：

不涉及。

取值范围：

默认取值：

不涉及。

complete_time

否

String

参数解释：

作业完成时间阈值，未完成时触发告警。remind_type为3（未完成）时填写。

约束限制：

不涉及。

取值范围：

格式为HH:mm的时间字符串，例如10:00。

默认取值：

不涉及。

max_send_times

否

Integer

参数解释：

最大通知次数，指定告警通知的最大发送次数。配置后系统在告警触发时最多发送该次数的通知。

约束限制：

不涉及。

取值范围：

1-50整数。

默认取值：

不涉及。

send_interval

否

Integer

参数解释：

通知间隔，指定告警通知的发送间隔时间，单位为分钟。配置后系统将按照该间隔重复发送告警通知。

约束限制：

不涉及。

取值范围：

5-60整数。

默认取值：

不涉及。

topic_name

否

String

参数解释：

SMN主题名称，用于指定消息通知的主题。配置后告警通知将发送到该SMN主题。需要先在SMN服务中创建主题，可以通过SMN控制台或调用"查询SMN主题列表"接口获取。

约束限制：

只能以字母或数字开头，只能包含字母、数字、下划线和连字符，长度为1-256个字符。

取值范围：

符合正则表达式^[a-zA-Z\d][a-zA-Z\d-_]{0,255}$的字符串。

默认取值：

不涉及。

topic_urn

否

String

参数解释：

SMN主题URN，用于指定消息通知的主题URN。配置后告警通知将发送到该SMN主题。

约束限制：

不涉及。

取值范围：

符合SMN主题URN格式的字符串，格式为urn:smn:区域:项目ID:主题名称。

默认取值：

不涉及。

display_number

否

String

参数解释：

主叫号码，用于语音告警通知的主叫号码。notify_type为1（语音呼叫）时填写。

约束限制：

不涉及。

取值范围：

符合电话号码格式的字符串。

默认取值：

不涉及。

callee_number

否

String

参数解释：

被叫号码，用于语音告警通知的被叫号码。notify_type为1（语音呼叫）时填写。

约束限制：

不涉及。

取值范围：

符合电话号码格式的字符串。

默认取值：

不涉及。

other_persons

否

String

参数解释：

抄送其他人，指定告警通知的抄送人员列表。多个人员以英文逗号分隔。

约束限制：

不涉及。

取值范围：

以英文逗号分隔的用户名字符串。

默认取值：

不涉及。

duty_schedule_id

否

Long

参数解释：

值班表ID，指定告警通知关联的值班表。notify_method为DUTY_SCHEDULE时填写。

约束限制：

不涉及。

取值范围：

正整数。

默认取值：

不涉及。

smn_config_id

否

String

参数解释：

SMN配置ID，指定告警通知关联的SMN配置。notify_method为DINGDING时填写。

约束限制：

不涉及。

取值范围：

字符串。

默认取值：

不涉及。

rule_name

否

String

参数解释：

规则名称，使用目录规则时需填写。

约束限制：

最长64字符。

取值范围：

中文、英文、中横线、下划线和点号。

默认取值：

不涉及。

alarm_periods

否

Array of AlarmPeriod objects

参数解释：

通知周期配置，通知类型为周期未完成时需要配置。

job_directory

否

Array of DirectoryDTO objects

参数解释：

作业目录信息，使用目录规则时需填写。

node_id_list

否

Array of longs

参数解释：

作业id列表，通知类型为周期未完成时需要配置。

node_name_list

否

Array of strings

参数解释：

作业名称列表，通知类型为周期未完成时需要配置。

protocol

否

String

参数解释：

通知协议。

约束限制：

不涉及。

取值范围：

• email：邮件

• sms：短信

• calnotify：语音

• dingding：个人钉钉

默认取值：

不涉及。

subject_type

否

String

参数解释：

通知对象类型。

约束限制：

修改目录规则类型通知时必填。

取值范围：

• BATCH：批量添加作业

• DIRECTORY：作业目录

• ALL：所有作业

• DIRECTORY_RULE：目录规则

默认取值：

不涉及。

exceed_duration

否

Long

参数解释：

超时时长，单位毫秒。remind_type为18（超过7天平均时长）时填写。

约束限制：

不涉及。

取值范围：

正整数。

默认取值：

不涉及。

complete_time

否

String

任务完成时间。

period

否

Integer

周期。

directory_id

否

String

目录ID。

directory_name

否

String

目录名称。

error_code

String

错误码。

error_msg

String

错误描述。

200

更新成功。

400

BadRequest