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.
URI
GET /v2/{project_id}/notification-masks/{notification_mask_id}/resources
| 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 |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| offset | No | Integer | Pagination offset. |
| limit | No | Integer | Number of records on each page. |
Request 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
| 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. |
| Parameter | Type | Description |
|---|---|---|
| namespace | String | Definition Namespace of a service. For details about the namespace of each service, see Namespace. Constraints N/A Range The value is in the service.item format. The values of service and item must be a string, starting with a letter and containing only digits (0–9), letters (case-insensitive), and underscores (_). The value must contain 3 to 32 characters. Default Value N/A |
| dimensions | Array of ResourceDimension objects | Definition Resource dimension information. Constraints A maximum of four dimensions are allowed. |
| Parameter | Type | Description |
|---|---|---|
| name | String | Definition 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 Dimensions. Constraints N/A Range The value starts with a letter and allows 1 to 32 characters. It can contain letters, digits, underscores (_), and hyphens (-). Default Value N/A |
| value | String | Definition Resource dimension value, which is an instance ID, for example, 4270ff17-aba3-4138-89fa-820594c39755. Constraints N/A Range 1 to 256 characters Default Value N/A |
Status code: 400
| 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
| 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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
