修改告警行动规则
功能介绍
修改告警行动规则。
调用方法
请参见如何调用API。
URI
PUT /v2/{project_id}/alert/action-rules
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,可以从控制台获取,也可以从调用API处获取。获取方式请参见:获取项目ID。 最小长度:32 最大长度:32 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
从IAM服务获取的用户Token。获取方式请参见:获取Token。 最小长度:1 最大长度:40960 |
Content-Type |
是 |
String |
消息体的类型(格式)。指定类型为“application/json”。 枚举值:
|
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
rule_name |
是 |
String |
告警行动规则名称。只含有中文,数字、字母、下划线,不能以下划线等特殊符号开头和结尾,长度范围为 1到100个字符。 最小长度:1 最大长度:100 |
project_id |
是 |
String |
项目ID 最小长度:32 最大长度:32 |
user_name |
是 |
String |
子账号名称 最小长度:1 最大长度:100 |
desc |
否 |
String |
规则描述。长度范围为0到1024个字符,并且只能是数字、字母、特殊字符(_*)、空格和中文组成,不能以下划线开头和结尾。 最小长度:0 最大长度:1024 |
type |
是 |
String |
规则类型:
最小长度:1 最大长度:1 枚举值:
|
notification_template |
是 |
String |
消息模板 最小长度:1 最大长度:100 |
create_time |
否 |
Long |
创建时间 最小值:0 最大值:9999999999999 |
update_time |
否 |
Long |
修改时间 最小值:0 最大值:9999999999999 |
time_zone |
否 |
String |
时区 最小长度:1 最大长度:100 |
smn_topics |
是 |
Array of SmnTopics objects |
SMN主题信息,不能大于5 数组长度:1 - 5 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
display_name |
否 |
String |
Topic的显示名,推送邮件消息时,作为邮件发件人显示。显示名的长度为192byte或64个中文。默认值为空。 最小长度:1 最大长度:64 |
name |
是 |
String |
创建topic的名字。Topic名称只能包含大写字母、小写字母、数字、-和_,且必须由大写字母、小写字母或数字开头,长度为1到255个字符。 最小长度:1 最大长度:255 |
push_policy |
是 |
Integer |
SMN消息推送策略。取值为0或1 最小值:0 最大值:1 |
status |
否 |
Integer |
topic中订阅者的状态。
枚举值:
|
topic_urn |
是 |
String |
Topic的唯一的资源标识。 最小长度:1 最大长度:100 |
响应参数
状态码:204
No Content 表示请求成功,但没有内容返回。
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
响应码。 最小长度:13 最大长度:13 |
error_msg |
String |
响应信息描述。 最小长度:1 最大长度:100 |
trace_id |
String |
响应id。 最小长度:12 最大长度:12 |
状态码:401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 最小长度:12 最大长度:12 |
error_msg |
String |
错误信息 最小长度:0 最大长度:1024 |
error_type |
String |
错误类型 最小长度:0 最大长度:128 |
trace_id |
String |
请求id 最小长度:32 最大长度:32 |
状态码:403
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 最小长度:12 最大长度:12 |
error_msg |
String |
错误信息 最小长度:0 最大长度:1024 |
error_type |
String |
错误类型 最小长度:0 最大长度:128 |
trace_id |
String |
请求id 最小长度:32 最大长度:32 |
状态码:500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
响应码。 最小长度:13 最大长度:13 |
error_msg |
String |
响应信息描述。 最小长度:1 最大长度:100 |
trace_id |
String |
响应id。 最小长度:12 最大长度:12 |
请求示例
修改用户id为"2xxxxxxxxxxxxxxxxxcf"的告警行动规则lhy_test01
https://{endpoint}/v2/{project_id}/alert/action-rules { "project_id" : "2xxxxxxxxxxxxxxxxxcf", "rule_name" : "222", "desc" : "222", "type" : "1", "smn_topics" : [ { "display_name" : "", "name" : "lhy_test01", "push_policy" : 0, "topic_urn" : "urn:smn:xxx:2xxxxxxxxxxxxxxxxxcf:lhy_test01" } ], "user_name" : "kxxxxxxxt", "notification_template" : "aom.built-in.template.zh", "time_zone" : "xxx", "create_time" : 1667316727451, "update_time" : 1667316727451 }
响应示例
状态码:400
BadRequest 非法请求。建议直接修改该请求,不要重试该请求。
{ "error_code" : "AOM.08019006", "error_msg" : "The action rule does not exist", "trace_id" : "" }
状态码:401
Unauthorized 在客户端提供认证信息后,返回该状态码,表明服务端指出客户端所提供的认证信息不正确或非法。
{ "error_code" : "AOM.0403", "error_msg" : "auth failed.", "error_type" : "AUTH_FAILED", "trace_id" : null }
状态码:403
Forbidden 请求被拒绝访问。返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。
{ "error_code" : "AOM.0403", "error_msg" : "auth failed.", "error_type" : "AUTH_FAILED", "trace_id" : null }
状态码:500
InternalServerError 表明服务端能被请求访问到,但是不能理解用户的请求。
{ "error_code" : "APM.00000500", "error_msg" : "Internal Server Error", "trace_id" : "" }
状态码
状态码 |
描述 |
---|---|
204 |
No Content 表示请求成功,但没有内容返回。 |
400 |
BadRequest 非法请求。建议直接修改该请求,不要重试该请求。 |
401 |
Unauthorized 在客户端提供认证信息后,返回该状态码,表明服务端指出客户端所提供的认证信息不正确或非法。 |
403 |
Forbidden 请求被拒绝访问。返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。 |
500 |
InternalServerError 表明服务端能被请求访问到,但是不能理解用户的请求。 |
错误码
请参见错误码。