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

Consulta as informações de todos os streams ativos em um nome de domínio especificado ou em um aplicativo especificado sob um nome de domínio.

Descrição da operação

Esta operação suporta os seguintes tipos de stream:

all: Consulta todos os streams.
raw: Consulta streams originais.
trans: Consulta streams transcodificados.

Limite de QPS

O limite de QPS para um único usuário é de 10.000 chamadas por minuto. Se o limite for excedido, as chamadas de API serão limitadas, o que pode afetar seu negócio. Chame esta operação com 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:DescribeLiveStreamsOnlineList

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 do transmissor. Nota Ao especificar DomainName, certifique-se de que o nome de domínio seja um nome de domínio de transmissão ao vivo e de que você tenha as permissões para gerenciar o nome de domínio.	example.com
AppName	string	Não	O nome do aplicativo ao qual o stream pertence. Você pode visualizar o AppName na página Gerenciamento de Streams.	liveApp****
StreamName	string	Não	O nome do stream. Apenas um único StreamName pode ser especificado. Você pode visualizar o StreamName na página Gerenciamento de Streams.	liveStream****
OnlyStream	string	Não	Especifica se devem ser retornados apenas os campos especificados. Valores válidos: yes: Apenas os campos DomainName, AppName, StreamName e PublishTime são retornados. no (padrão): Todos os campos são retornados.	no
PageSize	integer	Não	O número de entradas por página. Valores válidos: 1 a 3000. Valor padrão: 2000.	1500
PageNum	integer	Não	O número da página. Valor padrão: 1.	1
StreamType	string	Não	O tipo de stream. Valores válidos: all (padrão): todos os streams. raw: streams originais. trans: streams transcodificados. Valores válidos: all : todos os streams. raw : streams originais. trans : streams transcodificados.	all
QueryType	string	Não	Especifica se deve ser usada correspondência aproximada para o nome do stream. Valores válidos: fuzzy (padrão): correspondência aproximada. strict: correspondência exata. Valores válidos: strict : correspondência exata. fuzzy : correspondência aproximada.	fuzzy

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	As informações do stream ativo.
RequestId	string	O ID da solicitação.	5c6a2a0df228-4a64- af62-20e91b9676b3
TotalPage	integer	O número total de páginas.	2
PageNum	integer	O número da página.	1
PageSize	integer	O número de entradas por página.	10
TotalNum	integer	O número total de entradas que atendem às condições especificadas.	11
OnlineInfo	object
LiveStreamOnlineInfo	array<object>	As informações sobre os streams que estão sendo ingeridos.
	object	As informações sobre os streams que estão sendo ingeridos.
AudioDataRate	integer	The audio bitrate of the live stream. Unit: Kbps. Nota This parameter is available only after you submit a ticket to enable the whitelist configuration. For more information about how to submit a ticket, see Contact Us.	600
FrameRate	integer	The frame rate. Unit: FPS.	15
PublishUrl	string	The full ingest URL.	rtmp://demo.aliyundoc.com/live/test****
StreamName	string	The stream name.	liveStream****
AudioCodecId	integer	The audio codec ID.	10
Height	integer	The height of the video resolution. Unit: pixel.	720
VideoDataRate	integer	The video bitrate of the live stream. Unit: Kbps. Nota This parameter is available only after you submit a ticket to enable the whitelist configuration. For more information about how to submit a ticket, see Contact Us.	600
DomainName	string	The streaming domain of the streamer.	example.com
PublishDomain	string	The ingest domain. If you use live center ingest, you can directly specify the streaming domain.	demo.aliyundoc.com
PublishTime	string	The time when stream ingest started. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).	2021-08-09T02:37:59Z
AppName	string	The name of the application to which the stream belongs.	liveApp****
PublishType	string	The ingest type. Valid values: edge: edge ingest. center: live center ingest.	edge
VideoCodecId	integer	The video codec ID.	7
Transcoded	string	Indicates whether the stream is a transcoded stream. Valid values: yes: The stream is a transcoded stream. no: The stream is not a transcoded stream.	no
Width	integer	The width of the video resolution. Unit: pixel.	1280
ClientIp	string	The IP address of the ingest client.	106.11.XX.XX
ServerIp	string	The IP address of the ingest node.	120.221.XX.XX

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "5c6a2a0df228-4a64- af62-20e91b9676b3",
  "TotalPage": 2,
  "PageNum": 1,
  "PageSize": 10,
  "TotalNum": 11,
  "OnlineInfo": {
    "LiveStreamOnlineInfo": [
      {
        "AudioDataRate": 600,
        "FrameRate": 15,
        "PublishUrl": "rtmp://demo.aliyundoc.com/live/test****",
        "StreamName": "liveStream****",
        "AudioCodecId": 10,
        "Height": 720,
        "VideoDataRate": 600,
        "DomainName": "example.com",
        "PublishDomain": "demo.aliyundoc.com",
        "PublishTime": "2021-08-09T02:37:59Z",
        "AppName": "liveApp****",
        "PublishType": "edge",
        "VideoCodecId": 7,
        "Transcoded": "no",
        "Width": 1280,
        "ClientIp": "106.11.XX.XX",
        "ServerIp": "120.221.XX.XX"
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro
400	QpsOverLimit	Qps is over limit for this domainName.
400	InvalidStartTime.Malformed	Specified StartTime is malformed.
400	InvalidEndTime.Malformed	Specified EndTime is malformed.
400	InvalidEndTime.Mismatch	Specified end time does not match the specified start time.
400	Duration.Exceed	Duration between StartTime and EndTime is too long.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.