Help Center/ Workspace/ API Reference/ Workspace APIs/ Report Statistics/ Querying Whether There Are Records That Meet the Notification Rule in the Corresponding Metric Dimension

Updated on 2026-02-10 GMT+08:00

View PDF

Querying Whether There Are Records That Meet the Notification Rule in the Corresponding Metric Dimension

Function

Queries whether there are records that meet the notification rule in the corresponding metric dimension.

The query result indicates only the records that meet the notification rule in the corresponding metric dimension.

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
workspace:statistics:listNotificationRecords	List	-	-	-	-

URI

GET /v2/{project_id}/statistics/notification-records

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
metric_name	No	String	Metric name (exact match) (metric_name and rule_id cannot be empty at the same time.)
rule_id	No	String	Notification rule ID (metric_name and rule_id cannot be empty at the same time.)
offset	No	Integer	Query offset. The default value is 0.
limit	No	Integer	The number of records for each query ranges from 1 to 100. The default value is 10.

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
count	Integer	Total number.
items	Array of DesktopMetricNotifyRecord objects	Notification record.

**Table 4** DesktopMetricNotifyRecord
Parameter	Type	Description
match_count	Integer	Number of desktops that meet the notification rule threshold.
metric_name	String	Metric name.
threshold	Integer	Statistical period (days).
comparison_operator	String	Condition for comparing a metric statistical value with the threshold. >= - Triggered when the metric statistical value is greater than or equal to the threshold. > - Triggered when the metric statistical value is greater than the threshold. = - Triggered when the metric statistical value is equal to the threshold. <= - Triggered when the metric statistical value is less than or equal to the threshold. < - Triggered when the metric statistical value is less than the threshold.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 401

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Requests

None

Example Responses

Status code: 200

Succeeded.

{
  "count" : 0,
  "items" : [ {
    "match_count" : 1,
    "metric_name" : "desktop_state",
    "threshold" : 30,
    "comparison_operator" : ""
  } ]
}