Help Center/ Cloud Eye/ API Reference/ API V2/ Alarm Rules/ Deleting Alarm Rules in Batches

Deleting Alarm Rules in Batches

Updated on 2025-02-27 GMT+08:00

Function

This API is used to batch delete alarm rules.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Specifies the tenant ID.

Minimum: 1

Maximum: 64

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

No

String

Specifies the MIME type of the request body. The default type is application/json; charset=UTF-8.

Default: application/json; charset=UTF-8

Minimum: 1

Maximum: 64

X-Auth-Token

No

String

Specifies the user token.

Minimum: 1

Maximum: 16384

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

alarm_ids

Yes

Array of strings

Specifies the IDs of the alarm rules to be deleted in batches.

Array Length: 1 - 10

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

alarm_ids

Array of strings

Specifies the IDs of the alarm rules that are deleted.

Array Length: 1 - 10

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Specifies the status codes customized by each cloud service when a request error occurs.

Minimum: 0

Maximum: 256

error_msg

String

Specifies the request error message.

Minimum: 0

Maximum: 256

request_id

String

Specifies the request ID.

Minimum: 0

Maximum: 256

Status code: 500

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Specifies the status codes customized by each cloud service when a request error occurs.

Minimum: 0

Maximum: 256

error_msg

String

Specifies the request error message.

Minimum: 0

Maximum: 256

request_id

String

Specifies the request ID.

Minimum: 0

Maximum: 256

Example Requests

Deleting Alarm Rules in Batches

{
  "alarm_ids" : [ "al12345678901234567890" ]
}

Example Responses

Status code: 200

Alarm rules deleted.

{
  "alarm_ids" : [ "alCzk8o9dtSQHtiDgb44Eepw" ]
}

Status Codes

Status Code

Description

200

Alarm rules deleted.

400

Failed to verify parameters.

500

Internal system error.

Error Codes

See Error Codes.

Feedback

Feedback

Feedback

0/500

Selected Content

Submit selected content with the feedback