On this page

Function
Debugging
URI
Request Parameters
Response Parameters
Example Requests
Example Responses
Status Codes
Error Codes

Show all

Help Center/ Cloud Eye/ API Reference/ API V2/ Alarm Masking Rules/ Creating Alarm Masking Rules in Batches

Creating Alarm Masking Rules in Batches

Updated on 2025-07-18 GMT+08:00

View PDF

Function

This API is used to create 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

PUT /v2/{project_id}/notification-masks

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Tenant ID. Regex Pattern: ^[a-zA-Z0-9-]{1,64}$

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	MIME type of the request body. The default type is application/json; charset=UTF-8. Default value: application/json; charset=UTF-8
X-Auth-Token	Yes	String	User token.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
mask_name	No	String	Masking rule name. The value can contain up to 64 characters, including only letters, digits, hyphens (-), and underscores (_).
relation_type	Yes	String	Method for masking alarm notifications or calculation. ALARM_RULE: masking alarm notifications by alarm rule. RESOURCE: masking alarm notifications by resource. RESOURCE_POLICY_NOTIFICATION: masking alarm notifications by resource or alarm policy. RESOURCE_POLICY_ALARM: masking alarm calculation by resource or alarm policy. Enumeration values: ALARM_RULE RESOURCE RESOURCE_POLICY_NOTIFICATION RESOURCE_POLICY_ALARM
relation_ids	Yes	Array of strings	Alarm rule or alarm policy ID. If you set relation_type to ALARM_RULE, set this parameter to the ID of the masked alarm rule. If you set relation_type to RESOURCE_POLICY_NOTIFICATION or RESOURCE_POLICY_ALARM, set this parameter to the ID of the masked alarm policy.
resources	No	Array of Resource objects	Associated resource. It is required when you set relation_type to RESOURCE, RESOURCE_POLICY_NOTIFICATION, or RESOURCE_POLICY_ALARM.
metric_names	No	Array of strings	Name of the associated metric. This parameter is optional when relation_type is set to RESOURCE. If this parameter is left blank, the masking rule will be applied to all metrics of the resource.
product_metrics	No	Array of ProductMetric objects	Metric information when the masking rule is applied by cloud product.
resource_level	No	String	dimension indicates the sub-dimension, and product indicates the cloud product. Enumeration values: dimension product
product_name	No	String	Cloud product name specified when Cloud product is selected for Resource Level.
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.

**Table 4** Resource
Parameter	Mandatory	Type	Description
namespace	Yes	String	Namespace of a service. For details about the namespace of each service, see Namespace.
dimensions	Yes	Array of ResourceDimension objects	Resource dimension information.

**Table 5** ResourceDimension
Parameter	Mandatory	Type	Description
name	Yes	String	Dimension of a resource. For example, the dimension of an ECS can be instance_id. A maximum of four dimensions are supported. For the metric dimension of each resource, see Service metric dimension. Regex Pattern: ^([a-z]\|[A-Z]){1}([a-z]\|[A-Z]\|[0-9]\|_\|-){1,32}$
value	Yes	String	Value of a resource dimension. It is the instance ID, for example, 4270ff17-aba3-4138-89fa-820594c39755. Regex Pattern: ^((([a-z]\|[A-Z]\|[0-9]){1}([a-z]\|[A-Z]\|[0-9]\|_\|-\|\.))\|\){1,256}$

**Table 6** ProductMetric
Parameter	Mandatory	Type	Description
dimension_name	Yes	String	Metric dimension information when the masking rule is applied by cloud product. Use commas (,) to separate multiple metric dimensions.
metric_name	Yes	String	Metric name of a resource. The name must start with a letter and contain only digits, letters, and underscores. The length ranges from 1 to 64 characters. For example, cpu_util of an ECS indicates the CPU usage of the ECS. mongo001_command_ps in DDS indicates the command execution frequency. For details about the metric name of each service, see Service metric name.

Response Parameters

Status code: 201

**Table 7** Response body parameters
Parameter	Type	Description
relation_ids	Array of strings	IDs of associated alarm rules or policies that were successfully created.
notification_mask_id	String	Masking rule ID.

Status code: 400

**Table 8** 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 9** 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

{
  "mask_name" : "mn_test",
  "relation_type" : "ALARM_RULE",
  "relation_ids" : [ "al123232232341232132" ],
  "resources" : [ {
    "namespace" : "SYS.ECS",
    "dimensions" : [ {
      "name" : "instance_id",
      "value" : "4270ff17-aba3-4138-89fa-820594c39755"
    } ]
  } ],
  "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

Status code: 201

Notification masking rules created.

{
  "relation_ids" : [ "al123232232341232132" ],
  "notification_mask_id" : "nm123232232341232132"
}

Status Codes


Status Code	Description
201	Notification masking rules created.
400	Parameter verification failed.
500	Internal system error.

Error Codes

See Error Codes.

Parent topic: Alarm Masking Rules

Previous topic: Alarm Masking Rules

Next topic: Modifying the Masking Time of Alarm Masking Rules in Batches

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot