Consulta usuários online em um canal.
Descrição da operação
Esta operação consulta os usuários online em um canal. O resultado não inclui detalhes sobre esses usuários.
Limite de QPS
Você pode chamar esta operação até 100 vezes por segundo por conta. Solicitações que excedem esse limite são descartadas, o que pode causar interrupções no serviço. Considere essa restrição ao chamar esta API.
Depuração
Informações de autorização
A tabela a seguir apresenta as informações de autorização correspondentes à API. Use essas informações no elemento de política Action para conceder permissões de chamada desta operação a um usuário ou função do RAM. Detalhes:
Operação: valor usado no elemento Action para especificar a ação sobre um recurso.
Nível de acesso: tipo de acesso da operação (leitura, gravação ou listagem).
-
Tipo de recurso: recurso no qual o usuário ou função do RAM recebe autorização para executar a operação. Observe os seguintes pontos:
Tipos de recursos obrigatórios são indicados pelo prefixo * .
Se não for possível conceder permissões no nível do recurso, a coluna Tipo de recurso da operação exibirá
All Resources.
Chave de condição: chave definida pelo serviço de nuvem.
Operação associada: outras operações que exigem permissão prévia do usuário ou função do RAM. Para concluir a operação principal, o usuário ou função deve ter permissão também para executar as operações associadas.
| Operação | Nível de acesso | Tipo de recurso | Chave de condição | Operação associada |
|---|---|---|---|---|
| live:DescribeChannelParticipants | none | *Domain acs:live:*:{#accountId}:domain/{#DomainName} |
| none |
Parâmetros da solicitação
| Parâmetro | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|
| AppId | string | Sim | ID do aplicativo. Especifique apenas um ID de aplicativo. | aec**** |
| ChannelId | string | Sim | ID do canal. Especifique apenas um ID de canal. | testId |
| PageNum | integer | Não | Número da página a ser retornada. Valor padrão: 1. | 1 |
| PageSize | integer | Não | Número de entradas a serem retornadas em cada página. Valor padrão: 10. | 10 |
| Order | string | Não | Ordem de classificação. Valores válidos:
| asc |
Parâmetros de resposta
|
Parâmetro |
Tipo |
Descrição |
Exemplo |
|
object |
Schema da resposta |
||
|
RequestId |
string |
ID da solicitação. |
6159ba01-6687-4fb2-a831-f0cd8d188648 |
|
Times |
long |
Tempo decorrido até o retorno do resultado. Unidade: segundos. O valor é um timestamp UNIX. |
1557909133 |
|
TotalNum |
integer |
Número total de entradas retornadas. |
3 |
|
TotalPage |
integer |
Número da página retornada. |
1 |
|
UserList |
array |
Lista de IDs de usuários. |
|
|
Users |
string |
IDs dos usuários no canal. Vários IDs são separados por vírgulas (,). |
27f9**,bb87,df82** |
Exemplos
Exemplo de resposta de sucesso
Formato JSON
{
"RequestId": "6159ba01-6687-4fb2-a831-f0cd8d188648",
"Times": 1557909133,
"TotalNum": 3,
"TotalPage": 1,
"UserList": [
"27f9**,bb87,df82**"
]
}
Códigos de erro
Para obter uma lista completa de códigos de erro, consulte os Códigos de erro do serviço.
Histórico de alterações
|
Data da alteração |
Resumo das alterações |
Operação |
|
2024-06-13 |
A configuração interna da API foi alterada, mas a chamada não foi afetada |