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

Descrição da operação

Os dados retornados por esta operação têm um atraso médio de 2 a 5 minutos.
Esta operação consulta o número de usuários online históricos apenas para streams Flash Video (FLV) e Real-Time Messaging Protocol (RTMP).
Esta operação não consulta o número de espectadores que estão assistindo a streams transcodificados.

Limite de QPS

Você pode chamar esta operação até 30 vezes por segundo por conta. As solicitações que excederem esse limite serão descartadas e você sofrerá interrupções no serviço. Recomendamos que você observe esse limite ao chamar esta operação.

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

get

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
DomainName	string	Sim	O domínio de streaming.	example.com
AppName	string	Sim	O nome do aplicativo ao qual a transmissão ao vivo pertence. Você pode visualizar o nome do aplicativo na página Gerenciamento de Streams do console do ApsaraVideo Live.	liveApp****
StreamName	string	Sim	O nome da transmissão ao vivo. Você pode visualizar o nome da transmissão na página Gerenciamento de Streams do console do ApsaraVideo Live.	liveStream****
StartTime	string	Sim	O início do intervalo de tempo a ser consultado. Especifique o horário no padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ. O horário deve estar em UTC. Nota Você pode consultar dados dos últimos 30 dias.	2017-12-21T08:00:00Z
EndTime	string	Sim	O fim do intervalo de tempo a ser consultado. O horário de término deve ser posterior ao horário de início. Especifique o horário no padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ. O horário deve estar em UTC. Nota O intervalo de tempo especificado pelos parâmetros StartTime e EndTime não pode exceder um dia. O horário de término não deve ser posterior ao horário atual.	2017-12-22T08:00:00Z

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	16A96B9A-F203-4EC5-8E43-CB92E68F5FF8
LiveStreamUserNumInfos	object
LiveStreamUserNumInfo	array<object>	O número de usuários online históricos da transmissão ao vivo.
	object
UserNum	string	The number of users at the current point in time.	1
StreamTime	string	The time when the stream started. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2017-10-20T06:20:00Z

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F5FF8",
  "LiveStreamUserNumInfos": {
    "LiveStreamUserNumInfo": [
      {
        "UserNum": "1",
        "StreamTime": "2017-10-20T06:20:00Z"
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro
400	InvalidStartTime.Malformed	Specified StartTime is malformed.
400	InvalidEndTime.Malformed	Specified EndTime is malformed.
400	InvalidEndTime.Mismatch	Specified end time does not math the specified start time or current time.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.