Querying an Alarm Notification Topic

Updated on 2024-03-29 GMT+08:00

View PDF

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Page number
limit	No	Integer	Page limit

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
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

**Table 4** TopicBean
Parameter	Type	Description
name	String	SMN topic name
topic_urn	String	Unique resource identifier of an SMN topic

Status code: 400

**Table 5** Response body parameters
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.

Parent topic: Alarm Notifications

Previous topic: Alarm Notifications

Next topic: Modifying an Alarm Notification Topic

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel