All Products
Search

This Product

    Edge Security Acceleration:CreateWaitingRoom

    Document Center

    Edge Security Acceleration:CreateWaitingRoom

    Last Updated:Jun 25, 2026

    Creates a waiting room for a website.

    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, which can be obtained by calling the ListSites operation.

    1234567890123
    Enable

    string

    Yes

    Specifies whether to enable the waiting room. Valid values:

    • on: Enabled.

    • off: Disabled.

    Valid values:

    • off :

      Disabled.

    • on :

      Enabled.

    on
    Name

    string

    Yes

    The name of the waiting room.

    waitingroom_example

    QueueAllEnable

    string

    No

    Specifies whether to queue all visitors. Valid values:

    • on: Enabled.

    • off: Disabled.

    Valid values:

    • off :

      Disabled.

    • on :

      Enabled.

    on
    HostNameAndPath

    array<object>

    Yes

    The hostname and path configurations.

    object

    Yes

    The hostname and path details.

    Subdomain

    string

    Yes

    The subdomain.

    test.
    Domain

    string

    Yes

    The domain name.

    example.com
    Path

    string

    Yes

    The path.

    /test
    CookieName

    string

    Yes

    The custom cookie name.

    __aliwaitingroom_example
    TotalActiveUsers

    string

    Yes

    The total number of active users.

    300
    NewUsersPerMinute

    string

    Yes

    The number of new users per minute.

    200
    SessionDuration

    string

    Yes

    The session duration, in minutes.

    5
    DisableSessionRenewalEnable

    string

    No

    Specifies whether to disable session renewal. Valid values:

    • on: Enabled.

    • off: Disabled.

    Valid values:

    • off :

      Disabled.

    • on :

      Enabled.

    on
    QueuingMethod

    string

    Yes

    The queuing method. Valid values:

    • random: Random.

    • fifo: First in, first out.

    • passthrough: Passthrough.

    • reject-all: Reject all.

    Valid values:

    • random :

      Random.

    • fifo :

      First in, first out.

    • passthrough :

      Passthrough.

    • reject-all :

      Reject all.

    fifo
    QueuingStatusCode

    string

    Yes

    The waiting room status code. Valid values:

    • 200

    • 202

    • 429.

    200
    JsonResponseEnable

    string

    No

    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.

    Valid values:

    • off :

      Disabled.

    • on :

      Enabled.

    on
    Description

    string

    No

    The description of the waiting room.

    test
    WaitingRoomType

    string

    Yes

    The type of the waiting room. Valid values:

    • default: Default type.

    • custom: Custom type.

    Valid values:

    • default :

      Default type.

    • custom :

      Custom type.

    default
    CustomPageHtml

    string

    No

    The custom waiting room page content. This parameter is required when the waiting room type is set to custom. The content must use Base64 encoding.

    SGVsbG8gd29ybGQ=
    Language

    string

    No

    The language of the waiting room page. This parameter is required when the waiting room type is set to default. Valid values:

    • enus: English.

    • zhcn: Simplified Chinese.

    • zhhk: Traditional Chinese.

    Valid values:

    • zhcn :

      Simplified Chinese.

    • enus :

      English.

    • zhhk :

      Traditional Chinese.

    enus

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The request ID.

    85H66C7B-671A-4297-9187-2C4477247A74
    WaitingRoomId

    string

    The waiting room ID.

    8527e8405ac25bfb7fb7ca0d12b0ed83

    Examples

    Success response

    JSON format

    {
  "RequestId": "85H66C7B-671A-4297-9187-2C4477247A74",
  "WaitingRoomId": "8527e8405ac25bfb7fb7ca0d12b0ed83"
}

    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.
    400 InvalidParameter.ArgName Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation. Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.
    400 InvalidParameter.ArgValue Invalid parameter value. Check whether the value format and length meet the requirements. Invalid parameter value. Check whether the value format and length meet the requirements.
    400 MissingParameter The specified ArgName is required for this function. When configuring a specific function, the required parameter is missing.
    400 CompileRuleError Rule compilation failed, please check the rule information passed in to ensure that the rule is written according to the syntax described in the document. Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.
    400 SiteConfigLengthExceedLimit The overall configuration size of the site exceeds the limit, and the total size of all functional configurations of the site cannot exceed 512K. The size of the site configuration exceeds the limit, and the total size cannot exceed 512K.
    400 ConfigConflicts Configuration conflicts, usually when multiple configurations are configured under the same function of the same site, such as duplicate rule names between multiple configurations. The parameter uniqueness check failed. Check for duplicate parameter values.
    400 FunctionConflict The feature configuration conflicts. Sites with version management enabled cannot configure this feature. The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.
    400 RuleRegexQuotaCheckFailed When configuring rules, rules with regular expressions are not allowed in this plan. Please check the relevant documentation of the plan or upgrade the plan. The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.
    400 NestedRuleQuotaCheckFailed The nesting level of rules allowed by the plan failed to be verified. Please modify the nesting level of rules or upgrade the plan. The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.
    400 ArgQuotaCheckFailed The passed-in parameter value failed to verify the validity of the plan. Please check the plan document to obtain the range of parameters that can be configured for the site plan. The current plan does not support the configuration of restricted parameters, please check the input parameters.
    400 FunctionQuotaCheckFailed The quota verification for this function fails. It may be that the configuration of this function exceeds the limit of the site plan. Please check the plan introduction document corresponding to this site. The current plan does not support the configuration of restricted functions, please check the plan related function description.
    400 ConfExceedLimit The number of function configurations exceeds the limit. Please check the interface document to see the number of configurations that can be supported by a single function. The number of configuration items for the current function has exceeded the upper limit set by the system.
    400 ServiceInvokeFailed The call to the internal service failed. The engineer is resolving the problem. Please wait a moment before trying, or contact customer service for details. Failed to call the service. Please try again later or contact customer service for details.
    400 Instance.NotOnline Your plan is unavailable due to an overdue payment. Complete the payment first. Your plan is unavailable due to an overdue payment. Complete the payment first.
    400 InstanceNotExist The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account. The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.
    400 LockFailed The system is handling requests you previously submitted. Try again later. The system is handling requests you previously submitted. Try again later.
    404 SiteNotFound The website does not exist or does not belong to you. The website does not exist or does not belong to you.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.