ListWaitingRooms - Edge Security Acceleration - Alibaba Cloud Documentation Center

Queries the information about all waiting rooms in a website.

Operation description

You can call this operation to query detailed configurations about all waiting rooms in a website, including the status, name, and queuing rules of each waiting room.

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:ListWaitingRooms	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.	120876698010528
WaitingRoomId	string	No	The ID of the waiting room. Specify this parameter to query the information about a specific waiting room.	6a51d5bc6460887abd1291dc7d4d****

Response parameters

Parameter	Type	Description	Example
	object	The response.
RequestId	string	The request ID, which is used to trace a call.	CB1A380B-09F0-41BB-A198-72F8FD6DA2FE
WaitingRooms	array<object>	The waiting rooms.
Item	object	The details of the waiting room.
WaitingRoomId	string	The unique ID of the waiting room.	6a51d5bc6460887abd1291dc7d4d****
Enable	string	Indicates whether the waiting room is enabled. Valid values: on off	on
Name	string	The name of the waiting room.
QueueAllEnable	string	Indicates whether all requests must be queued. Valid values: on off	on
HostNameAndPath	array<object>	The hostname and path.
item	object	The details of the hostname and path.
Subdomain	string	The subdomain.	test.
Domain	string	The domain name.	example.com
Path	string	The path.	/test
CookieName	string	The name of the custom cookie.	__aliwaitingroom_example
TotalActiveUsers	string	The maximum number of active users.	300
NewUsersPerMinute	string	The maximum number of new users per minute.	200
SessionDuration	string	The maximum duration for which a session remains valid after a user leaves the origin. Unit: minutes.	3600
DisableSessionRenewalEnable	string	Indicates whether session renewal is disabled. Valid values: on off	on
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.	random
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 JSON response is enabled. If you set this parameter to on, a JSON body is returned for requests to the waiting room with the header Accept: application/json. Valid values: on off	on
Description	string	The description of the waiting room.
WaitingRoomType	string	The type of the waiting room. Valid values: default custom	default
CustomPageHtml	string	The HTML content or identifier of the custom queuing page. This parameter is valid only when `WaitingRoomType` is set to `custom`. The content must be URL-encoded.
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": "CB1A380B-09F0-41BB-A198-72F8FD6DA2FE",
  "WaitingRooms": [
    {
      "WaitingRoomId": "6a51d5bc6460887abd1291dc7d4d****\n",
      "Enable": "on",
      "Name": "",
      "QueueAllEnable": "on",
      "HostNameAndPath": [
        {
          "Subdomain": "test.\n",
          "Domain": "example.com\n",
          "Path": "/test"
        }
      ],
      "CookieName": "__aliwaitingroom_example",
      "TotalActiveUsers": "300",
      "NewUsersPerMinute": "200",
      "SessionDuration": "3600",
      "DisableSessionRenewalEnable": "on",
      "QueuingMethod": "random",
      "QueuingStatusCode": "200",
      "JsonResponseEnable": "on",
      "Description": "",
      "WaitingRoomType": "default",
      "CustomPageHtml": "",
      "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