All Products
Search

This Product

    Edge Security Acceleration:ListWaitingRoomEvents

    Document Center

    Edge Security Acceleration:ListWaitingRoomEvents

    Last Updated:Jul 13, 2026

    Queries the details of waiting room events for a waiting room.

    Operation description

    Queries the details of all waiting room events associated with a specified site ID and waiting room ID.

    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.

    7096621098****
    WaitingRoomId

    string

    Yes

    The waiting room ID, which identifies a specific waiting room. You can call the ListWaitingRooms operation to obtain the waiting room ID.

    6a51d5bc6460887abd129****
    WaitingRoomEventId

    integer

    No

    The waiting room event ID. This is an optional parameter used to query a specific waiting room event.

    89677721098****

    Response elements

    Element

    Type

    Description

    Example

    object

    The response body.

    RequestId

    string

    The request ID, which is used to trace the API call.

    f3c3700a-4c0f-4a24-b576-fd7dbf9e7c55
    WaitingRoomEvents

    array<object>

    The list of waiting room events, including the details of each event.

    object

    The waiting room event details.

    WaitingRoomEventId

    integer

    The event ID that uniquely identifies a waiting room event.

    89677721098****

    WaitingRoomId

    string

    The associated waiting room ID.

    5c938a045c9ca46607163d34966****
    Enable

    string

    The event status. Valid values:

    • on: Enabled.

    • off: Disabled.

    on
    Name

    string

    The event name, which is a custom description of the event.

    test event
    TotalActiveUsers

    string

    The total number of active users.

    22
    NewUsersPerMinute

    string

    The number of new users per minute.

    11
    SessionDuration

    string

    The session duration. Unit: minutes.

    3
    DisableSessionRenewalEnable

    string

    Specifies whether to disable session renewal. Valid values:

    • on: Enabled.

    • off: Disabled.

    off
    QueuingMethod

    string

    The queuing method. Valid values:

    • random: random.

    • fifo: first-in, first-out.

    • passthrough: passthrough.

    • reject-all: reject all.

    fifo
    QueuingStatusCode

    string

    The waiting room status code. Valid values:

    • 200

    • 202

    • 429

    200
    JsonResponseEnable

    string

    Specifies whether to enable JSON responses. When enabled, requests with an Accept header containing "application/json" return JSON data. Valid values:

    • on: Enabled.

    • off: Disabled.

    off
    Description

    string

    The detailed description of the event.

    terraform-example
    WaitingRoomType

    string

    The waiting room type. Valid values:

    • default: default type.

    • custom: custom type.

    custom
    CustomPageHtml

    string

    The custom waiting room page content. This parameter is required when the waiting room type is custom. The content must be URL-encoded.

    html-yets-maqi1111
    StartTime

    string

    The event start time (UNIX timestamp).

    1719814398
    EndTime

    string

    The event end time (UNIX timestamp).

    1719814497
    PreQueueEnable

    string

    Specifies whether to enable pre-queuing. Valid values:

    • on: Enabled.

    • off: Disabled.

    on
    PreQueueStartTime

    string

    The pre-queuing start time (UNIX timestamp). This parameter takes effect only when pre-queuing is enabled.

    1719814097
    RandomPreQueueEnable

    string

    Specifies whether to enable random pre-queuing. Valid values:

    • on: Enabled.

    • off: Disabled.

    on
    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": "f3c3700a-4c0f-4a24-b576-fd7dbf9e7c55",
  "WaitingRoomEvents": [
    {
      "WaitingRoomEventId": 0,
      "WaitingRoomId": "5c938a045c9ca46607163d34966****",
      "Enable": "on",
      "Name": "test event",
      "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"
    }
  ]
}

    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.