DescribeChannelParticipants - ApsaraVideo Live: Central de Documentação do Alibaba Cloud

Descrição da operação

Consulta a lista de usuários online em um canal. A resposta não inclui informações detalhadas do usuário.

Limite de QPS

O limite de QPS por usuário para esta operação é de 100 chamadas por segundo. Se esse limite for excedido, a chamada da API será limitada, o que pode afetar o seu negócio. Execute esta operação em uma frequência razoável.

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

live:DescribeChannelParticipants

none

*Domínio.

acs:live:*:{#accountId}:domain/{#DomainName}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
AppId	string	Sim	O ID do aplicativo. Há suporte apenas para um único ID.	aec****
ChannelId	string	Sim	O ID do canal a ser consultado. Há suporte apenas para um único ID.	testId
PageNum	integer	Não	O número da página. Valor padrão: 1.	1
PageSize	integer	Não	O número de usuários a serem exibidos por página. Valor padrão: 10.	10
Order	string	Não	A ordem de classificação. Valores válidos: asc: ordem crescente. desc (padrão): ordem decrescente.	asc

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Esquema da resposta.
RequestId	string	O ID da solicitação.	6159ba01-6687-4fb2-a831-f0cd8d1******
Times	integer	A hora em que o resultado é retornado. O valor é um carimbo de data/hora UNIX. Unidade: segundos.	1557909133
TotalNum	integer	O número total de resultados retornados.	3
TotalPage	integer	O número total de páginas retornadas.	1
UserList	array	A lista de IDs de usuário.
	string	A lista de IDs de usuário, separados por vírgulas (,).	27f9**,bb87,df82**

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "6159ba01-6687-4fb2-a831-f0cd8d1******",
  "Times": 1557909133,
  "TotalNum": 3,
  "TotalPage": 1,
  "UserList": [
    "27f9****,bb87****,df82****"
  ]
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
401	NoAuth	User not authorized to operate on the specified resource.	Você não está autorizado a chamar esta operação de API ou a operar no recurso especificado.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.