Querying Alarm Templates

Function

This API is used to query the alarm template list.

Debugging

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

Authorization Information

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:list

List

-

g:EnterpriseProjectId

-

-

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

URI

GET /v2/{project_id}/alarm-templates

**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

**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
namespace	No	String	Definition Namespace of the service. For details, see Services Interconnected with Cloud Eye. Constraints N/A Range The value is in the service.item format. The values of service and item must start with a letter and contain only letters, digits, and underscores (_). It can contain 3 to 32 characters. Default Value N/A
dim_name	No	String	Definition Resource dimension name. Constraints N/A Range A dimension allows up to 32 characters and can contain only letters, digits, and these characters: _-#/(). Use commas (,) to separate multiple dimensions. The value can contain 1 to 131 characters. Default Value N/A
template_type	No	String	Definition Template type. Constraints N/A Range The value can be: system: default metric template. custom: custom metric template. system_event: default event template. custom_event: custom event template. system_custom_event: all event templates. Default Value If this parameter is not transferred, all metric templates are returned.
template_name	No	String	Name of an alarm template. The name must start with a letter and can contain 1 to 128 characters, including letters, digits, underscores (_), and hyphens (-). Fuzzy match is supported.
product_name	No	String	Definition Product name. It needs to be specified when product alarm rules with multiple dimensions are created. Generally, the value format is Service namespace,First-level dimension of the service, for example, SYS.ECS,instance_id. Constraints N/A Range 0 to 128 characters. Default Value N/A

Request Parameters

**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

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
alarm_templates	Array of AlarmTemplates objects	Alarm template list.
count	Integer	Definition Total number of alarm templates. Range 10 to 9,999,999 characters.

**Table 5** AlarmTemplates
Parameter	Type	Description
template_id	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
template_name	String	Definition Alarm template name. Constraints N/A Range The value allows 1 to 128 characters. It must start with a letter and can only contain letters, digits, underscores (_), and hyphens (-). Default Value N/A
template_type	String	Type of an alarm template. custom indicates custom alarm templates, and system indicates default alarm templates.
create_time	String	Definition Time when an alarm template was created. Range N/A
template_description	String	Definition Alarm template description. Constraints N/A Range [0,256] Default Value An empty string

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.

Example Requests

Querying alarm templates.

/v2/{project_id}/alarm-templates?offset=0&limit=100

Example Responses

Status code: 200

{
  "alarm_templates" : [ {
    "template_id" : "at1628592157541dB1klWgY6",
    "template_name" : "my_template",
    "template_type" : "custom",
    "create_time" : "2006-01-02T15:04:05.000Z",
    "template_description" : "hello world"
  } ],
  "count" : 100
}