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

Creating Alarm Notification Masking Rules in Batches

Function

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

PUT /v2/{project_id}/notification-masks

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

mask_name

No

String

Specifies the masking rule name. The value can contain up to 64 characters, including only letters, digits, hyphens (-), and underscores (_).

relation_type

Yes

String

Specifies the type of a resource that is associated with an alarm notification masking rule. ALARM_RULE: alarm rules RESOURCE: resources RESOURCE_POLICY_NOTIFICATION: alarm policies for the resource RESOURCE_POLICY_ALARM: alarm policies for the resource (The alarm policies are not used for alarm calculation.)

Enumeration values:

  • ALARM_RULE

  • RESOURCE

  • RESOURCE_POLICY_NOTIFICATION

  • RESOURCE_POLICY_ALARM

relation_ids

Yes

Array of strings

Specifies the 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.

Array Length: 1 - 100

resources

No

Array of Resource objects

Specifies the resource for which alarm notifications will be masked when you set relation_type is to RESOURCE, RESOURCE_POLICY_NOTIFICATION, or RESOURCE_POLICY_ALARM.

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.

Table 4 Resource

Parameter

Mandatory

Type

Description

namespace

Yes

String

Specifies the resource namespace in service.item format. The values of service and item must be character strings, start with a letter, and can contain digits, letters, and underscores (_). A namespace can contain 3 to 32 characters.

dimensions

Yes

Array of Dimension objects

Specifies the resource dimension information.

Array Length: 1 - 4

Table 5 Dimension

Parameter

Mandatory

Type

Description

name

Yes

String

Specifies the 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 Services Interconnected with Cloud Eye.

Regex Pattern: ^([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_|-){1,32}$

value

Yes

String

Specifies the value of a resource dimension, which is the resource 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}$

Response Parameters

Status code: 201

Table 6 Response body parameters

Parameter

Type

Description

relation_ids

Array of strings

Specifies IDs of resources that were successfully associated with a masking rule.

Array Length: 0 - 100

notification_mask_id

String

Specifies the masking rule ID.

Status code: 400

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

{
  "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

Masking rules created.

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

Status Codes

Status Code

Description

201

Masking rules created.

400

Failed to verify parameters.

500

Internal system error.

Error Codes

See Error Codes.