Help Center/ Cloud Eye/ API Reference/ API v2/ Alarm Notification Masking/ Modifying the Masking Time of Alarm Notification Masking Rules in Batches
Updated on 2024-05-16 GMT+08:00

Modifying the Masking Time of Alarm Notification Masking Rules in Batches

Function

This API is used to modify the masking time of alarm notification masking rules in batches.

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}/notification-masks/batch-update

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 associated ID.

Array Length: 1 - 100

mask_type

Yes

String

Specifies the alarm notification masking type. START_END_TIME: Alarms are masked by start time and end time. FOREVER_TIME: Alarms are masked permanently. CYCLE_TIME: Alarms are masked by period.

Enumeration values:

  • START_END_TIME

  • FOREVER_TIME

  • CYCLE_TIME

start_date

No

String

Specifies the masking start date, in yyyy-MM-dd format.

start_time

No

String

Specifies the masking start time, in HH:mm:ss format.

end_date

No

String

Specifies the masking end date, in yyyy-MM-dd format.

end_time

No

String

Specifies the masking end time, in HH:mm:ss format.

Response Parameters

Status code: 400

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

Example Requests

{
  "notification_mask_ids" : [ "nm123232232341232132" ],
  "mask_type" : "START_END_TIME",
  "start_date" : "yyyy-MM-dd",
  "start_time" : "HH:mm:ss",
  "end_date" : "yyyy-MM-dd",
  "end_time" : "HH:mm:ss"
}

Example Responses

None

Status Codes

Status Code

Description

204

Masking time modified.

400

Failed to verify parameters.

500

Internal system error.

Error Codes

See Error Codes.