Modifying an Alarm Subscription
Function
This API is used to modify an alarm subscription.
Calling Method
For details, see Calling APIs.
URI
PUT /v2/{project_id}/alarm-subs/{alarm_sub_id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Definition Project ID. To obtain the value, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A |
alarm_sub_id |
Yes |
String |
Definition Alarm subscription ID. Constraints N/A Range N/A Default Value N/A |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
name |
Yes |
String |
Definition Subscribed alarm name. Range N/A |
enable |
No |
Integer |
Definition Whether to enable subscription. Range N/A |
alarm_level |
No |
String |
Definition Alarm severity. Range N/A |
notification_target |
Yes |
String |
Definition Message topic address. Range N/A |
notification_target_name |
Yes |
String |
Definition Message topic name. Range N/A |
notification_target_type |
Yes |
String |
Definition Message topic type. Only SMN is supported. Range N/A |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
id |
String |
Definition Alarm subscription ID. Range N/A |
name |
String |
Definition Subscribed alarm name. Range N/A |
enable |
Integer |
Definition Whether to enable subscription. Range N/A |
alarm_level |
String |
Definition Alarm severity. Range N/A |
project_id |
String |
Definition Project ID. Range N/A |
name_space |
String |
Definition Service to which the alarm belongs. Range N/A |
notification_target |
String |
Definition Message topic address. Range N/A |
notification_target_name |
String |
Definition Message topic name. Range N/A |
notification_target_type |
String |
Definition Message topic type. Range N/A |
language |
String |
Definition Language. Range N/A |
time_zone |
String |
Definition Time zone. Range N/A |
Example Requests
Modify the zrf-test-13 alarm subscription. Change the alarm severity to critical,major,minor, the SMN topic name to dws-test-nodelete, and the address to urn:smn:cn-north-7:4cf650fd46704908aa071b4df2453e1e:dws-test-nodelete.
https://{Endpoint}/v2/4cf650fd46704908aa071b4df2453e1e/alarm-subs/273ce506-dad8-411c-92f9-be5004739b40 { "alarm_level" : "urgent,important,minor", "enable" : 1, "name" : "zrf-test-13", "notification_target" : "urn:smn:cn-north-7:4cf650fd46704908aa071b4df2453e1e:dws-test-nodelete", "notification_target_name" : "dws-test-nodelete", "notification_target_type" : "SMN" }
Example Responses
Status code: 200
Alarm subscription modified.
{ "id" : "273ce506-dad8-411c-92f9-be5004739b40", "name" : "zrf-test-13", "enable" : 1, "language" : "zh-cn", "alarm_level" : "urgent,important,minor", "project_id" : "4cf650fd46704908aa071b4df2453e1e", "name_space" : "dws", "notification_target" : "urn:smn:cn-north-7:4cf650fd46704908aa071b4df2453e1e:dws-test-nodelete", "notification_target_name" : "dws-test-nodelete", "notification_target_type" : "SMN", "time_zone" : "GMT+08:00" }
Status Codes
Status Code |
Description |
---|---|
200 |
Alarm subscription modified. |
400 |
Request error. |
401 |
Authentication failed. |
403 |
You do not have required permissions. |
404 |
No resources found. |
500 |
Internal server error. |
503 |
Service unavailable. |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot