Help Center/ Cloud Eye/ API Reference/ API V2/ One-Click Monitoring/ Batch Disabling One-Click Motoring
Updated on 2025-08-27 GMT+08:00

Batch Disabling One-Click Motoring

Function

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

Debugging

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

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Tenant ID.

Constraints:

None

Value range:

Project ID, 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 by calling an API or on the console. For details, see Obtaining a Project ID. The value must contain of 1 to 64 characters.

Default value:

None

Request Parameters

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.

Default value:

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

IDs of services that need to disable one-click monitoring.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

one_click_alarm_ids

Array of strings

IDs of services for which one-click monitoring was 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: 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.

Example Requests

{
  "one_click_alarm_ids" : [ "o1619578505263QkW3b66yo" ]
}

Example Responses

Status code: 200

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

{
  "one_click_alarm_ids" : [ "o1619578505263QkW3b66yo" ]
}

Status Codes

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.

Error Codes

See Error Codes.