Help Center/ Cloud Eye/ API Reference/ API V2/ Alarm Notification Masking/ Deleting Alarm Notification Masking Rules in Batches
Updated on 2025-02-27 GMT+08:00
View PDF

Deleting Alarm Notification Masking Rules in Batches

Function

This API is used to deleting alarm notification masking rules in batches.

URI

POST /v2/{project_id}/notification-masks/batch-delete

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Specifies the tenant ID.

Minimum: 1

Maximum: 64

Regex Pattern: ^[a-zA-Z0-9-]{1,64}$

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

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

Yes

String

Specifies the user token.

Minimum: 1

Maximum: 16384
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

notification_mask_ids

Yes

Array of strings

Specifies the masking rule ID.

Array Length: 1 - 100

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

notification_mask_ids

Array of strings

Specifies the ID of a masking rule that was successfully deleted.

Array Length: 1 - 100

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

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

Status code: 500

Table 7 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

{
  "notification_mask_ids" : [ "nm123232232341232132" ]
}

Example Responses

Status code: 200

Notification masking rules deleted.

{
  "notification_mask_ids" : [ "nm123232232341232132" ]
}

Status Codes

Status Code

Description

200

Notification masking rules deleted.

400

Failed to verify parameters.

404

Resource not found.

500

Internal system error.

Error Codes

See Error Codes.