AI 助理
备案控制台
首页 边缘安全加速 边缘安全加速 ESA 开发参考 API参考 API目录 流量 等候室 ListWaitingRoomEvents - 查询等候室事件列表

ListWaitingRoomEvents - 查询等候室事件列表

更新时间: 2024-12-26 16:47:57

查询等候室的等候室事件详情。

接口说明

通过此接口，您可以查询指定站点 ID 和等候室 ID 下所有相关的等候室事件详情。

调试

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

授权信息

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

  • 操作：是指具体的权限点。
  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
    • 对于必选的资源类型，用背景高亮的方式表示。
    • 对于不支持资源级授权的操作，用全部资源表示。
  • 条件关键字：是指云产品自身定义的条件关键字。
  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
操作访问级别资源类型条件关键字关联操作
esa:ListWaitingRoomEventslist
*Site
acs:esa:{#regionId}:{#accountId}:site/{#SiteId}
    无
无

请求参数

名称类型必填描述示例值
SiteIdlong是

站点 ID，可通过调用 ListSites 接口获取。

7096621098****
WaitingRoomIdstring是

等候室 ID，用于标识特定的等候室。可通过调用 ListWaitingRooms 接口获取。

6a51d5bc6460887abd129****
WaitingRoomEventIdlong否

等候室事件 ID，可选参数，用于查询特定等候室事件。

89677721098****

返回参数

名称类型描述示例值
object

查询结果响应体。

RequestIdstring

请求 ID，用于追踪调用情况。

f3c3700a-4c0f-4a24-b576-fd7dbf9e7c55
WaitingRoomEventsarray<object>

等候室事件列表，包含每个事件的具体信息。

Itemobject

等候室事件详情。

WaitingRoomEventIdlong

事件 ID，唯一标识一个等候室事件。

89677721098****
WaitingRoomIdstring

关联的等候室 ID。

5c938a045c9ca46607163d34966****
Enablestring

事件启用状态。

  • on ：表示启用。
  • off：表示禁用。
on
Namestring

事件名称，自定义的事件描述。

测试事件
TotalActiveUsersstring

活动用户总数。

22
NewUsersPerMinutestring

每分钟新增用户数。

11
SessionDurationstring

会话持续时间（单位：分钟）。

3
DisableSessionRenewalEnablestring

禁用会话续订。支持：

  • on：开启。
  • off：关闭。
off
QueuingMethodstring

排队方式。取值：

  • random：随机。
  • fifo：先进先出。
  • passthrough：直通。
  • reject-all：拒绝全部。
fifo
QueuingStatusCodestring

等候室状态码。取值：

  • 200
  • 202
  • 429
200
JsonResponseEnablestring

JSON 响应。开启后 accept 请求头包含"application/json"会返回 JSON 数据。取值：

  • on：开启。
  • off：关闭。
off
Descriptionstring

事件的详细描述。

terraform-example
WaitingRoomTypestring

等候室类型。支持以下类型：

  • default：默认类型。
  • custom：自定义类型。
custom
CustomPageHtmlstring

用户自定义等候室页面内容，当等候室类型为自定义类型时，需要传入。传入的内容需要经过 URL 编码。

html-yets-maqi1111
StartTimestring

事件开始时间（Unix 时间戳）。

1719814398
EndTimestring

事件结束时间（Unix 时间戳）。

1719814497
PreQueueEnablestring

预排队开关。

  • on：开启。
  • off：关闭。
on
PreQueueStartTimestring

预排队开始时间（Unix 时间戳），若开启预排队功能则有效。

1719814097
RandomPreQueueEnablestring

随机排队开关。

  • on：开启。
  • off：关闭。
on
Languagestring

等候室页面的语言，当等候室类型为默认类型时，需要传入。支持以下类型：

  • enus：英文。
  • zhcn：中文简体。
  • zhhk：中文繁体。
zhcn

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400InternalExceptionFailed to call the service. Try again later or contact technical support.调用服务失败，请稍后重试或联系客服咨询详情。
403Site.NotExistThe 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-18OpenAPI 错误码发生变更查看变更详情
上一篇: ListWaitingRoomRules - 查询等候室绕过规则列表 下一篇: DeleteWaitingRoomRule - 删除等候室绕过规则