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

Updated on 2025-08-27 GMT+08:00

Online Debugging

CLI Examples

View PDF

Modifying the Masking Time of Alarm Masking Rules in Batches

Function

Modify the masking time of alarm 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	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
notification_mask_ids	Yes	Array of strings	Association ID.
mask_type	Yes	String	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	Masking start date, in yyyy-MM-dd format.
start_time	No	String	Masking start time, in HH:mm:ss format.
end_date	No	String	Masking end date, in yyyy-MM-dd format.
end_time	No	String	Masking end time, in HH:mm:ss format.
effective_timezone	No	String	Time zone, for example, GMT-08:00, GMT+08:00, or GMT+0:00.

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" : "yyyy-MM-dd",
  "start_time" : "HH:mm:ss",
  "end_date" : "yyyy-MM-dd",
  "end_time" : "HH:mm:ss"
}