
# 更新通知配置 - UpdateAlarmRule
#### 功能介绍
修改告警规则通知配置，用于更新作业监控告警的节点信息、通知类型、提醒类型、启用标志、通知次数、通知间隔和SMN主题名称等。
#### 调用方法
请参见[如何调用API](https://support.huaweicloud.com/api-dataartsstudio/making_request.html)。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dataartsstudio/abcd.html)。
- 如果使用身份策略授权，当前API调用无需身份策略权限。
 
#### URI
PUT /v2/{project_id}/factory/alarm/rules/{id}
表1路径参数 
| 参数         | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
|:---|:---|:---|:---|
| project_id | 是    | String | 项目ID，获取方法请参见[项目ID和账号ID](https://support.huaweicloud.com/api-dataartsstudio/projectid_accountid.html)。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| id         | 是    | String | **参数解释**： 告警规则ID，用于唯一标识一条告警规则，在更新通知配置场景中指定要修改的告警规则。可以通过调用"查询告警规则列表"接口获取。 **约束限制**： 只能包含字母、数字和连字符，长度为1-64个字符。 **取值范围**： 符合正则表达式\^\[a-zA-Z0-9-\]{1,64}$的字符串。 **默认取值**： 无。 |
   
#### 请求参数
表2请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                                                                           |
|:---|:---|:---|:---|
| X-Auth-Token | 否    | String | IAM Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值），使用Token认证时必选，最小长度：0，最大长度：4096。                     |
| workspace    | 是    | String | 工作空间ID，获取方法请参见[实例ID和工作空间ID](https://support.huaweicloud.com/api-dataartsstudio/dataartsstudio_02_0350.html)。 |
   
表3请求Body参数 
| 参数               | 是否必选 | 参数类型    | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|:---|:---|:---|:---|
| node_id          | 是    | Long    | **参数解释**： 节点ID，用于标识告警规则关联的节点。配置后告警将监控该节点的运行状态。 **约束限制**： 必填参数。 **取值范围**： 正整数。 **默认取值**： 无。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| node_name        | 是    | String  | **参数解释**： 节点名，用于标识告警规则关联的节点。配置后告警将监控该节点的运行状态。 **约束限制**： 必填参数。 **取值范围**： 无。 **默认取值**： 无。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| node_type        | 是    | String  | **参数解释**： 节点类型，指定告警规则关联的节点类型。固定值为1，表示作业节点。 **约束限制**： 只能取值1，必填参数。 **取值范围**： 1（作业节点）。 **默认取值**： 无。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| notify_type      | 否    | Integer | **参数解释**： 通知类型，指定告警通知的发送方式。配置后系统将按照该方式发送告警通知。 **约束限制**： 无。 **取值范围**： - 0：消息。   - 1：语音呼叫。    **默认取值**： 0。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| notify_method    | 否    | String  | **参数解释**： 告警方式。支持主题、责任人、值班表和钉钉机器人。 - SUBJECT：主题。   - OWNER：责任人。   - DUTY_SCHEDULE：值班表。   - DINGDING：钉钉机器人。   - SUBJECT：主题。   - OWNER：责任人。   - DUTY_SCHEDULE：值班表。   - DINGDING：钉钉机器人。    **约束限制**： 无。 **取值范围**： **默认取值**： 无。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| remind_type      | 是    | Integer | **参数解释**： 提醒类型，指定告警提醒的方式。配置后系统将按照该方式在告警触发时发送提醒。 **约束限制**： 必填参数。 **取值范围**： - 0：运行成功。   - 1：运行异常/失败。   - 2：成功和失败。   - 3：未完成。   - 4：资源繁忙。   - 13：运行取消。   - 15：作业改动。   - 16：YARN超时杀死。   - 17：作业未启动。   - 18：运行时长超过平均值值。    **默认取值**： 无。 |
| use_flag         | 是    | Integer | **参数解释**： 启用标志，指定告警规则是否启用。配置为0表示禁用告警规则，配置为1表示启用告警规则。 **约束限制**： 必填参数。 **取值范围**： 0（禁用）或1（启用）。 **默认取值**： 无。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| 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时填写。 **约束限制**： 无。 **取值范围**： 字符串。 **默认取值**： 无。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
   
#### 响应参数
**状态码：200**
更新成功。
**状态码：400**
表4响应Body参数 
| 参数         | 参数类型   | 描述    |
|:---|:---|:---|
| error_code | String | 错误码。  |
| error_msg  | String | 错误描述。 |
   
#### 请求示例
更新通知规则，支持持续告警和恢复通知。
```
POST /v2/62099355b894428e8916573ae635f1f9/factory/alarm/rules/123123
{
  "node_id" : 935258,
  "node_name" : "job_1",
  "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
}
```
#### 响应示例
**状态码：400**
BadRequest
```
{
  "error_code" : "DLF.3051",
  "error_msg" : "The request parameter is invalid."
}
```
#### 状态码
| 状态码 | 描述         |
|:---|:---|
| 200 | 更新成功。      |
| 400 | BadRequest |
   
