Help Center/ Cloud Eye/ API Reference/ API V2/ Alarm Rules/ Batch Deleting Alarm Rules
Updated on 2025-08-27 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Batch Deleting Alarm Rules

Function

This API (V2) is used to batch delete alarm rules.

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}/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

alarm_ids

Yes

Array of strings

IDs of the alarm rules to be deleted in batches.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

alarm_ids

Array of strings

IDs of the alarm rules 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: 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.

Example Requests

Deleting alarm rules in batches.

{
  "alarm_ids" : [ "al12345678901234567890" ]
}

Example Responses

Status code: 200

Alarm rule deleted.

{
  "alarm_ids" : [ "alCzk8o9dtSQHtiDgb44Eepw" ]
}

Status Codes

Status Code

Description

200

Alarm rule deleted.

400

Parameter verification failed.

500

Internal system error.

Error Codes

See Error Codes.

Parent topic: Alarm Rules