Help Center/ Cloud Eye/ API Reference/ API v2/ Resources in an Alarm Rule/ Batch Adding Resources to an Alarm Rule
Updated on 2024-05-16 GMT+08:00
View PDF
Share

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

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

Request Parameters

Table 2 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
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

resources

Yes

Array<Array<Dimension>>

Specifies the resource information.

Array Length: 0 - 1000
Table 4 Dimension

Parameter

Mandatory

Type

Description

name

Yes

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

No

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

Response Parameters

Status code: 400

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

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

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

Failed to verify parameters.

404

Resource not found.

500

Internal system error.

Error Codes

See Error Codes.