Help Center/ Cloud Eye/ API Reference/ API V2/ Alarm Resources/ Querying Resources in an Alarm Rule
Updated on 2025-10-30 GMT+08:00
View PDF
Share

Querying Resources in an Alarm Rule

Function

This API is used to query resources in an alarm rule by alarm rule ID.

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:alarms:getResources

    Read

    alarm *

    • g:ResourceTag/<tag-key>

    • g:EnterpriseProjectId
    • ces:alarms:list

    -

URI

GET /v2/{project_id}/alarms/{alarm_id}/resources

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

alarm_id

Yes

String

Definition

Alarm rule ID.

Constraints

N/A

Range

The value starts with al and is followed by 22 characters of letters, digits, or a combination of both.

Default Value

N/A
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

Description

Pagination offset.

Constraints

N/A

Range

0 to 10000

Default Value

0

limit

No

Integer

Description

Number of records displayed on each page.

Constraints

N/A

Range

1 to 100

Default Value

10

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

No

String

Definition

MIME type of the request body.

Constraints:

None

Value range:

The value can contain 1 to 64 characters.

Default value:

The default type is application/json; charset=UTF-8.

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

resources

Array<Array<DimensionResp>>

Definition

Resource information.

count

Integer

Definition

Total number of resources.

Range

[0,2147483647]
Table 5 DimensionResp

Parameter

Type

Description

name

String

Definition

Dimension of the resource. For example, the dimension of an ECS is instance_id. For details about the metric dimension name of each service resource, see Service Dimension Names.

Range

The value must start with a letter and can only contain letters, digits, underscores (_), and hyphens (-).

value

String

Definition

Resource dimension value, which is an instance ID, for example, 4270ff17-aba3-4138-89fa-820594c39755.

Range

1 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: 500

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.

Example Requests

Querying resources monitored by an alarm rule whose alarm_id is alCzk8o9dtSQHtiDgb44Eepw and limit is 10.

/v2/{project_id}/alarms/alCzk8o9dtSQHtiDgb44Eepw/resources?offset=0&limit=10

Example Responses

Status code: 200

Query succeeded.

{
  "resources" : [ [ {
    "name" : "disk_name"
  } ] ],
  "count" : 10
}

Status Codes

Status Code

Description

200

Query succeeded.

400

Parameter verification failed.

500

Internal system error.

Error Codes

See Error Codes.

Parent topic: Alarm Resources