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

Consulta dados em lote no nível de stream para um domínio de streaming especificado. Múltiplos protocolos são suportados.

Descrição da operação

Nota

A consulta de novas conexões para o protocolo HLS não é suportada. As conexões simultâneas para HLS são contabilizadas com base em solicitações no formato padrão. Solicitações em formatos especiais requerem configuração por envio de ticket. Os formatos padrão são os seguintes:

Exemplo de solicitação m3u8: http(s)://example.aliyundoc.com/Appname/ StreamName.m3u8
Exemplo de solicitação ts: http(s)://example.aliyundoc.com/Appname/ StreamName/153xxxxxxxx_137xxxxx.ts.

Configurações

Limite de consulta única: Um máximo de 5000 linhas de dados pode ser retornado por consulta.
Limite de consulta de nome de domínio: Apenas um único nome de domínio é suportado. Um erro é retornado se múltiplos nomes de domínio forem especificados.
Limite de intervalo de tempo: O intervalo máximo de consulta é de 24 horas.
Limite de granularidade de tempo: A granularidade mínima de consulta é de 1 minuto.
Limite de alcance de consulta: O alcance máximo de consulta é de 31 dias.
Limite de frequência de chamadas: A frequência máxima de chamadas por usuário é de 10 chamadas por segundo.
Combinação especial de parâmetros: Quando DomainName não está vazio e tanto AppName quanto StreamName estão definidos como all, os dados agregados para o domínio de streaming são retornados.

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

none

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
DomainName	string	Não	O domínio de streaming a ser consultado. Nota Apenas um único nome de domínio é suportado. Um erro é retornado se múltiplos nomes de domínio forem especificados. Se o nome de domínio estiver vazio, os dados agregados para todos os domínios de streaming do usuário serão consultados. Se `AppName` e `StreamName` não forem especificados, os dados no nível de stream para todos os streams sob o domínio serão retornados.	test.com
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.	2015-12-10T20: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 e a diferença não pode exceder 1 dia. Especifique o horário no padrão ISO 8601 no formato `YYYY-MM-DDThh:mm:ssZ`. O horário deve estar em UTC.	2015-12-10T21:00:00Z
AppName	string	Não	O nome da aplicação. Especifique o nome da aplicação para consultar dados no nível de stream para a aplicação correspondente. Se `StreamName` for especificado, `AppName` também deve ser especificado.	app
StreamName	string	Não	O nome do stream. Se `StreamName` for especificado, os dados no nível de stream para o `StreamName` especificado sob o `AppName` especificado serão retornados. Se `StreamName` for especificado, `AppName` também deve ser especificado.	test.flv
Protocol	string	Não	O nome do protocolo de stream. Especifique o nome do protocolo para consultar dados do protocolo correspondente. Protocolos suportados: `flv`, `hls`, `rtmp`, `rts`, `p2p`. Você pode consultar dados de múltiplos protocolos separando-os com vírgulas (,). Os dados de múltiplos protocolos não são agregados e são exibidos no nível de stream. Nota A opção rts consulta streams Real-Time Streaming (RTS) usando o protocolo ARTC. Ao usar rts, pode ser necessário contabilizar adicionalmente o stream de transcodificação xxx_AliRTS-opus. Isso ocorre porque, ao reproduzir um stream RTS na web, um stream de transcodificação com o sufixo _AliRTS-opus anexado ao nome do stream é gerado automaticamente, produzindo dados de stream de transcodificação. Para mais informações, consulte Transcodificação automática de latência sub-segundo RTS.	flv
PageNumber	integer	Sim	O número da página.	1
PageSize	integer	Sim	O número de entradas por página. Valor máximo: 5000.	10

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Schema da resposta.
DomainName	string	As informações do domínio de streaming.	test.com
EndTime	string	YYYY-MM-DDThh:mm:ssZ.	2015-12-10T21:00:00Z
PageSize	integer	O número de entradas por página.	10
RequestId	string	O ID da solicitação.	16A96B9A-F203-4EC5-8E43-CB92E68F****
StartTime	string	O início do intervalo de tempo consultado. O horário está no padrão ISO 8601 no formato `YYYY-MM-DDThh:mm:ssZ` em UTC.	2015-12-10T20:00:00Z
StreamDetailData	array<object>	Os dados de tráfego para cada intervalo de tempo.
	object	O grupo de dados retornado.
AppName	string	O nome da aplicação. Este valor é retornado independentemente de ter sido especificado ou não.	app
Bps	number	A largura de banda total por minuto para o stream, em bps.	423304182.66
Count	integer	O número total de conexões simultâneas por minuto para o stream. Nota Conexões simultâneas refere-se à contagem de conexões de processos de cliente ao mesmo stream dentro de uma unidade de tempo.	423304182
FlvBps	number	A largura de banda para o protocolo FLV, em bps. Este campo não é retornado se o protocolo especificado não corresponder.	454
FlvCount	integer	O número de conexões simultâneas para o protocolo FLV. Este campo não é retornado se o protocolo especificado não corresponder.	32
FlvTraffic	number	O tráfego para o protocolo FLV, em bytes. Este campo não é retornado se o protocolo especificado não corresponder.	1254
HlsBps	number	A largura de banda para o protocolo HLS, em bps. Este campo não é retornado se o protocolo especificado não corresponder.	4456
HlsCount	integer	O número de conexões simultâneas para o protocolo HLS. Este campo não é retornado se o protocolo especificado não corresponder.	56
HlsTraffic	number	O tráfego para o protocolo HLS, em bytes. Este campo não é retornado se o protocolo especificado não corresponder.	568
NewConns	integer	O número de novas conexões por minuto para o stream.	450
P2pBps	number	A largura de banda para o protocolo P2P, em bps. Este campo não é retornado se o protocolo especificado não corresponder.	6845
P2pCount	integer	O número de conexões simultâneas para o protocolo P2P. Este campo não é retornado se o protocolo especificado não corresponder.	78
P2pTraffic	number	O tráfego para o protocolo P2P, em bytes. Este campo não é retornado se o protocolo especificado não corresponder.	4102
RtmpBps	number	A largura de banda para o protocolo RTMP, em bps. Este campo não é retornado se o protocolo especificado não corresponder.	3323
RtmpCount	integer	O número de conexões simultâneas para o protocolo RTMP. Este campo não é retornado se o protocolo especificado não corresponder.	63
RtmpTraffic	number	O tráfego para o protocolo RTMP, em bytes. Este campo não é retornado se o protocolo especificado não corresponder.	5568
RtsBps	number	A largura de banda para o protocolo RTS, em bps. Este campo não é retornado se o protocolo especificado não corresponder.	2361
RtsCount	integer	O número de conexões simultâneas para o protocolo RTS. Este campo não é retornado se o protocolo especificado não corresponder.	89
RtsTraffic	number	O tráfego para o protocolo RTS, em bytes. Este campo não é retornado se o protocolo especificado não corresponder.	2322
StreamName	string	O nome do stream. Este valor é retornado independentemente de ter sido especificado ou não.	test.flv
TimeStamp	string	O horário de início do intervalo de tempo. O horário está no padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ em UTC+0.	2015-12-10T20:00:00Z
Traffic	number	O tráfego total por minuto para o stream, em bytes.	423304182
TotalCount	integer	O número total de entradas.	50
PageNumber	integer	O número da página.	1

Exemplos

Resposta de sucesso

JSON formato

{
  "DomainName": "test.com",
  "EndTime": "2015-12-10T21:00:00Z",
  "PageSize": 10,
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F****",
  "StartTime": "2015-12-10T20:00:00Z",
  "StreamDetailData": [
    {
      "AppName": "app",
      "Bps": 423304182.66,
      "Count": 423304182,
      "FlvBps": 454,
      "FlvCount": 32,
      "FlvTraffic": 1254,
      "HlsBps": 4456,
      "HlsCount": 56,
      "HlsTraffic": 568,
      "NewConns": 450,
      "P2pBps": 6845,
      "P2pCount": 78,
      "P2pTraffic": 4102,
      "RtmpBps": 3323,
      "RtmpCount": 63,
      "RtmpTraffic": 5568,
      "RtsBps": 2361,
      "RtsCount": 89,
      "RtsTraffic": 2322,
      "StreamName": "test.flv",
      "TimeStamp": "2015-12-10T20:00:00Z",
      "Traffic": 423304182
    }
  ],
  "TotalCount": 50,
  "PageNumber": 1
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro
400	Meter.ParamError	Param Error:%s,Please Check Again.
500	Meter.ServerInternalError	The Request Processing Has Failed Due To Some Unknown Error.
500	Meter.DataSourceQueryError	Data Source Error:%s,Please Try Again.
403	Meter.AuthError	Authentication Failed,Please Try Again.
502	Meter.ReadyTsError	Get ReadyTs Failed,Please Try Again.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.