Querying Alarm Rules Associated with an Alarm Template

This API is used to query alarm rules associated with the alarm template.

GET /v2/{project_id}/alarm-templates/{template_id}/association-alarms

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.
template_id	Yes	String	ID of an alarm template. The ID starts with at and is followed by up to 64 characters, including letters and digits.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Start position for pagination query, indicating the sequence number of the data record where the query starts. The default value is 0.
limit	No	Integer	Maximum number of query results. The value ranges from 1 to 100 (default).

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Tenant token.

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
alarms	Array of alarms objects	Alarm rule list.
count	Integer	Total number of alarm rules.

**Table 5** alarms
Parameter	Type	Description
alarm_id	String	Alarm rule ID.
name	String	Alarm rule name.
description	String	Description of the alarm rule.

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Status codes customized by each cloud service when a request error occurs.
error_msg	String	Request error message.
request_id	String	Request ID.

Status code: 401

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Status codes customized by each cloud service when a request error occurs.
error_msg	String	Request error message.
request_id	String	Request ID.

Status code: 403

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Status codes customized by each cloud service when a request error occurs.
error_msg	String	Request error message.
request_id	String	Request ID.

Status code: 500

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Status codes customized by each cloud service when a request error occurs.
error_msg	String	Request error message.
request_id	String	Request ID.

Query alarm rules associated with an alarm template.

/v2/{project_id}/alarm-templates/{template_id}/association-alarms

Status code: 200

{
  "alarms" : [ {
    "alarm_id" : "al12345678901234567890",
    "name" : "test",
    "description" : "Alarm rule list."
  } ],
  "count" : 100
}

Status Code	Description
200	OK
400	Parameter verification failed.
401	Not authenticated.
403	Authentication failed.
500	Internal system error.

Parent topic: Alarm Rules Associated with an Alarm Template

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

The system is busy. Please try again later.