Help Center/ Cloud Eye/ API Reference/ API v2/ One-Click Monitoring/ Batch Enabling or Disabling Alarm Policies in Alarm Rules for One Service That Has One-Click Monitoring Enabled

Updated on 2024-05-16 GMT+08:00

View PDF

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

Function

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

Debugging

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

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	Specifies the tenant ID. Minimum: 1 Maximum: 64 Regex Pattern: ^[a-zA-Z0-9-]{1,64}$
one_click_alarm_id	Yes	String	Specifies the one-click monitoring ID for a service. Minimum: 1 Maximum: 64
alarm_id	Yes	String	Specifies the alarm rule ID. Minimum: 24 Maximum: 24

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	Yes	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	Yes	String	Specifies the user token. Minimum: 1 Maximum: 16384

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
alarm_policy_ids	Yes	Array of strings	Specifies IDs of alarm policies to be enabled or disabled in batches in an alarm rule. Array Length: 1 - 100
enabled	Yes	Boolean	Specifies whether to enable one-click monitoring.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
alarm_policy_ids	Array of strings	Specifies IDs of alarm policies that were enabled or disabled in batches in an alarm rule. Array Length: 1 - 100

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

**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: 403

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

Status code: 404

**Table 8** 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 9** 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

{
  "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	Failed to verify parameters.
401	Not authenticated.
403	Authentication failed.
404	Resource not found.
500	Internal system error.