Querying an Alarm Notification Topic
Function
This API is used to query alarm notification topics. The default topic, number of confirmed topics, and list are returned.
URI
GET /v1/{project_id}/sdg/smn/topics
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Project ID |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
offset |
No |
Integer |
Page number |
|
limit |
No |
Integer |
Page limit |
Request Parameters
None
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
id |
String |
SMN topic ID |
|
default_topic_urn |
String |
Unique resource identifier of the default SMN topic |
|
topic_count |
Integer |
Number of confirmed SMN topics |
|
topics |
Array of TopicBean objects |
List of confirmed SMN topics |
|
Parameter |
Type |
Description |
|---|---|---|
|
name |
String |
SMN topic name |
|
topic_urn |
String |
Unique resource identifier of an SMN topic |
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error Code |
|
error_msg |
String |
Error Message |
Example Requests
Query an alarm notification topic.
GET /v1/{project_id}/sdg/smn/topics
Example Responses
Status code: 200
Request sent
{
"id" : "xxxxxx",
"default_topic_urn" : "xxxxxx",
"topic_count" : 1,
"topics" : [ {
"name" : "xxxxxx",
"topic_urn" : "xxxxxx"
} ]
}
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.
