Help Center/ Cloud Eye/ API Reference/ API V2/ One-Click Monitoring/ Batch Enabling or Disabling Alarm Rules for One Service in One-Click Monitoring

Updated on 2025-10-30 GMT+08:00

View PDF

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

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

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

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
ces:alarms:putOneClickAlarms	Write	-	g:EnterpriseProjectId	ces:oneClickAlarms:put	-

PUT /v2/{project_id}/one-click-alarms/{one_click_alarm_id}/alarm-rules/action

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID. It is 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 from the API or console. For details, see Obtaining a Project ID. Constraints N/A Range 1 to 64 characters Default Value N/A
one_click_alarm_id	Yes	String	Definition One-click monitoring rule ID. Constraints N/A Range The value allows only letters and digits and can contain 1 to 64 characters. Default Value N/A

**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.
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
alarm_ids	Yes	Array of strings	Definition IDs of alarm rules to be enabled or disabled in batches. Constraints At least one and a maximum of 100 alarm rule IDs can be configured.
alarm_enabled	Yes	Boolean	Definition Whether to enable the alarm rule. Constraints N/A Range A boolean value. true: enabled false: disabled Default Value true

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
alarm_ids	Array of strings	Definition IDs of alarm rules that were enabled or disabled.

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

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

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

Status code: 404

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

{
  "alarm_ids" : [ "al123232232341232132" ],
  "alarm_enabled" : true
}

Status code: 200

Alarm rules enabled or disabled.

{
  "alarm_ids" : [ "al123232232341232132" ]
}

Status Code	Description
200	Alarm rules enabled or disabled.
400	Parameter verification failed.
401	Not authenticated.
403	Authentication failed.
404	Resource not found.
500	Internal system error.