Querying Alarm Rules Associated with an Alarm Template

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

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

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

ces:customAlarmTemplates:listAssociatedAlarms

List

-

g:EnterpriseProjectId

-

-

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
ces:customAlarmTemplates:listAssociatedAlarms	List	-	g:EnterpriseProjectId	-	-

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID. It is used to specify the project that an asset belongs to. You can query the assets of a project by project ID. You can obtain the project ID from the API or console. For details, see Obtaining a Project ID. Constraints N/A Range 1 to 64 characters. Default Value N/A
template_id	Yes	String	Definition Alarm template ID. Constraints N/A Range The value starts with at and can contain letters and digits. It can contain 2 to 64 characters. Default Value N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Definition Pagination offset. Constraints N/A Range An integer ranging from 0 to 10,000. Default Value 0
limit	No	Integer	Definition Number of records displayed on each page. Constraints N/A Range An integer ranging from 1 to 100. Default Value 100

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	String	Definition User token. Constraints: None Value range: The value can contain 1 to 16,384 characters. Default value: None

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
alarms	Array of alarms objects	Alarm rule list.
count	Integer	Definition Total number of alarm rules. Range 0 to 1,000.

**Table 5** alarms
Parameter	Type	Description
alarm_id	String	Definition Alarm template ID. Range The value starts with al and is followed by 22 characters of letters, digits, or a combination of both. It contains 24 characters.
name	String	Definition Alarm rule name. Range The value allows 1 to 128 characters. It can only contain letters, digits, hyphens (-), and underscores (_).
description	String	Definition Alarm rule description. Range 0 to 256 characters.

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.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.