Querying Resources for Which an Alarm Masking Rule Is Applied

Function

This API is used to query resources for which an alarm masking rule is applied.

Debugging

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

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
ces:alarms:listNotificationMaskResources	List	-	g:EnterpriseProjectId	ces:notificationMasks:list	-

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID. It is 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 from the API or console. For details, see Obtaining a Project ID. Constraints N/A Range 1 to 64 characters. Default Value N/A
notification_mask_id	Yes	String	Definition Masking rule ID. Constraints N/A Range The value allows 1 to 64 characters and can only contain letters and digits. Default Value N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Definition Pagination offset. Constraints N/A Range An integer ranging from 0 to 10,000. Default Value 0
limit	No	Integer	Definition Number of records displayed on each page. Constraints N/A Range An integer ranging from 1 to 100. Default Value 100

Request Parameters

**Table 3** 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.
X-Auth-Token	No	String	Definition User token. Constraints: None Value range: The value can contain 1 to 16,384 characters. Default value: None

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
resources	Array of ResourceResp objects	Definition List of resources for which an alarm masking rule is applied.
count	Integer	Definition Total number of resources. Range [0,100]

**Table 5** ResourceResp
Parameter	Type	Description
namespace	String	Definition Namespace of the service. For details, see Services Interconnected with Cloud Eye. Range The value is in the service.item format. The values of service and item must start with a letter and contain only letters, digits, and underscores (_). It can contain 3 to 32 characters.
dimensions	Array of ResourceDimensionResp objects	Definition Resource dimension information.

**Table 6** ResourceDimensionResp
Parameter	Type	Description
name	String	Definition Dimension of a resource. For example, the dimension of an ECS is instance_id . For details about the dimension names of each resource, see their service documentation. You can navigate there from Services Interconnected with Cloud Eye. Range The value starts with a letter and allows 1 to 32 characters. It can contain only letters, digits, underscores (_), and hyphens (-).
value	String	Definition Resource dimension value, which is an instance ID, for example, 4270ff17-aba3-4138-89fa-820594c39755. Range 1 to 256 characters.

Status code: 400

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

Example Requests

Example request: Query the resources whose alarm masking rule ID is nmxxxxxxxxxxxxxxxxxxxxxx and display 10 records on each page.

https://{Cloud Eye endpoint}/v2/{project_id}/notification-masks/nmxxxxxxxxxxxxxxxxxxxxxx/resources?offset=0&limit=10

Example Responses

Status code: 200

Resources queried.

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