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/ Querying Resources for Which an Alarm Masking Rule Is Applied

Querying Resources for Which an Alarm Masking Rule Is Applied

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

View PDF

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.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Tenant ID. Regex Pattern: ^[a-zA-Z0-9-]{1,64}$
notification_mask_id	Yes	String	Masking rule ID. Regex Pattern: ^([a-z]\|[A-Z]\|[0-9]){1,64}$

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Pagination offset. Value range: 0-10000 Default value: 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	Number of records on each page. Value range: 1-100 Default value: 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	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.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
resources	Array of Resource objects	List of resources for which an alarm masking rule is applied.
count	Integer	Total number of resources. Value range: 0-100

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

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

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

None

Example Responses

Status code: 200

Resources queried.

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

Status Codes


Status Code	Description
200	Resources queried.
400	Parameter verification failed.
500	Internal system error.

Error Codes

See Error Codes.

Parent topic: Alarm Masking Rules

Previous topic: Querying Alarm Masking Rules

Next topic: Dashboards

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