ListWaitingRooms - Edge Security Acceleration: Central de Documentação do Alibaba Cloud

Consulta os detalhes de todas as salas de espera configuradas para um site especificado.

Descrição da operação

Esta API permite consultar os detalhes de configuração de todas as salas de espera para um site especificado, incluindo o status de ativação, nome e regras de fila.

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

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

esa:ListWaitingRooms

list

*Site.

acs:esa:{#regionId}:{#accountId}:site/{#SiteId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
SiteId	integer	Sim	O ID do site. Você pode chamar a operação ListSites para obter o ID do site.	120876698010528
WaitingRoomId	string	Não	O ID da sala de espera. Especifique este parâmetro para consultar os detalhes de uma sala de espera específica.	6a51d5bc6460887abd1291dc7d4d****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A resposta da consulta.
RequestId	string	O ID da solicitação, usado para rastrear chamadas de API.	CB1A380B-09F0-41BB-A198-72F8FD6DA2FE
WaitingRooms	array<object>	A lista de salas de espera.
	array<object>	Os detalhes da sala de espera.
WaitingRoomId	string	O ID da sala de espera, que identifica exclusivamente uma sala de espera.	6a51d5bc6460887abd1291dc7d4d****
Enable	string	O status de ativação. Valores válidos: on: Ativado. off: Desativado.	on
Name	string	O nome da sala de espera.	Test waiting room
QueueAllEnable	string	Especifica se todos os visitantes devem ser colocados em fila. Valores válidos: on: Ativado. off: Desativado.	on
HostNameAndPath	array<object>	As configurações de nome de host e caminho.
	object	Os detalhes de nome de host e caminho.
Subdomain	string	O subdomínio.	test.
Domain	string	O nome de domínio.	example.com
Path	string	O caminho.	/test
CookieName	string	O nome do cookie personalizado.	__aliwaitingroom_example
TotalActiveUsers	string	O número total de usuários ativos.	300
NewUsersPerMinute	string	O número de novos usuários por minuto.	200
SessionDuration	string	A duração da sessão, em minutos.	3600
DisableSessionRenewalEnable	string	Especifica se a renovação de sessão deve ser desativada. Valores válidos: on: Ativado. off: Desativado.	on
QueuingMethod	string	O método de enfileiramento. Valores válidos: random: Aleatório. fifo: Primeiro a entrar, primeiro a sair. passthrough: Passagem direta. reject-all: Rejeitar todos.	random
QueuingStatusCode	string	O código de status da sala de espera. Valores válidos: 200 202 429	200
JsonResponseEnable	string	Especifica se a resposta JSON deve ser ativada. Quando ativado, solicitações com um cabeçalho Accept contendo "application/json" retornam dados JSON. Valores válidos: on: Ativado. off: Desativado.	on
Description	string	A descrição da sala de espera.	Test waiting room
WaitingRoomType	string	O tipo de sala de espera. Valores válidos: default: Tipo padrão. custom: Tipo personalizado.	default
CustomPageHtml	string	O conteúdo HTML ou identificador da página de fila personalizada. Este parâmetro é válido apenas quando WaitingRoomType está definido como custom. O conteúdo deve estar codificado em URL.	Custom HTML content
Language	string	O idioma da página da sala de espera. Este parâmetro é obrigatório quando o tipo de sala de espera é default. Valores válidos: enus: Inglês. zhcn: Chinês simplificado. zhhk: Chinês tradicional.	zhcn

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "CB1A380B-09F0-41BB-A198-72F8FD6DA2FE",
  "WaitingRooms": [
    {
      "WaitingRoomId": "6a51d5bc6460887abd1291dc7d4d****\n",
      "Enable": "on",
      "Name": "Test waiting room",
      "QueueAllEnable": "on",
      "HostNameAndPath": [
        {
          "Subdomain": "test.\n",
          "Domain": "example.com\n",
          "Path": "/test"
        }
      ],
      "CookieName": "__aliwaitingroom_example",
      "TotalActiveUsers": "300",
      "NewUsersPerMinute": "200",
      "SessionDuration": "3600",
      "DisableSessionRenewalEnable": "on",
      "QueuingMethod": "random",
      "QueuingStatusCode": "200",
      "JsonResponseEnable": "on",
      "Description": "Test waiting room",
      "WaitingRoomType": "default",
      "CustomPageHtml": "Custom HTML content",
      "Language": "zhcn"
    }
  ]
}

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.	Falha ao chamar o serviço. Tente novamente mais tarde ou entre em contato com o suporte ao cliente para obter detalhes.
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.	O site especificado não existe ou não é reconhecido atualmente pelo sistema. Verifique se o identificador do site está correto e corresponde a um site definido, atualmente ativo e acessível na rede do sistema. Se o site for destinado a ser recém-adicionado, garanta que o processo apropriado de criação ou registro tenha sido concluído para integrá-lo ao sistema.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.