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

Consulta difusa para tarefas de pull-to-push de stream.

Descrição da operação

Chame esta API para consultar a lista de tarefas de pull-to-push de stream.
Suporta consulta paginada da lista de tarefas e busca difusa por ID da tarefa, nome da tarefa e URL de destino do push de stream.

Limite de QPS

O limite de QPS por usuário para esta API é de 10 chamadas por segundo. Exceder o limite resultará em throttling da API, o que pode afetar seus negócios. Chame esta API de forma adequada.

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

get

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Não	ID da região.	cn-shanghai
Region	string	Sim	Especifica o centro de live para consulta. Valores válidos: ap-southeast-1 (Singapura) ap-southeast-5 (Indonésia) cn-beijing (Pequim) cn-shanghai (Xangai) Valores válidos: cn-shenzhen : Shenzhen. cn-qingdao : Qingdao. preregion : Pré-lançamento. cn-beijing : Pequim. cn-shanghai : Xangai. ap-southeast-1 : Singapura. eu-central-1 : Alemanha-Frankfurt. ap-northeast-1 : Japão-Tóquio. ap-southeast-5 : Indonésia. me-central-1 : Arábia Saudita-Riad.	cn-shanghai
TaskId	string	Não	ID da tarefa. Busca difusa com base no ID da tarefa. Nota O ID da tarefa consiste em letras maiúsculas e minúsculas, dígitos, underscores e hifens (-), com no máximo 55 caracteres.	861009
TaskName	string	Não	Nome da tarefa. Busca difusa com base no nome da tarefa.	task
DstUrl	string	Não	URL de destino do push de stream. Busca difusa com base na URL de destino do push de stream.	rtmp://qd
PageNumber	integer	Não	Número da página. Nota O valor deste parâmetro deve ser maior que 0 e não pode exceder o valor máximo do tipo de dados Integer. Valor padrão: 1.	1
PageSize	integer	Não	Número de registros exibidos por página. Nota Valor padrão: 10. Intervalo de valores: [1, 100].	10

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Schema da resposta.
RequestId	string	ID da solicitação.	a05e6b15-15af-405b-a4a2-0152245*****
Total	integer	Número total de resultados da consulta.	3
PageNumber	integer	Número da página.	1
PageSize	integer	Número de registros da consulta por página.	10
TaskList	array<object>	Lista de informações das tarefas.
	array<object>	Lista de informações das tarefas.
TaskId	string	ID da tarefa.	fb0d4ac7-c7e3-4978-9743-0bf2f6e8****
TaskStatus	integer	Status atual da tarefa: 0: Não iniciada (o horário de início ainda não foi atingido). 1: Em execução normal (pull e push de stream estão normais). 2: Em execução anormal. 3: Parada (pull ou push de stream está anormal, ou a tarefa foi parada ativamente por meio de chamada à API). -1: Encerrada.	0
TaskInvalidReason	string	Motivo da parada da tarefa: PullStreamFailed: Exceção no pull do stream de origem, tentando novamente. PushStreamFailed: Exceção no push do stream de destino, tentando novamente. UnknownError: Exceção desconhecida. Nota Retornado apenas quando a tarefa está no estado parada.	PullStreamFailed
TaskExitTime	integer	Horário de encerramento da tarefa, timestamp Unix em segundos. Nota Retornado apenas quando a tarefa está no estado encerrada.	1726354625
TaskExitReason	string	Motivo do encerramento da tarefa: TriggerByUser: Encerrada ativamente pelo usuário. OverEndTime: Excedeu o horário de término predefinido. Nota Retornado apenas quando a tarefa está no estado encerrada.	TriggerByUser
CurrentOffset	integer	Offset de reprodução de vídeo atualmente em vigor.	0
CurrentFileIndex	integer	Offset de sequência da playlist atualmente em vigor.	0
TaskInfo	object	Informações da tarefa.
TaskId	string	Task ID.	fb0d4ac7-c7e3-4978-9743-0bf2f6e8****
TaskName	string	Task name.	taskname
StartTime	string	Task start time. Format: yyyy-MM-ddTHH:mm:ssZ (UTC time).	2024-12-04T09:16:00Z
EndTime	string	Task end time. Format: yyyy-MM-ddTHH:mm:ssZ (UTC time).	2024-12-30T14:30:00Z
SourceType	string	Source stream type. Valid values: live: Live stream. vod: Alibaba Cloud Video on Demand resource. url: Third-party video file resource.	vod
SourceProtocol	string	Source stream protocol name.	flv
SourceUrls	array	Source stream URL addresses.
	string	Source stream URL address.	rtmp://118.178.**.5:**/wwtestlive1/pulltest.jiugong.aliyunlive.com_livelight2?vhost=pulltest.jiugong.aliyun*****
DstUrl	string	Destination push stream URL.	rtmp://qd.push.lgg.alivecdn.com/testhsc/streamhsc?live_rtmp_*******
CallbackURL	string	HTTP callback URL.	hahaha.com
Offset	integer	Start offset, the starting offset value of the video file. Unit: seconds. Value: greater than 0. Nota Indicates the position to start reading from, relative to the first frame. Only valid for VOD resources or video files.	0
FileIndex	integer	File index, starts playback from the nth file.	0
RetryCount	integer	Number of retries.	3
RetryInterval	integer	Retry interval, in seconds.	60
RepeatNumber	integer	Number of times to repeat playback after completion. Valid values: 0 (default): No repeat playback. -1: Loop indefinitely. Other positive integers: Number of times to repeat playback after completion. Nota This parameter only applies to VOD or third-party video streams.	0

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "a05e6b15-15af-405b-a4a2-0152245*****",
  "Total": 3,
  "PageNumber": 1,
  "PageSize": 10,
  "TaskList": [
    {
      "TaskId": "fb0d4ac7-c7e3-4978-9743-0bf2f6e8****",
      "TaskStatus": 0,
      "TaskInvalidReason": "PullStreamFailed",
      "TaskExitTime": 1726354625,
      "TaskExitReason": "TriggerByUser",
      "CurrentOffset": 0,
      "CurrentFileIndex": 0,
      "TaskInfo": {
        "TaskId": "fb0d4ac7-c7e3-4978-9743-0bf2f6e8****",
        "TaskName": "taskname",
        "StartTime": "2024-12-04T09:16:00Z",
        "EndTime": "2024-12-30T14:30:00Z",
        "SourceType": "vod",
        "SourceProtocol": "flv",
        "SourceUrls": [
          "rtmp://118.178.***.*5:****/wwtestlive1/pulltest.jiugong.aliyunlive.com_livelight2?vhost=pulltest.jiugong.aliyun*******"
        ],
        "DstUrl": "rtmp://qd.push.lgg.alivecdn.com/testhsc/streamhsc?live_rtmp_*******",
        "CallbackURL": "hahaha.com",
        "Offset": 0,
        "FileIndex": 0,
        "RetryCount": 3,
        "RetryInterval": 60,
        "RepeatNumber": 0
      }
    }
  ]
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidParameter	%s.	Parameter error
400	LiveServiceNotFound	Your account does not open Live service yet	Your account has not yet activated ApsaraVideo Live.
400	CodeInvalidAliUid	This aliuid does not have a live domain name.	This aluid does not have a live domain name.
400	CodeTaskNotExist	Task does not exist.	The task does not exist.
500	InternalError	%s.	error on the live liveapi server.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.