Querying Alarm Rules Associated with an Alarm Template

Function

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

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

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

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

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

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Specifies the tenant token. Minimum: 1 Maximum: 16384

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
alarms	Array of alarms objects	Specifies the alarm rule list. Array Length: 0 - 100
count	Integer	Specifies the total number of alarm rules. Minimum: 0 Maximum: 1000

**Table 5** alarms
Parameter	Type	Description
alarm_id	String	Specifies the alarm rule ID. Regex Pattern: ^al([0-9A-Za-z]){22}$
name	String	Specifies the alarm rule name. Minimum: 1 Maximum: 128 Regex Pattern: ^([\u4E00-\u9FFF]\|[a-z]\|[A-Z]\|[0-9]\|_\|-)+$
description	String	Provides supplementary information about an alarm rule. Minimum: 0 Maximum: 256

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Specifies the status codes customized by each cloud service when a request error occurs. Minimum: 0 Maximum: 256
error_msg	String	Specifies the request error message. Minimum: 0 Maximum: 256
request_id	String	Specifies the request ID. Minimum: 0 Maximum: 256

Status code: 401

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Specifies the status codes customized by each cloud service when a request error occurs. Minimum: 0 Maximum: 256
error_msg	String	Specifies the request error message. Minimum: 0 Maximum: 256
request_id	String	Specifies the request ID. Minimum: 0 Maximum: 256

Status code: 403

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Specifies the status codes customized by each cloud service when a request error occurs. Minimum: 0 Maximum: 256
error_msg	String	Specifies the request error message. Minimum: 0 Maximum: 256
request_id	String	Specifies the request ID. Minimum: 0 Maximum: 256

Status code: 500

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Specifies the status codes customized by each cloud service when a request error occurs. Minimum: 0 Maximum: 256
error_msg	String	Specifies the request error message. Minimum: 0 Maximum: 256
request_id	String	Specifies the request ID. Minimum: 0 Maximum: 256

Example Requests

Querying alarm rules associated with an alarm template

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

Example Responses

Status code: 200

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