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

Descrição da operação

Notas de uso

Esta operação suporta consultas em lote. Você pode consultar o status online de até 20 usuários por vez.

Limites de QPS

O limite de consultas por segundo (QPS) de usuário único para esta operação é de 100 vezes por segundo. Se você exceder esse limite, as chamadas de API serão limitadas, o que pode afetar seus negócios. Você deve fazer chamadas de API em uma frequência adequada. Para obter mais informações, consulte Limites de QPS.

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:BatchGetOnlineUsers

get

*Domain

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 de mensagens interativas.	a494caec-***-695ef345db77
GroupId	string	Sim	O ID do grupo de mensagens.	23wcaec-***695ef
UserIds	string	Sim	A lista de IDs de usuário. Separe vários IDs de usuário com vírgulas (,). Você pode especificar até 20 IDs de usuário.	de1a0,hu9

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros retornados.
RequestId	string	O ID da solicitação.	16A96B9A-****-CB92E68F4CD8
Result	object	O resultado retornado.
OnlineUsers	array<object>	A matriz de objetos.
	object
JoinTime	integer	The UTC timestamp when the user joined the message group. Unit: milliseconds	12**45
Online	boolean	Indicates whether the user is online. Valid values: true: The user is online. false: The user is offline.	true
UserId	string	The user ID.	de1**a0

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "16A96B9A-****-CB92E68F4CD8",
  "Result": {
    "OnlineUsers": [
      {
        "JoinTime": 0,
        "Online": true,
        "UserId": "de1**a0"
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
403	Forbidden	User not authorized to operate on the specified resource.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.