Batch Enabling or Disabling Alarm Policies in Alarm Rules for One Service with One-Click Monitoring Enabled

Function

This API is used to batch enable or disable alarm policies in alarm rules for one service with one-click monitoring enabled.

URI

PUT /v2/{project_id}/one-click-alarms/{one_click_alarm_id}/alarms/{alarm_id}/policies/action

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

For details about how to obtain the project ID, see Obtaining a Project ID.

Minimum: 1

Maximum: 64

Regular expression matching: ^[a-zA-Z0-9-]{1,64}$

one_click_alarm_id

Yes

String

One-click monitoring ID.

Minimum: 1

Maximum: 64

Regular expression matching: ^([a-z]|[A-Z]|[0-9]){1,64}$

alarm_id

Yes

String

Alarm rule ID.

Minimum: 24

Maximum: 24

Regular expression matching: ^al([0-9A-Za-z]){22}$

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

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

Default: application/json; charset=UTF-8

Minimum: 1

Maximum: 64

X-Auth-Token

Yes

String

User token. It is a response to the API for obtaining a user token. This API is the only one that does not require authentication. After a response is returned, the value of X-Subject-Token in the response header is the token.

Minimum: 1

Maximum: 16384

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

alarm_policy_ids

Yes

Array of strings

IDs of alarm policies to be enabled or disabled in batches in an alarm rule.

Array length: 1 to 100

Regular expression matching: ^([a-z]|[A-Z]|[0-9]|-)+$

enabled

Yes

Boolean

Whether to enable the function. The value can be true (enable) or false (disable).

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

alarm_policy_ids

Array of strings

IDs of alarm policies that were enabled or disabled in batches in an alarm rule.

Array length: 1 to 100

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Status code customized by each cloud service when a request error occurs.

Minimum: 0

Maximum: 256

error_msg

String

Request error message.

Minimum: 0

Maximum: 256

request_id

String

Request ID.

Minimum: 0

Maximum: 256

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Status code customized by each cloud service when a request error occurs.

Minimum: 0

Maximum: 256

error_msg

String

Request error message.

Minimum: 0

Maximum: 256

request_id

String

Request ID.

Minimum: 0

Maximum: 256

Status code: 403

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Status code customized by each cloud service when a request error occurs.

Minimum: 0

Maximum: 256

error_msg

String

Request error message.

Minimum: 0

Maximum: 256

request_id

String

Request ID.

Minimum: 0

Maximum: 256

Status code: 404

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Status code customized by each cloud service when a request error occurs.

Minimum: 0

Maximum: 256

error_msg

String

Request error message.

Minimum: 0

Maximum: 256

request_id

String

Request ID.

Minimum: 0

Maximum: 256

Status code: 500

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Status code customized by each cloud service when a request error occurs.

Minimum: 0

Maximum: 256

error_msg

String

Request error message.

Minimum: 0

Maximum: 256

request_id

String

Request ID.

Minimum: 0

Maximum: 256

Example Requests

Batch enable or disable alarm policies in alarm rules for one service that has one-click monitoring enabled.

POST /v2/{project_id}/one-click-alarms/{one_click_alarm_id}/alarms/{alarm_id}/policies/action

Request body:

{
  "alarm_policy_ids" : [ "alxdxxxdsw12321321" ],
  "enabled" : true
}

Example Responses

Status code: 200

Alarm policies enabled or disabled.

{
  "alarm_policy_ids" : [ "alxdxxxdsw12321321" ]
}

Status Codes

Status Code

Description

200

Alarm policies enabled or disabled.

400

Parameter verification failed.

401

Authentication failed.

403

Authentication failed.

404

Resources not found.

500

Failed to complete the request because of an internal server error.

Error Codes

See Error Codes.