ListWaitingRooms API Overview - Edge Security Acceleration

Queries all waiting rooms in a website.

Operation description

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

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

esa:ListWaitingRooms

list

*Site

acs:esa:{#regionId}:{#accountId}:site/{#SiteId}

None

Request parameters

Parameter	Type	Required	Description	Example
SiteId	integer	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 elements

Element	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.
	array<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.
	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.	自定义HTML内容或标识
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

Success response

JSON format

{
  "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": "自定义HTML内容或标识",
      "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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.