ListWaitingRoomEvents - Edge Security Acceleration - Alibaba Cloud Documentation Center

Queries the information about waiting room events for a waiting room.

Operation description

You can call this operation to query details of all waiting room events related to a waiting room in a website.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
esa:ListWaitingRoomEvents	list	*Site `acs:esa:{#regionId}:{#accountId}:site/{#SiteId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
SiteId	long	Yes	The website ID, which can be obtained by calling the ListSites operation.	7096621098****
WaitingRoomId	string	Yes	The unique ID of the waiting room, which can be obtained by calling the ListWaitingRooms operation.	6a51d5bc6460887abd129****
WaitingRoomEventId	long	No	The ID of the waiting room event. This parameter is optional. You can specify this parameter to query a specific waiting room event.	89677721098****

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID, which is used to trace a call.	f3c3700a-4c0f-4a24-b576-fd7dbf9e7c55
WaitingRoomEvents	array<object>	The details of the waiting room events.
Item	object	The details of the waiting room event.
WaitingRoomEventId	long	The unique ID of the waiting room event.	89677721098****
WaitingRoomId	string	The ID of the waiting room associated with the event.	5c938a045c9ca46607163d34966****
Enable	string	The event status. Valid values: on off	on
Name	string	The custom event name.
TotalActiveUsers	string	The maximum number of active users.	22
NewUsersPerMinute	string	The maximum number of new users per minute.	11
SessionDuration	string	The maximum duration for which a session remains valid after a user leaves the origin. Unit: minutes.	3
DisableSessionRenewalEnable	string	Indicates whether session renewal is disabled. Valid values: on off	off
QueuingMethod	string	The queuing method. Valid values: random: Users gain access to the origin randomly, regardless of the arrival time. fifo: Users gain access to the origin in order of arrival. passthrough: Users pass through the waiting room and go straight to the origin. reject-all: Users are blocked from reaching the origin.	fifo
QueuingStatusCode	string	The HTTP status code to return while a user is in the queue. Valid values: 200 202 429	200
JsonResponseEnable	string	Indicates whether JOSN response is enabled. If JSON response is enabled, a JSON body is returned for requests to the waiting room with the header Accept: application/json. Valid values: on off	off
Description	string	The event description.	terraform-example
WaitingRoomType	string	The type of the waiting room. Valid values: default custom	custom
CustomPageHtml	string	The content of the custom waiting room page. This parameter is returned when the waiting room type is set to custom. The content is URL-encoded.	html-yets-maqi1111
StartTime	string	The start time of the event. This value is a UNIX timestamp.	1719814398
EndTime	string	The end time of the event. This value is a UNIX timestamp.	1719814497
PreQueueEnable	string	Indicates whether pre-queuing is enabled. Valid values: on off	on
PreQueueStartTime	string	The start time for pre-queuing. This value is a UNIX timestamp. This parameter is valid only when pre-queuing is enabled.	1719814097
RandomPreQueueEnable	string	Indicates whether random queuing is enabled. Valid values: on off	on
Language	string	The language of the waiting room page. This parameter is returned when the waiting room type is set to default. Valid values: enus: English. zhcn: Simplified Chinese. zhhk: Traditional Chinese.	zhcn

Examples

Sample success responses

JSONformat

{
  "RequestId": "f3c3700a-4c0f-4a24-b576-fd7dbf9e7c55",
  "WaitingRoomEvents": [
    {
      "WaitingRoomEventId": 0,
      "WaitingRoomId": "5c938a045c9ca46607163d34966****",
      "Enable": "on",
      "Name": "",
      "TotalActiveUsers": 22,
      "NewUsersPerMinute": 11,
      "SessionDuration": 3,
      "DisableSessionRenewalEnable": "off",
      "QueuingMethod": "fifo",
      "QueuingStatusCode": 200,
      "JsonResponseEnable": "off",
      "Description": "terraform-example",
      "WaitingRoomType": "custom",
      "CustomPageHtml": "html-yets-maqi1111",
      "StartTime": 1719814398,
      "EndTime": 1719814497,
      "PreQueueEnable": "on",
      "PreQueueStartTime": 1719814097,
      "RandomPreQueueEnable": "on",
      "Language": "zhcn"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	InternalException	Failed to call the service. Try again later or contact technical support.	Failed to call the service. Try again later or contact technical support.
403	Site.NotExist	The specified website does not exist or is not recognized by the system.Check whether the specified website identifier is valid and matches a website that is active, defined, and recognized by the system.If you want to add a new website, make sure that the creation and registration process is complete to integrate the website to the system.	The specified website does not exist or is not recognized by the system.Check whether the specified website identifier is valid and matches a website that is active, defined, and recognized by the system.If you want to add a new website, make sure that the creation and registration process is complete to integrate the website to the system.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-09-18	The Error code has changed	View Change Details