Consulta os detalhes dos eventos de sala de espera de uma sala de espera.
Descrição da operação
Consulta os detalhes de todos os eventos de sala de espera associados a um ID de site e um ID de sala de espera especificados.
Experimente agora
Testar
Autorização RAM
|
Ação |
Nível de acesso |
Tipo de recurso |
Chave de condição |
Ação dependente |
|
esa:ListWaitingRoomEvents |
none |
*Site.
|
Nenhuma | 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. |
7096621098**** |
| WaitingRoomId |
string |
Sim |
O ID da sala de espera, que identifica uma sala de espera específica. Você pode chamar a operação ListWaitingRooms para obter o ID da sala de espera. |
6a51d5bc6460887abd129**** |
| WaitingRoomEventId |
integer |
Não |
O ID do evento de sala de espera. Este é um parâmetro opcional usado para consultar um evento específico de sala de espera. |
89677721098**** |
Elementos de resposta
|
Elemento |
Tipo |
Descrição |
Exemplo |
|
object |
O corpo da resposta. |
||
| RequestId |
string |
O ID da solicitação, usado para rastrear a chamada da API. |
f3c3700a-4c0f-4a24-b576-fd7dbf9e7c55 |
| WaitingRoomEvents |
array<object> |
A lista de eventos de sala de espera, incluindo os detalhes de cada evento. |
|
|
object |
Os detalhes do evento de sala de espera. |
||
| WaitingRoomEventId |
integer |
O ID do evento que identifica exclusivamente um evento de sala de espera. |
89677721098**** |
| WaitingRoomId |
string |
O ID da sala de espera associada. |
5c938a045c9ca46607163d34966**** |
| Enable |
string |
O status do evento. Valores válidos:
|
on |
| Name |
string |
O nome do evento, que é uma descrição personalizada do evento. |
test event |
| TotalActiveUsers |
string |
O número total de usuários ativos. |
22 |
| NewUsersPerMinute |
string |
O número de novos usuários por minuto. |
11 |
| SessionDuration |
string |
A duração da sessão. Unidade: minutos. |
3 |
| DisableSessionRenewalEnable |
string |
Especifica se a renovação de sessão deve ser desativada. Valores válidos:
|
off |
| QueuingMethod |
string |
O método de enfileiramento. Valores válidos:
|
fifo |
| QueuingStatusCode |
string |
O código de status da sala de espera. Valores válidos:
|
200 |
| JsonResponseEnable |
string |
Especifica se as respostas JSON devem ser ativadas. Quando ativado, solicitações com um cabeçalho Accept contendo "application/json" retornam dados JSON. Valores válidos:
|
off |
| Description |
string |
A descrição detalhada do evento. |
terraform-example |
| WaitingRoomType |
string |
O tipo de sala de espera. Valores válidos:
|
custom |
| CustomPageHtml |
string |
O conteúdo da página personalizada da sala de espera. Este parâmetro é obrigatório quando o tipo de sala de espera é custom. O conteúdo deve estar codificado em URL. |
html-yets-maqi1111 |
| StartTime |
string |
A hora de início do evento (timestamp UNIX). |
1719814398 |
| EndTime |
string |
A hora de término do evento (timestamp UNIX). |
1719814497 |
| PreQueueEnable |
string |
Especifica se o pré-enfileiramento deve ser ativado. Valores válidos:
|
on |
| PreQueueStartTime |
string |
A hora de início do pré-enfileiramento (timestamp UNIX). Este parâmetro entra em vigor apenas quando o pré-enfileiramento está ativado. |
1719814097 |
| RandomPreQueueEnable |
string |
Especifica se o pré-enfileiramento aleatório deve ser ativado. Valores válidos:
|
on |
| 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:
|
zhcn |
Exemplos
Resposta de sucesso
JSON formato
{
"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"
}
]
}
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. | A chamada do serviço falhou. 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 de sites reconhecidos 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.