ListWaitingRooms - 查询等候室列表_边缘安全加速(ESA)-阿里云帮助中心

查询指定站点下已配置的所有等候室的详细信息。

接口说明

此 API 允许您查询指定站点下所有等候室的配置详情，包括启用状态、名称、排队规则等信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作

操作	访问级别	资源类型	条件关键字	关联操作
esa:ListWaitingRooms	list	*Site `acs:esa:{#regionId}:{#accountId}:site/{#SiteId}`	无	无

请求参数

名称	类型	必填	描述	示例值

名称	类型	必填	描述	示例值
SiteId	long	是	站点 ID，可通过调用 ListSites 接口获取。	120876698010528
WaitingRoomId	string	否	等候室 ID，用于查询特定等候室的详情。	6a51d5bc6460887abd1291dc7d4d****

返回参数

名称	类型	描述	示例值

名称	类型	描述	示例值
	object	查询响应结果。
RequestId	string	请求 ID，用于追踪 API 调用情况。	CB1A380B-09F0-41BB-A198-72F8FD6DA2FE
WaitingRooms	array<object>	等候室列表。
Item	object	等候室详情。
WaitingRoomId	string	等候室 ID，唯一标识一个等候室。	6a51d5bc6460887abd1291dc7d4d****
Enable	string	启用状态，取值： on：启用。 off：禁用。	on
Name	string	等候室名称。	测试等候室
QueueAllEnable	string	全部排队。取值： on：开启。 off：关闭。	on
HostNameAndPath	array<object>	主机名和路径。
item	object	主机名和路径详情。
Subdomain	string	子域名。	test.
Domain	string	域名。	example.com
Path	string	路径	/test
CookieName	string	自定义 Cookie 名称。	__aliwaitingroom_example
TotalActiveUsers	string	活跃用户总数。	300
NewUsersPerMinute	string	每分钟新用户数。	200
SessionDuration	string	会话持续时间，单位是分钟。	3600
DisableSessionRenewalEnable	string	禁用会话续订。支持： on：开启。 off：关闭。	on
QueuingMethod	string	排队方式。取值： random：随机。 fifo：先进先出。 passthrough：直通。 reject-all：拒绝全部。	random
QueuingStatusCode	string	等候室状态码。取值： 200 202 429	200
JsonResponseEnable	string	JSON 响应。开启后 accept 请求头包含"application/json"会返回 json 数据。取值： on：开启。 off：关闭。	on
Description	string	等候室描述。	测试等候室
WaitingRoomType	string	等候室类型，支持： default：表示默认类型。 custom：表示自定义类型。	default
CustomPageHtml	string	自定义排队页面的 HTML 内容或标识符，仅当`WaitingRoomType`为`custom`时有效。传入的内容需要经过 URL 编码。	自定义HTML内容或标识
Language	string	等候室页面的语言，当等候室类型为默认类型时，需要传入。支持以下类型： enus：英文。 zhcn：中文简体。 zhhk：中文繁体。	zhcn

示例

正常返回示例

JSON格式

        

          
      
        
{
  "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"
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述

HTTP status code	错误码	错误信息	描述
400	InternalException	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.	指定的站点不存在或当前未被系统识别。请检查站点标识符是否准确，并确保它与一个已定义、当前活跃且在系统公认的站点网络中可访问的站点相匹配。如果该站点是预定新增的，请确保已完成适当的创建或注册流程，以将其整合到系统中。

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作

变更时间	变更内容概要	操作
2024-09-18	OpenAPI 错误码发生变更	查看变更详情