Deleting Alarm Rules in Batches

Function

This API (V2) 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

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

No

String

MIME type of the request body.

Default: application/json; charset=UTF-8

Minimum: 1

Maximum: 64

X-Auth-Token

No

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

alarm_ids

Yes

Array of strings

IDs of the alarm rules to be deleted in batches.

Array length: 1 to 10

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.

Array length: 1 to 10

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

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

Example Requests

Batch deleting alarm rules

{
  "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

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

Error Codes

See Error Codes.