Modifying an Alarm Notification Topic
Function
This API is used to modify general alarm notification settings, such as the associated project ID, notification topic, and notification status (0: notification disabled; 1: notification enabled).
URI
PUT /v1/{project_id}/sdg/smn/topic
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Project ID |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
id |
Yes |
String |
DSC alarm topic ID (Not Simple Message Notification topic ID) |
|
project_id |
No |
String |
Project ID |
|
status |
No |
Integer |
Alarm notification status |
|
topic_urn |
Yes |
String |
Unique resource identifier of an SMN topic |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
msg |
String |
Returned message |
|
status |
String |
Return status, for example, '200', '400'. |
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error Code |
|
error_msg |
String |
Error Message |
Example Requests
Change the notification topic to xxxxxxxxxxxxxxxxxxx, Project ID to xxxxxxxxxxxxxxxxxxx, and set the alarm notification status to Enabled.
PUT /v1/{project_id}/sdg/smn/topic
{
"id" : "xxxxxxxxxxxxxxxxxxx",
"project_id" : "xxxxxxxxxxxxxxxxxxx",
"status" : 1,
"topic_urn" : "xxxxxxxxxxxxxxxxxxx"
}
Example Responses
Status code: 200
Request sent
{
"msg" : "xxxx",
"status" : "RESPONSE_SUCCESS"
}
Status code: 400
Invalid request
{
"error_code" : "dsc.40000011",
"error_msg" : "Invalid parameter"
}
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
Request sent |
|
400 |
Invalid 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.
