Help Center/ Cloud Eye/ API Reference/ API V2/ Alarm Rules Associated with an Alarm Template/ Querying Alarm Rules Associated with an Alarm Template
Updated on 2025-10-30 GMT+08:00
View PDF
Share

Querying Alarm Rules Associated with an Alarm Template

Function

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

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

    List

    -

    g:EnterpriseProjectId

    -

    -

URI

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

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

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.

Example Requests

Query alarm rules associated with an alarm template.

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

Example Responses

Status code: 200

OK

{
  "alarms" : [ {
    "alarm_id" : "al12345678901234567890",
    "name" : "test",
    "description" : "Alarm rule list."
  } ],
  "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.