Help Center/ Cloud Eye/ API Reference/ API V2/ One-Click Monitoring/ Batch Disabling One-Click Motoring

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

View PDF

Batch Disabling One-Click Motoring

This API is used to batch disable one-click monitoring.

POST /v2/{project_id}/one-click-alarms/batch-delete

**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
one_click_alarm_ids	Yes	Array of strings	Definition IDs of one-click monitoring rules to be deleted in batches. Constraints There can be 1 to 100 one-click monitoring rule IDs.

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
one_click_alarm_ids	Array of strings	Definition One-click monitoring rule IDs that are deleted.

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

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

{
  "one_click_alarm_ids" : [ "o1619578505263QkW3b66yo" ]
}

Status code: 200

IDs of services for which one-click monitoring was disabled.

{
  "one_click_alarm_ids" : [ "o1619578505263QkW3b66yo" ]
}

Status Code	Description
200	IDs of services for which one-click monitoring was disabled.
400	Parameter verification failed.
401	Not authenticated.
403	Authentication failed.
500	Internal system error.