Consulta os detalhes dos usuários online em um canal.
Descrição da operação
Use esta operação para consultar informações sobre usuários online em um canal, como o total de usuários durante uma transmissão ao vivo.
Limite de QPS
Esta operação permite até 100 chamadas por segundo por conta. O sistema descarta solicitações que excedem esse limite, o que pode causar interrupções no serviço. Considere essa restrição ao chamar esta operação.
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 a um usuário RAM ou função RAM as permissões necessárias para chamar esta operação da API. Descrição:
Operação: valor usado no elemento Action para especificar a ação sobre um recurso.
Nível de acesso: nível de acesso de cada operação. Os níveis incluem leitura, gravação e listagem.
-
Tipo de recurso: tipo de recurso no qual você autoriza o usuário RAM ou a função RAM a executar a operação. Observe os seguintes pontos:
Tipos de recursos obrigatórios são indicados com o prefixo * .
Se não for possível conceder permissões no nível do recurso, use
All Resourcesna coluna Tipo de recurso da operação.
Chave de condição: chave de condição definida pelo serviço de nuvem.
Operação associada: outras operações que exigem permissão do usuário RAM ou da função RAM para concluir a operação principal. Para finalizar a tarefa, é necessário ter permissões também nas operações associadas.
| Operação | Nível de acesso | Tipo de recurso | Chave de condição | Operação associada |
|---|---|---|---|---|
| live:DescribeChannelUsers | list | *Rtc acs:live::{#accountId}:rtc/{#AppId} |
| 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 por solicitação. |
aec**** |
|
ChannelId |
string |
Sim |
ID do canal. Especifique apenas um ID de canal por solicitação. |
testId |
Parâmetros de resposta
| Parâmetro | Tipo | Descrição | Exemplo |
|---|---|---|---|
| object | Esquema da resposta | ||
| RequestId | string | ID da solicitação. | AD86847D-1F36-18C8-A995-5EEA340B3202 |
| Timestamp | long | Carimbo de data/hora UTC do retorno da resposta. | 1691027655 |
| IsChannelExists | boolean | Indica se o canal existe. Valores válidos:
Nota
Após todos os usuários saírem do canal, o sistema leva alguns segundos para limpar o cache. Se você chamar a operação durante esse período, o valor deste parâmetro será true, enquanto InteractiveUserNumber e LiveUserNumber retornarão 0.
| true |
| InteractiveUserNumber | integer | Número de co-streamers. | 1 |
| LiveUserNumber | integer | Número de espectadores. | 1 |
| InteractiveUserList | array | Lista de streamers/co-streamers. | |
| InteractiveUser | string | Lista de usuários interativos. | aaa |
| LiveUserList | array | Lista de espectadores. | |
| LiveUser | string | Lista de espectadores (retorna até 1000 pessoas). | bbb |
Exemplos
Exemplos de respostas de sucesso
Formato JSON
{
"RequestId": "AD86847D-1F36-18C8-A995-5EEA340B3202",
"Timestamp": 1691027655,
"IsChannelExists": true,
"InteractiveUserNumber": 1,
"LiveUserNumber": 1,
"InteractiveUserList": [
"aaa"
],
"LiveUserList": [
"bbb"
]
}
Códigos de erro
|
Código de status HTTP |
Código de erro |
Mensagem de erro |
|
400 |
400 |
InvalidInput |
|
401 |
401 |
InvalidAuth |
|
404 |
404 |
AppOrChannelNotExists |
|
500 |
500 |
SystemError, Please Check App And Channel Exists, RETRY |
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 |
|
2023-08-31 |
O código de erro foi alterado |