Skip to content

WaitingRoomProps

Properties for defining a WaitingRoom.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-esa-waitingroom

Initializer

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkesa"
&alicloudroscdkesa.WaitingRoomProps {
    CookieName: interface{},
    HostNameAndPath: interface{},
    NewUsersPerMinute: interface{},
    QueuingMethod: interface{},
    QueuingStatusCode: interface{},
    SessionDuration: interface{},
    SiteId: interface{},
    Status: interface{},
    TotalActiveUsers: interface{},
    WaitingRoomName: interface{},
    WaitingRoomType: interface{},
    CustomPageHtml: interface{},
    Description: interface{},
    DisableSessionRenewalEnable: interface{},
    JsonResponseEnable: interface{},
    Language: interface{},
    QueueAllEnable: interface{},
}

Properties

Name Type Description
CookieName interface{} Property cookieName: The name of the custom cookie.
HostNameAndPath interface{} Property hostNameAndPath: The hostname and path.
NewUsersPerMinute interface{} Property newUsersPerMinute: The maximum number of new users per minute.
QueuingMethod interface{} Property queuingMethod: The queuing method.
QueuingStatusCode interface{} Property queuingStatusCode: Waiting room status code.
SessionDuration interface{} Property sessionDuration: The maximum duration for which a session remains valid after a user leaves the origin.
SiteId interface{} Property siteId: The site ID.
Status interface{} Property status: Waiting room enabled status.
TotalActiveUsers interface{} Property totalActiveUsers: The maximum number of active users.
WaitingRoomName interface{} Property waitingRoomName: The name of the waiting room.
WaitingRoomType interface{} Property waitingRoomType: The type of the waiting room, support: - default: Indicates the default type.
CustomPageHtml interface{} Property customPageHtml: User-defined waiting room page content, when the waiting room type is custom type, you need to enter.
Description interface{} Property description: Waiting room description.
DisableSessionRenewalEnable interface{} Property disableSessionRenewalEnable: Specifies whether to disable session renewal.
JsonResponseEnable interface{} Property jsonResponseEnable: The JSON response.
Language interface{} Property language: The language of the waiting room page.
QueueAllEnable interface{} Property queueAllEnable: Specifies whether to queue all requests.

CookieNameRequired

CookieName interface{}
  • Type: interface{}

Property cookieName: The name of the custom cookie.


HostNameAndPathRequired

HostNameAndPath interface{}
  • Type: interface{}

Property hostNameAndPath: The hostname and path.


NewUsersPerMinuteRequired

NewUsersPerMinute interface{}
  • Type: interface{}

Property newUsersPerMinute: The maximum number of new users per minute.


QueuingMethodRequired

QueuingMethod interface{}
  • Type: interface{}

Property queuingMethod: The queuing method.

Value:

  • 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.

QueuingStatusCodeRequired

QueuingStatusCode interface{}
  • Type: interface{}

Property queuingStatusCode: Waiting room status code.

Value:

  • 200
  • 202
  • 429.

SessionDurationRequired

SessionDuration interface{}
  • Type: interface{}

Property sessionDuration: The maximum duration for which a session remains valid after a user leaves the origin.

Unit: minutes.


SiteIdRequired

SiteId interface{}
  • Type: interface{}

Property siteId: The site ID.


StatusRequired

Status interface{}
  • Type: interface{}

Property status: Waiting room enabled status.

Value:

  • 'on': Enable waiting room
  • 'off': Disabled waiting room

TotalActiveUsersRequired

TotalActiveUsers interface{}
  • Type: interface{}

Property totalActiveUsers: The maximum number of active users.


WaitingRoomNameRequired

WaitingRoomName interface{}
  • Type: interface{}

Property waitingRoomName: The name of the waiting room.


WaitingRoomTypeRequired

WaitingRoomType interface{}
  • Type: interface{}

Property waitingRoomType: The type of the waiting room, support: - default: Indicates the default type.

  • custom: indicates a custom type.

CustomPageHtmlOptional

CustomPageHtml interface{}
  • Type: interface{}

Property customPageHtml: User-defined waiting room page content, when the waiting room type is custom type, you need to enter.

The incoming content needs to be base64 encoded.


DescriptionOptional

Description interface{}
  • Type: interface{}

Property description: Waiting room description.


DisableSessionRenewalEnableOptional

DisableSessionRenewalEnable interface{}
  • Type: interface{}

Property disableSessionRenewalEnable: Specifies whether to disable session renewal.

Value:

  • on: open.
  • off: closed.

JsonResponseEnableOptional

JsonResponseEnable interface{}
  • Type: interface{}

Property jsonResponseEnable: The JSON response.

If the accept request header contains "application/json", JSON data is returned. Value:

  • on: open.
  • off: closed.

LanguageOptional

Language interface{}
  • Type: interface{}

Property language: The language of the waiting room page.

When the waiting room type is the default type, it needs to be passed in. The following types are supported:

  • enus: English.
  • zhcn: Simplified Chinese.
  • zhhk: Traditional Chinese.

QueueAllEnableOptional

QueueAllEnable interface{}
  • Type: interface{}

Property queueAllEnable: Specifies whether to queue all requests.

Value:

  • on: open.
  • off: closed.