Help Center/ Cloud Eye/ API Reference/ API V2/ Alarm Masking Rules/ Modifying the Masking Time of Alarm Masking Rules in Batches

Updated on 2025-11-20 GMT+08:00

View PDF

Modifying the Masking Time of Alarm Masking Rules in Batches

Function

Modify the masking time of alarm masking rules in batches.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID. It is 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 from the API or console. For details, see Obtaining a Project ID. Constraints N/A Range 1 to 64 characters Default Value N/A

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.
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
notification_mask_ids	Yes	Array of strings	Association ID.
mask_type	Yes	String	Definition Masking type. Constraints N/A Range The value can be: 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. Default Value N/A
start_date	No	String	Definition Masking start date. Constraints N/A Range The value contains 10 characters and is in the yyyy-MM-dd format. Default Value N/A
start_time	No	String	Definition Masking start time. Constraints N/A Range The value contains eight characters in the HH:mm:ss format. Default Value N/A
end_date	No	String	Definition Masking end date. Constraints N/A Range The value contains 10 characters and is in the yyyy-MM-dd format. Default Value N/A
end_time	No	String	Definition Masking end time. Constraints N/A Range The value contains eight characters in the HH:mm:ss format. Default Value N/A
effective_timezone	No	String	Definition Time zone, for example, GMT-08:00, GMT+08:00, or GMT+0:00. Constraints N/A Range 1 to 16 characters Default Value N/A

Response Parameters

Status code: 204

Masking time modified.

Status code: 400

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

Example Requests

{
  "notification_mask_ids" : [ "nm123232232341232132" ],
  "mask_type" : "START_END_TIME",
  "start_date" : "2022-11-09 16:37:24",
  "start_time" : "HH:mm:ss",
  "end_date" : "2022-12-09 16:37:24",
  "end_time" : "HH:mm:ss"
}