Help Center/ Cloud Eye/ API Reference/ API v2/ Resources in an Alarm Rule/ Querying Resources in an Alarm Rule
Updated on 2024-05-16 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.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Specifies the tenant ID.

Minimum: 1

Maximum: 64

alarm_id

Yes

String

Specifies the alarm rule ID.

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

Parameter

Mandatory

Type

Description

offset

No

Integer

Specifies the pagination offset.

Minimum: 0

Maximum: 10000

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

Specifies the number of records that will be displayed on each page.

Minimum: 1

Maximum: 100

Default: 10

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

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

No

String

Specifies the MIME type of the request body. The default type is application/json; charset=UTF-8.

Default: application/json; charset=UTF-8

Minimum: 1

Maximum: 64

X-Auth-Token

No

String

Specifies the user token.

Minimum: 1

Maximum: 16384

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

resources

Array<Array<Dimension>>

Specifies the resource information.

Array Length: 0 - 1000

count

Integer

Specifies the total number of resources.

Minimum: 0

Maximum: 2147483647
Table 5 Dimension

Parameter

Type

Description

name

String

Specifies the dimension of a resource. For example, the dimension of an Elastic Cloud Server (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]|_|-){1,32}$

value

String

Specifies the 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]|_|-|\.)*)|\*){1,256}$

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Specifies the status codes customized by each cloud service when a request error occurs.

Minimum: 0

Maximum: 256

error_msg

String

Specifies the request error message.

Minimum: 0

Maximum: 256

request_id

String

Specifies the request ID.

Minimum: 0

Maximum: 256

Status code: 500

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Specifies the status codes customized by each cloud service when a request error occurs.

Minimum: 0

Maximum: 256

error_msg

String

Specifies the request error message.

Minimum: 0

Maximum: 256

request_id

String

Specifies the request ID.

Minimum: 0

Maximum: 256

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

Failed to verify parameters.

500

Internal system error.

Error Codes

See Error Codes.