Help Center/ Cloud Eye/ API Reference/ API V2/ Alarm Resources/ Querying Resources in an Alarm Rule
Updated on 2025-08-27 GMT+08:00
Online Debugging
CLI Examples
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.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Tenant ID.

Constraints:

None

Value range:

Project ID, 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 by calling an API or on the console. For details, see Obtaining a Project ID. The value must contain of 1 to 64 characters.

Default value:

None

alarm_id

Yes

String

Alarm rule ID.

Regex Pattern: al([a-z]|[A-Z]|[0-9]){22}$
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

Pagination offset.

Value range:

0-10000

Default value:

0

Regex Pattern: ^([0]|[1-9]|[1-9][0-9]|[1-9][0-9][0-9]|[1-9][0-9][0-9][0-9]|10000)$

limit

No

Integer

Number of records on each page.

Value range:

1-100

Default value:

10

Regex Pattern: ^([1-9]|[1-9][0-9]|100)$

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

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.

Default value:

application/json; charset=UTF-8

X-Auth-Token

Yes

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

Resource information.

count

Integer

Total number of resources.

Value range:

0-2147483647
Table 5 Dimension

Parameter

Type

Description

name

String

Dimension of a resource. For example, the dimension of an ECS can be instance_id. A maximum of four dimensions are supported. For the metric dimension of each resource, see Service metric dimension.

Regex Pattern: ^([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_|-)*$

value

String

Value of a resource dimension, which is the resource ID, for example, 4270ff17-aba3-4138-89fa-820594c39755.

Regex Pattern: ^((([a-z]|[A-Z]|[0-9]|\*|_|/|#|\(|\)){1}([a-z]|[A-Z]|[0-9]|_|-|\.|\*|/|#|\(|\))*))$

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