All Products
Search

This Product

    ApsaraVideo Live:DescribeLivePullToPush

    Document Center

    ApsaraVideo Live:DescribeLivePullToPush

    Last Updated:Jun 22, 2026

    Memanggil DescribeLivePullToPush untuk mengkueri tugas aliran tarik-ke-dorong.

    Deskripsi operasi

    • Panggil Operasi API ini untuk mengkueri tugas aliran tarik-ke-dorong.

    • Mendukung pengkuerian informasi konfigurasi dan informasi status Tugas dengan ID tertentu.

    Batas QPS

    Batas QPS pengguna tunggal untuk API ini adalah 10 panggilan per detik. Melebihi batas akan mengakibatkan Pembatasan kecepatan API, yang dapat memengaruhi bisnis Anda. Panggil API ini secara wajar.

    Coba sekarang

    Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

    Test

    RAM authorization

    Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

    • Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.

    • API: API yang dapat Anda panggil untuk melakukan aksi tersebut.

    • Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.

    • Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.

      • Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.

      • Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.

    • Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.

    • Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    live:DescribeLivePullToPush

    get

    *All Resource

    *

    		 None None

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    No

    ID wilayah.

    cn-shanghai
    TaskId

    string

    Yes

    ID tugas.

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

    string

    Yes

    Wilayah tempat tugas diluncurkan. Nilai valid:

    • ap-southeast-1 (Singapura)

    • ap-southeast-5 (Indonesia)

    • cn-beijing (Beijing)

    • cn-shanghai (Shanghai).

    Valid values:

    • cn-shenzhen :

      Shenzhen.

    • cn-qingdao :

      Qingdao.

    • preregion :

      Pra-rilis.

    • cn-beijing :

      Beijing.

    • cn-shanghai :

      Shanghai.

    • ap-southeast-1 :

      Singapura.

    • eu-central-1 :

      Jerman (Frankfurt).

    • ap-northeast-1 :

      Jepang (Tokyo).

    • ap-southeast-5 :

      Indonesia.

    • me-central-1 :

      Arab Saudi (Riyadh).

    cn-shanghai

    Elemen respons

    Element

    Type

    Description

    Example

    object

    Skema Tanggapan.

    RequestId

    string

    ID permintaan.

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

    integer

    Kode pengembalian.

    Catatan

    • "0" dikembalikan dalam keadaan Normal.

    • Untuk kasus abnormal, lihat daftar kode kesalahan di bawah ini.

    0
    Description

    string

    Deskripsi kesalahan.

    OK
    TaskId

    string

    ID tugas yang baru dibuat.

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

    integer

    Status Tugas saat ini:

    • 0: Belum dimulai (pengatur waktu mulai belum tercapai).

    • 1: Berjalan normal (aliran tarik dan aliran dorong normal).

    • 2: Berjalan abnormal.

    • 3: Dihentikan (aliran tarik atau aliran dorong abnormal, atau Tugas dihentikan secara aktif dengan memanggil API).

    • -1: Keluar.

    0
    TaskInvalidReason

    string

    Alasan tugas berhenti berjalan:

    • PullStreamFailed: Pengecualian tarik aliran sumber, mencoba ulang.

    • PushStreamFailed: Pengecualian dorong aliran tujuan, mencoba ulang.

    • UnknownError: Pengecualian tidak diketahui.

    Catatan

    Hanya dikembalikan ketika tugas berada dalam status dihentikan.

    PullStreamFailed
    TaskExitTime

    integer

    Waktu keluar Tugas, dalam stempel waktu detik Unix.

    Catatan

    Hanya dikembalikan ketika Tugas berada dalam status keluar.

    1726354625
    TaskExitReason

    string

    Alasan keluar Tugas:

    • TriggerByUser: Diakhiri secara aktif oleh pengguna.

    • OverEndTime: Melebihi waktu akhir yang telah ditetapkan.

    Catatan

    Hanya dikembalikan ketika Tugas berada dalam status keluar.

    TriggerByUser
    CurrentOffset

    integer

    Offset pemutaran video yang berlaku saat ini.

    0
    CurrentFileIndex

    integer

    Offset urutan daftar putar yang berlaku saat ini.

    0
    TaskInfo

    object

    Informasi Tugas.

    TaskId

    string

    ID tugas.

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

    string

    Nama tugas.

    test
    StartTime

    string

    Waktu mulai Tugas. Format: yyyy-MM-ddTHH:mm:ssZ (waktu UTC).

    2024-08-26T10:30:00Z
    EndTime

    string

    Waktu akhir Tugas. Format: yyyy-MM-ddTHH:mm:ssZ (waktu UTC).

    2024-08-27T14:30:00Z
    SourceType

    string

    Tipe aliran sumber. Nilai valid:

    • live: Aliran langsung.

    • vod: Sumber daya VOD Alibaba Cloud.

    • url: Sumber daya file video pihak ketiga.

    vod
    SourceProtocol

    string

    Nama protokol aliran sumber.

    RTMP
    SourceUrls

    array

    Alamat URL aliran sumber.

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

    string

    Alamat URL aliran sumber.

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

    string

    Alamat tujuan dorong aliran.

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

    string

    URL callback HTTP.

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

    integer

    Offset awal, yaitu nilai Offset awal untuk file video. Unit: detik. Nilai: lebih besar dari 0.

    Catatan

    • Menunjukkan mulai membaca dari posisi Offset relatif terhadap frame pertama.

    • Hanya berlaku untuk Sumber daya VOD atau file video.

    0
    FileIndex

    integer

    Indeks file, memulai pemutaran dari file ke-n.

    0
    RetryCount

    integer

    Jumlah percobaan ulang.

    3
    RetryInterval

    integer

    Interval percobaan ulang, dalam detik.

    60
    RepeatNumber

    integer

    Jumlah pengulangan pemutaran setelah selesai. Nilai valid:

    • 0 (default): Tidak ada pengulangan pemutaran.

    • -1: Loop tanpa batas.

    • Bilangan bulat positif lainnya: Jumlah pengulangan pemutaran setelah selesai.

    Catatan

    Parameter ini hanya berlaku untuk aliran VOD atau video pihak ketiga.

    0

    Contoh

    Respons sukses

    JSONformat

    {
  "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
  }
}

    Kode kesalahan

    HTTP status code

    Error code

    Error message

    Description
    400 InvalidParameter %s. Kesalahan parameter
    400 CodeInvalidAliUid Aliuid ini tidak memiliki nama domain live. Aliuid ini tidak memiliki nama domain live.
    400 CodeTaskNotExist Tugas tidak ada. Tugas tidak ada.
    500 InternalError %s. kesalahan pada server liveapi live.

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.