Help Center> Cloud Eye> API Reference> API v2> Alarm Notification Masking> Querying Resources for Which Alarm Notifications Have Been Masked

Updated on 2024-05-16 GMT+08:00

View PDF

Querying Resources for Which Alarm Notifications Have Been Masked

Function

This API is used to query resources for which alarm notifications have been masked.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

GET /v2/{project_id}/notification-masks/{notification_mask_id}/resources

**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}$
notification_mask_id	Yes	String	Specifies the masking rule ID. Minimum: 1 Maximum: 64 Regex Pattern: ^([a-z]\|[A-Z]\|[0-9]){1,64}$

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Specifies the pagination offset. Minimum: 0 Maximum: 10000 Default: 0 Regex Pattern: ^([0]\|[1-9]\|[1-9][0-9]\|[1-9][0-9][0-9]\|[1-9][0-9][0-9][0-9]\|10000)$
limit	No	Integer	Specifies the number of records that will be displayed on each page. Minimum: 1 Maximum: 100 Default: 100 Regex Pattern: ^([1-9]\|[1-9][0-9]\|100)$

Request Parameters

**Table 3** 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

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
resources	Array of Resource objects	Specifies the list of resources whose alarm notifications are masked. Array Length: 1 - 100
count	Integer	Specifies the total number of resources. Minimum: 0 Maximum: 100

**Table 5** Resource
Parameter	Type	Description
namespace	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	Array of Dimension objects	Specifies the resource dimension information. Array Length: 1 - 4

**Table 6** Dimension
Parameter	Type	Description
name	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	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}$

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

None

Example Responses

Status code: 200

Resources queried.

{
  "resources" : [ {
    "namespace" : "SYS.ECS",
    "dimensions" : [ {
      "name" : "instance_id",
      "value" : "4270ff17-aba3-4138-89fa-820594c39755"
    } ]
  } ],
  "count" : 100
}