Help Center/Cloud Eye/API Reference/API V2/Alarm Templates/Querying Alarm Templates
Updated on 2025-12-02 GMT+08:00
View PDF

Querying Alarm Templates

Function

This API is used to query the alarm template list.

URI

GET /v2/{project_id}/alarm-templates

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

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).

namespace

No

String

Namespace of a service. For details about the namespace of each service, see Namespace.

dim_name

No

String

Resource dimension, which must start with a letter. A dimension allows a maximum of 32 characters and can only contain digits, letters, underscores (_), and hyphens (-). Multiple dimensions are separated by commas (,).

template_type

No

String

Alarm template type. system indicates default alarm templates for metrics, custom indicates the custom alarm templates for metrics, system_event indicates default event templates, custom_event indicates the custom event templates, and system_custom_event indicates all default and custom event templates. If this parameter is not specified, 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

(Deprecated) Alarm templates can be queried by product name. Generally, the product name format is Service namespace,First-level dimension of the service, for example, SYS.ECS,instance_id.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Tenant token.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

alarm_templates

Array of AlarmTemplates objects

Alarm template list.

count

Integer

Total number of alarm templates.

Table 5 AlarmTemplates

Parameter

Type

Description

template_id

String

ID of an alarm template. The ID starts with at and is followed by up to 64 characters, including letters and digits.

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

Time when an alarm template was created.

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

OK

{
  "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
}

Status Codes

Status Code

Description

200

OK

400

Parameter verification failed.

401

Not authenticated.

403

Authentication failed.

500

Internal system error.

Error Codes

See Error Codes.

Parent topic:Alarm Templates