Creating Alarm Masking Rules in Batches

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

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

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.

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.

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]|_|-)*$

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]|_|-|\.|\*|/|#|\(|\))*))$

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.

relation_ids

Array of strings

IDs of associated alarm rules or policies that were successfully created.

notification_mask_id

String

Masking rule ID.

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.

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.

201

Notification masking rules created.

400

Parameter verification failed.

500

Internal system error.