Todos os produtos
Search
Central de documentação

ApsaraVideo Live:DescribeLivePullToPush

Última atualização: Jun 28, 2026

Consulta uma tarefa de streaming pull-to-push.

Descrição da operação

  • Chame esta operação de API para consultar uma tarefa de streaming pull-to-push.

  • Suporta a consulta das informações de configuração e informações de status de uma tarefa com um ID especificado.

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. Por favor, 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:DescribeLivePullToPush

get

*All Resource

*

Nenhuma 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

TaskId

string

Sim

O ID da tarefa.

fd245384-4067-4f91-9d75-9666a6bc****

Region

string

Sim

A região onde a tarefa é iniciada. 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

Elementos de resposta

Elemento

Tipo

Descrição

Exemplo

object

Schema da resposta.

RequestId

string

O ID da solicitação.

a05e6b15-15af-405b-a4a2-0152245d****

RetCode

integer

O código de retorno.

Nota
  • "0" é retornado em circunstâncias normais.

  • Para casos anormais, consulte a lista de códigos de erro abaixo.

0

Description

string

A descrição do erro.

OK

TaskId

string

O ID da tarefa recém-criada.

fb0d4ac7-c7e3-4978-9743-0bf2f6e8****

TaskStatus

integer

O 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 streaming e push streaming estão normais).

  • 2: Em execução anormal.

  • 3: Parada (pull streaming ou push streaming está anormal, ou a tarefa foi parada ativamente chamando a API).

  • -1: Encerrada.

0

TaskInvalidReason

string

O motivo pelo qual a tarefa parou de executar:

  • 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

O horário de encerramento da tarefa, em timestamp Unix em segundos.

Nota

Retornado apenas quando a tarefa está no estado encerrada.

1726354625

TaskExitReason

string

O 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

O offset de reprodução de vídeo atualmente em vigor.

0

CurrentFileIndex

integer

O offset de sequência da playlist atualmente em vigor.

0

TaskInfo

object

As informações da tarefa.

TaskId

string

O ID da tarefa.

fd245384-4067-4f91-9d75-9666a6bc9****

TaskName

string

O nome da tarefa.

test

StartTime

string

O horário de início da tarefa. Formato: yyyy-MM-ddTHH:mm:ssZ (horário UTC).

2024-08-26T10:30:00Z

EndTime

string

O horário de término da tarefa. Formato: yyyy-MM-ddTHH:mm:ssZ (horário UTC).

2024-08-27T14:30:00Z

SourceType

string

O tipo de stream de origem. Valores válidos:

  • live: Stream ao vivo.

  • vod: Recurso VOD do Alibaba Cloud.

  • url: Recurso de arquivo de vídeo de terceiros.

vod

SourceProtocol

string

O nome do protocolo do stream de origem.

RTMP

SourceUrls

array

Os endereços URL do stream de origem.

rtmp://pulltest.****.aliyunlive.com/pulltest493/pulltest-w434

string

O endereço URL do stream de origem.

rtmp://pulltest.****.aliyunlive.com/pulltest493/pulltest-w434

DstUrl

string

O endereço de destino do push stream.

rtmp://pushtest.********.aliyunlive.com/pulltest493/pulltest-w434

CallbackURL

string

A URL de callback HTTP.

https://callback*****.com

Offset

integer

O offset inicial, que é o valor de offset inicial para o arquivo de vídeo. Unidade: segundos. Valor: maior que 0.

Nota
  • Indica iniciar a leitura a partir de uma posição de offset relativa ao primeiro frame.

  • Válido apenas para recursos VOD ou arquivos de vídeo.

0

FileIndex

integer

O índice do arquivo, iniciando a reprodução a partir do enésimo arquivo.

0

RetryCount

integer

O número de tentativas.

3

RetryInterval

integer

O intervalo entre tentativas, em segundos.

60

RepeatNumber

integer

O número de vezes para repetir a reprodução após a conclusão. Valores válidos:

  • 0 (padrão): Sem repetição de reprodução.

  • -1: Loop indefinidamente.

  • Outros inteiros positivos: O número de vezes para repetir a reprodução após a conclusão.

Nota

Este parâmetro se aplica apenas a streams de VOD ou de vídeo de terceiros.

0

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "a05e6b15-15af-405b-a4a2-0152245d****",
  "RetCode": 0,
  "Description": "OK",
  "TaskId": "fb0d4ac7-c7e3-4978-9743-0bf2f6e8****",
  "TaskStatus": 0,
  "TaskInvalidReason": "PullStreamFailed",
  "TaskExitTime": 1726354625,
  "TaskExitReason": "TriggerByUser",
  "CurrentOffset": 0,
  "CurrentFileIndex": 0,
  "TaskInfo": {
    "TaskId": "fd245384-4067-4f91-9d75-9666a6bc9****",
    "TaskName": "test",
    "StartTime": "2024-08-26T10:30:00Z",
    "EndTime": "2024-08-27T14:30:00Z",
    "SourceType": "vod",
    "SourceProtocol": "RTMP",
    "SourceUrls": [
      "rtmp://pulltest.****.aliyunlive.com/pulltest493/pulltest-w434"
    ],
    "DstUrl": "rtmp://pushtest.********.aliyunlive.com/pulltest493/pulltest-w434",
    "CallbackURL": "https://callback*****.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 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.