Files
doc-exports/docs/ces/api-ref/BatchDeleteOneClickAlarms.html
qiujiandong1 e9265fb6b0 CES API Update -20250521 version
Reviewed-by: Ziuzko, Alevtina <alevtina.ziuzko@t-systems.com>
Co-authored-by: qiujiandong1 <qiujiandong1@huawei.com>
Co-committed-by: qiujiandong1 <qiujiandong1@huawei.com>
2025-12-05 10:48:24 +00:00

33 KiB

Batch Disabling One-Click Monitoring

Function

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

URI

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

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

For details about how to obtain the project ID, see Obtaining a Project ID.

Minimum: 1

Maximum: 64

Regular expression matching: ^[a-zA-Z0-9-]{1,64}$

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

MIME type of the request body.

Default: application/json; charset=UTF-8

Minimum: 1

Maximum: 64

X-Auth-Token

Yes

String

User token. It is a response to the API for obtaining a user token. This API is the only one that does not require authentication. After a response is returned, the value of X-Subject-Token in the response header is the token.

Minimum: 1

Maximum: 16384

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.

Array length: 1 to 100

Range: 1 to 64 characters

Regular expression matching: ^([a-z]|[A-Z]|[0-9]){1,64}$

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.

Array length: 1 to 100

Range: 1 to 64 characters

Regular expression matching: ^([a-z]|[A-Z]|[0-9]){1,64}$

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Status code customized by each cloud service when a request error occurs.

Minimum: 0

Maximum: 256

error_msg

String

Request error message.

Minimum: 0

Maximum: 256

request_id

String

Request ID.

Minimum: 0

Maximum: 256

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Status code customized by each cloud service when a request error occurs.

Minimum: 0

Maximum: 256

error_msg

String

Request error message.

Minimum: 0

Maximum: 256

request_id

String

Request ID.

Minimum: 0

Maximum: 256

Status code: 403

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Status code customized by each cloud service when a request error occurs.

Minimum: 0

Maximum: 256

error_msg

String

Request error message.

Minimum: 0

Maximum: 256

request_id

String

Request ID.

Minimum: 0

Maximum: 256

Status code: 500

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Status code customized by each cloud service when a request error occurs.

Minimum: 0

Maximum: 256

error_msg

String

Request error message.

Minimum: 0

Maximum: 256

request_id

String

Request ID.

Minimum: 0

Maximum: 256

Example Requests

Batch disable one-click motoring.

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

Request body:

{
  "one_click_alarm_ids" : [ "o1619578505263QkW3b66yo" ]
}

Example Responses

Status code: 200

Operation succeeded.

{
  "one_click_alarm_ids" : [ "o1619578505263QkW3b66yo" ]
}

Status Codes

Status Code

Description

200

Operation succeeded.

400

Parameter verification failed.

401

Authentication failed.

403

Authentication failed.

500

Failed to complete the request because of an internal server error.

Error Codes

See Error Codes.