Help Center/ Cloud Eye/ API Reference/ API V2/ Alarm Rules/ Enabling or Disabling Alarm Rules in Batches

Updated on 2025-11-20 GMT+08:00

View PDF

Enabling or Disabling Alarm Rules in Batches

This API is used to enable or disable alarm rules in batches.

POST /v2/{project_id}/alarms/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

**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, which can be: true: enable false: disable 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: 500

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

Enabling or disabling alarm rules in batches.

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

Status code: 200

Alarm rules enabled or disabled.

{
  "alarm_ids" : [ "alCzk8o9dtSQHtiDgb44Eepw" ]
}

Status Code	Description
200	Alarm rules enabled or disabled.
400	Parameter verification failed.
500	Internal system error.

Parent topic: Alarm Rules

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel