Help Center/ Cloud Eye/ API Reference/ API V2/ Alarm Resources/ Batch Adding Resources to an Alarm Rule
Updated on 2025-08-27 GMT+08:00

Batch Adding Resources to an Alarm Rule

Function

This API is used to batch add resources to an alarm rule. This API does not support alarm rules whose AlarmType is RESOURCE_GROUP. To modify resources in such alarm rules, use the resource group management APIs.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

POST /v2/{project_id}/alarms/{alarm_id}/resources/batch-create

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}$

Request Parameters

Table 2 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.

Default value:

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

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

resources

Yes

Array<Array<Dimension>>

Resource information.

Table 4 Dimension

Parameter

Mandatory

Type

Description

name

Yes

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

No

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]|_|-|\.|\*|/|#|\(|\))*))$

Response Parameters

Status code: 200

Resources added.

Status code: 400

Table 5 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: 404

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

Batch adding resources to an alarm rule.

{
  "resources" : [ [ {
    "name" : "rds_cluster_id",
    "value" : "rds000000000001"
  } ] ]
}

Example Responses

None

Status Codes

Status Code

Description

200

Resources added.

400

Parameter verification failed.

404

Resource not found.

500

Internal system error.

Error Codes

See Error Codes.