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

Obtém o número de espectadores online para todos os streams ao vivo em um domínio especificado.

Descrição da operação

Esta API suporta apenas contagens de espectadores para streams FLV, RTS e RTMP. Streams HLS não são suportados. A coleta de dados possui um atraso. Para maior precisão, consulte dados com pelo menos 5 minutos de atraso.

Nota

Esta API substitui o endpoint descontinuado DescribeLiveStreamOnlineUserNum.

Limites de QPS

Você pode chamar esta operação até 200 vezes por minuto por conta. Solicitações que excederem esse limite serão descartadas e você poderá enfrentar interrupções no serviç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:DescribeLiveDomainOnlineUserNum

get

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Não	O ID da região.	cn-shanghai
DomainName	string	Sim	O domínio de streaming.	example.com
QueryTime	string	Não	O ponto no tempo a ser consultado. Especifique o horário no formato padrão ISO 8601 yyyy-MM-ddTHH:mm:ssZ. O horário deve estar em UTC.	2018-12-27T13:09:21Z

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	3A3A8C3D-F8B2-4FBF-9319-771A11B855FA
UserCount	integer	O número total de usuários online no ponto no tempo especificado no domínio especificado.	1
StreamCount	integer	O número de streams.	1
OnlineUserInfo	object
LiveStreamOnlineUserNumInfo	array<object>	As informações sobre os streams.
	array<object>
StreamName	string	The stream name.	rtmp://example.com/test/liveStream****_3_1
Infos	object
Info	array<object>	The stream statistics.
	object
UserNumber	integer	The number of viewers watching the transcoded stream or the original stream.	1
TranscodeTemplate	string	The transcoding template. A value of origin indicates that the stream is an original, non-transcoded stream.	origin

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "3A3A8C3D-F8B2-4FBF-9319-771A11B855FA",
  "UserCount": 1,
  "StreamCount": 1,
  "OnlineUserInfo": {
    "LiveStreamOnlineUserNumInfo": [
      {
        "StreamName": "rtmp://example.com/test/liveStream****_3_1",
        "Infos": {
          "Info": [
            {
              "UserNumber": 1,
              "TranscodeTemplate": "origin"
            }
          ]
        }
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InternalError	The request processing has failed due to backend service exception.
400	InvalidQueryTime.Exceed	QueryTime exceed three month.	The query time is more than three months from the current time.
400	InvalidQueryTime.Malformed	Specified QueryTime is malformed.	The specified query time is invalid.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.