Todos os produtos
Search

Este produto

    Edge Security Acceleration:CreateWaitingRoom

    Central de documentação

    Edge Security Acceleration:CreateWaitingRoom

    Última atualização: Jun 29, 2026

    Cria uma sala de espera para um site.

    Experimente agora

    Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

    Testar

    Autorização RAM

    Nenhuma autorização necessária para esta operação. Se você encontrar problemas com esta operação, entre em contato com o suporte técnico.

    Parâmetros da solicitação

    Parâmetro

    Tipo

    Obrigatório

    Descrição

    Exemplo
    SiteId

    integer

    Sim

    O ID do site, que pode ser obtido chamando a operação ListSites.

    1234567890123
    Enable

    string

    Sim

    Especifica se a sala de espera deve ser ativada. Valores válidos:

    • on: Ativada.

    • off: Desativada.

    Valores válidos:

    • off :

      Desativada.

    • on :

      Ativada.

    on
    Name

    string

    Sim

    O nome da sala de espera.

    waitingroom_example

    QueueAllEnable

    string

    Não

    Especifica se todos os visitantes devem ser enfileirados. Valores válidos:

    • on: Ativado.

    • off: Desativado.

    Valores válidos:

    • off :

      Desativada.

    • on :

      Ativada.

    on
    HostNameAndPath

    array<object>

    Sim

    As configurações de hostname e caminho.

    object

    Sim

    Os detalhes de hostname e caminho.

    Subdomain

    string

    Sim

    O subdomínio.

    test.
    Domain

    string

    Sim

    O nome de domínio.

    example.com
    Path

    string

    Sim

    O caminho.

    /test
    CookieName

    string

    Sim

    O nome de cookie personalizado.

    __aliwaitingroom_example
    TotalActiveUsers

    string

    Sim

    O número total de usuários ativos.

    300
    NewUsersPerMinute

    string

    Sim

    O número de novos usuários por minuto.

    200
    SessionDuration

    string

    Sim

    A duração da sessão, em minutos.

    5
    DisableSessionRenewalEnable

    string

    Não

    Especifica se a renovação de sessão deve ser desativada. Valores válidos:

    • on: Ativado.

    • off: Desativado.

    Valores válidos:

    • off :

      Desativada.

    • on :

      Ativada.

    on
    QueuingMethod

    string

    Sim

    O método de enfileiramento. Valores válidos:

    • random: Aleatório.

    • fifo: Primeiro a entrar, primeiro a sair.

    • passthrough: Passthrough.

    • reject-all: Rejeitar todos.

    Valores válidos:

    • random :

      Aleatório.

    • fifo :

      Primeiro a entrar, primeiro a sair.

    • passthrough :

      Passthrough.

    • reject-all :

      Rejeitar todos.

    fifo
    QueuingStatusCode

    string

    Sim

    O código de status da sala de espera. Valores válidos:

    • 200

    • 202

    • 429.

    200
    JsonResponseEnable

    string

    Não

    Especifica se a resposta JSON deve ser ativada. Quando ativada, solicitações com um cabeçalho Accept contendo "application/json" retornam dados JSON. Valores válidos:

    • on: Ativado.

    • off: Desativado.

    Valores válidos:

    • off :

      Desativada.

    • on :

      Ativada.

    on
    Description

    string

    Não

    A descrição da sala de espera.

    test
    WaitingRoomType

    string

    Sim

    O tipo da sala de espera. Valores válidos:

    • default: Tipo padrão.

    • custom: Tipo personalizado.

    Valores válidos:

    • default :

      Tipo padrão.

    • custom :

      Tipo personalizado.

    default
    CustomPageHtml

    string

    Não

    O conteúdo da página personalizada da sala de espera. Este parâmetro é obrigatório quando o tipo da sala de espera é definido como custom. O conteúdo deve usar codificação Base64.

    SGVsbG8gd29ybGQ=
    Language

    string

    Não

    O idioma da página da sala de espera. Este parâmetro é obrigatório quando o tipo da sala de espera é definido como default. Valores válidos:

    • enus: Inglês.

    • zhcn: Chinês simplificado.

    • zhhk: Chinês tradicional.

    Valores válidos:

    • zhcn :

      Chinês simplificado.

    • enus :

      Inglês.

    • zhhk :

      Chinês tradicional.

    enus

    Elementos de resposta

    Elemento

    Tipo

    Descrição

    Exemplo

    object

    RequestId

    string

    O ID da solicitação.

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

    string

    O ID da sala de espera.

    8527e8405ac25bfb7fb7ca0d12b0ed83

    Exemplos

    Resposta de sucesso

    JSON formato

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

    Códigos de erro

    Código de status HTTP

    Código de erro

    Mensagem de erro

    Descrição
    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.

    Consulte Códigos de Erro para uma lista completa.

    Notas de versão

    Consulte Notas de Versão para uma lista completa.