ListWaitingRooms - Query waiting rooms | ESA API - Edge Security Acceleration

Queries the details of all configured waiting rooms for a specified site.

Operation description

This API allows you to query the configuration details of all waiting rooms for a specified site, including the enabled status, name, and queuing rules.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
SiteId	integer	Yes	The site ID. You can call the ListSites operation to obtain the site ID.	120876698010528
WaitingRoomId	string	No	The waiting room ID. Specify this parameter to query the details of a specific waiting room.	6a51d5bc6460887abd1291dc7d4d****

Response elements

Element	Type	Description	Example
	object	The query response.
RequestId	string	The request ID, which is used to trace API calls.	CB1A380B-09F0-41BB-A198-72F8FD6DA2FE
WaitingRooms	array<object>	The list of waiting rooms.
	array<object>	The waiting room details.
WaitingRoomId	string	The waiting room ID, which uniquely identifies a waiting room.	6a51d5bc6460887abd1291dc7d4d****
Enable	string	The enabled status. Valid values: on: Enabled. off: Disabled.	on
Name	string	The waiting room name.	Test waiting room
QueueAllEnable	string	Specifies whether to queue all visitors. Valid values: on: Enabled. off: Disabled.	on
HostNameAndPath	array<object>	The hostname and path configurations.
	object	The hostname and path details.
Subdomain	string	The subdomain.	test.
Domain	string	The domain name.	example.com
Path	string	The path.	/test
CookieName	string	The custom cookie name.	__aliwaitingroom_example
TotalActiveUsers	string	The total number of active users.	300
NewUsersPerMinute	string	The number of new users per minute.	200
SessionDuration	string	The session duration, in minutes.	3600
DisableSessionRenewalEnable	string	Specifies whether to disable session renewal. Valid values: on: Enabled. off: Disabled.	on
QueuingMethod	string	The queuing method. Valid values: random: Random. fifo: First in, first out. passthrough: Passthrough. reject-all: Reject all.	random
QueuingStatusCode	string	The waiting room status code. Valid values: 200 202 429	200
JsonResponseEnable	string	Specifies whether to enable JSON response. When enabled, requests with an Accept header containing "application/json" return JSON data. Valid values: on: Enabled. off: Disabled.	on
Description	string	The waiting room description.	Test waiting room
WaitingRoomType	string	The waiting room type. Valid values: default: Default type. custom: Custom type.	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.	Custom HTML content
Language	string	The language of the waiting room page. This parameter is required when the waiting room type is 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": "Test waiting room",
      "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": "Test waiting room",
      "WaitingRoomType": "default",
      "CustomPageHtml": "Custom HTML content",
      "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.