Modifying an Alarm Action Rule
Function
This API is used to modify an alarm action rule.
Calling Method
For details, see Calling APIs.
URI
PUT /v2/{project_id}/alert/action-rules
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID, which can be obtained from the console or by calling an API. For details, see Obtaining a Project ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token obtained from IAM. For details, see Obtaining a Token. |
Content-Type |
Yes |
String |
Message body type or format. Content type, which is application/json. Enumeration values:
|
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
rule_name |
Yes |
String |
Alarm action rule name. Enter a maximum of 100 characters and do not start or end with a special character. Only letters, digits, and underscores (_) are allowed. |
project_id |
Yes |
String |
Project ID. |
user_name |
Yes |
String |
Member account name. |
desc |
No |
String |
Rule description. Enter a maximum of 1,024 characters and do not start or end with an underscore (). Only digits, letters, underscores (), asterisk (*), and spaces are allowed. |
type |
Yes |
String |
Rule types.
Enumeration values:
|
notification_template |
Yes |
String |
Message template. |
create_time |
No |
Long |
Creation time. |
update_time |
No |
Long |
Modification time |
time_zone |
No |
String |
Time zone. |
smn_topics |
Yes |
Array of SmnTopics objects |
SMN topic. The total number of topics cannot exceed 5. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
display_name |
No |
String |
Topic display name, which will be the name of an email sender. Max.: 192 bytes. This parameter is left blank by default. |
name |
Yes |
String |
Name of the topic. Enter 1 to 255 characters starting with a letter or digit. Only letters, digits, hyphens (-), and underscores (_) are allowed. |
push_policy |
Yes |
Integer |
SMN message push policy. Options: 0 and 1. |
status |
No |
Integer |
Status of the topic subscriber.
Enumeration values:
|
topic_urn |
Yes |
String |
Unique resource identifier of the topic. |
Response Parameters
Status code: 204
No Content: The request is successful, but no content is returned.
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Response code. |
error_msg |
String |
Response message. |
trace_id |
String |
Response ID. |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
error_type |
String |
Error type. |
trace_id |
String |
Request ID. |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
error_type |
String |
Error type. |
trace_id |
String |
Request ID. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Response code. |
error_msg |
String |
Response message. |
trace_id |
String |
Response ID. |
Example Requests
Modify the alarm action rule whose name is "lhy_test01" and user ID is "2xxxxxxxxxxxxxxxxxcf".
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 }
Example Responses
Status code: 204
No Content: The request is successful, but no content is returned.
No Content
Status code: 400
Bad Request: The request is invalid. The client should not repeat the request without modifications.
{ "error_code" : "AOM.08019006", "error_msg" : "The action rule does not exist", "trace_id" : "" }
Status code: 401
Unauthorized: The authentication information is incorrect or invalid.
{ "error_code" : "AOM.0403", "error_msg" : "auth failed.", "error_type" : "AUTH_FAILED", "trace_id" : null }
Status code: 403
Forbidden: The request is rejected. The server has received the request and understood it, but the server refuses to respond to it. The client should not repeat the request without modifications.
{ "error_code" : "AOM.0403", "error_msg" : "auth failed.", "error_type" : "AUTH_FAILED", "trace_id" : null }
Status code: 500
Internal Server Error
The server is able to receive the request but unable to understand the request.
{ "error_code" : "APM.00000500", "error_msg" : "Internal Server Error", "trace_id" : "" }
Status Codes
Status Code |
Description |
---|---|
204 |
No Content: The request is successful, but no content is returned. |
400 |
Bad Request: The request is invalid. The client should not repeat the request without modifications. |
401 |
Unauthorized: The authentication information is incorrect or invalid. |
403 |
Forbidden: The request is rejected. The server has received the request and understood it, but the server refuses to respond to it. The client should not repeat the request without modifications. |
500 |
Internal Server Error The server is able to receive the request but unable to understand the request. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.