Help Center/ Workspace/ API Reference/ Workspace APIs/ User/ Querying Notification Blocking Records

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

View PDF

Querying Notification Blocking Records

Function

Queries notification blocking records.

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, no identity policy-based permission required for calling this API.

URI

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

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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
query_type	Yes	String	The type used to query notification blocking records related to desktops or desktop pools. DESKTOP: Search for notification blocking records related to desktops in the current project. DESKTOP_POOL: Search for notification blocking records related to desktop pools in the current project.
desktop_name	No	String	Desktop name.
desktop_pool_name	No	String	Desktop pool name, which must be unique. The desktop name can contain 1 to 255 characters, including uppercase letters, lowercase letters, digits, and hyphens (-).
user_name	No	String	Username.
type	No	String	Type used to filter notification blocking records that are the same as the SMN notification type. EMAIL: Search for notification blocking records by email. SMS: Search for notification blocking records by SMS message.
offset	No	Integer	Where the pagination query starts. The value starts from 0.
limit	No	Integer	Pagination query. The value ranges from 0 to 1,000 and defaults to 1000.
sort_field	No	String	Sorting field, which must be used together with sort_type. operate_time: sending time.
sort_type	No	String	Sorting type, which defaults to ascending order. This parameter must be used together with sort_field. ASC: ascending order DESC: descending order

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
total_count	Integer	Total number.
notification_records	Array of NotificationRecordInfo objects	Notification blocking records.

**Table 4** NotificationRecordInfo
Parameter	Type	Description
project_id	String	Project ID.
type	String	SMN sending type. The options are EMAIL and SMS.
user_name	String	Username.
desktop_name	String	Desktop name.
desktop_pool_name	String	Desktop pool name.
result	String	Sending result.
error_message	String	Error message.
operate_time	String	Operation time.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 401

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 403

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 404

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 500

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Example Requests

/v2/29dfe82ada564ac2b927e1ff036d9a9b/users/notification-records

Example Responses

Status code: 200

Response body of notification blocking records.

{
  "total_count" : 2,
  "notification_records" : [ {
    "project_id" : "20b726affecc4411bcdc49a66e3e8f63",
    "type" : "EMAIL",
    "user_name" : "zhangsan",
    "desktop_name" : "desktop",
    "result" : "FAIL",
    "error_message" : "The **zhangsan,desktop** information you provided violates relevant laws and regulations. Check and modify the information and try again.",
    "operate_time" : "2025-04-15T01:40:23.584Z"
  }, {
    "project_id" : "20b726affecc4411bcdc49a66e3e8f63",
    "type" : "SMS",
    "user_name" : "lisi",
    "desktop_pool_name" : "desktopPool",
    "result" : "FAIL",
    "error_message" : "The **lisi,desktopPool** information you provided violates relevant laws and regulations. Check and modify the information and try again.",
    "operate_time" : "2025-09-15T01:40:23.584Z"
  } ]
}

Status Codes

Status Code	Description
200	Response body of notification blocking records.
400	The request cannot be understood by the server due to malformed syntax.
401	Authentication failed.
403	No permissions.
404	Resources not found.
500	An internal service error occurred. For details, see the error code description.