All Products
Search

This Product

    ApsaraVideo VOD:GetPlayInfo

    Document Center

    ApsaraVideo VOD:GetPlayInfo

    Last Updated:Jul 21, 2026

    Mengambil URL pemutaran file audio atau video dengan menyediakan ID audio atau video, yang kemudian dapat diputar menggunakan Pemutar Video Apsara atau pemutar pihak ketiga seperti pemutar bawaan sistem, open-source, atau buatan sendiri.

    Deskripsi operasi

    • Sebelum menggunakan operasi ini, pastikan Anda sepenuhnya memahami metode penagihan dan harga ApsaraVideo VOD. Mengunduh langsung atau memutar video dari URL pemutaran ApsaraVideo VOD menimbulkan biaya lalu lintas keluar. Jika tidak ada nama domain yang dipercepat dikonfigurasi, lihat Penagihan lalu lintas keluar penyimpanan. Jika nama domain yang dipercepat dikonfigurasi, lihat Penagihan layanan akselerasi. Jika Anda telah mengaktifkan akselerasi transfer penyimpanan, mengunduh langsung atau memutar video dari URL pemutaran ApsaraVideo VOD juga menimbulkan biaya akselerasi unduhan. Untuk detail penagihan, lihat Penagihan akselerasi transfer penyimpanan.

    • Hanya video dalam status Normal (nilai bidang Status adalah Normal) yang dapat diputar. Untuk informasi lebih lanjut tentang deskripsi URL pemutaran dan batas penggunaan, lihat Pemutaran audio dan video.

    • Ketika jenis penyimpanan media adalah penyimpanan non-standar, atur bidang StorageClass dari parameter PlayConfig sesuai kebutuhan. Untuk detailnya, lihat PlayConfig.

    • Jika pemutaran video tidak normal, panggil operasi GetMezzanineInfo untuk memeriksa apakah informasi file sumber video benar.

    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

    vod:GetPlayInfo

    get

    *全部资源

    *

    		 None None

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    VideoId

    string

    No

    ID audio atau video. Hanya satu ID audio atau video yang didukung. Anda dapat memperoleh ID dengan menggunakan metode berikut:

    • Untuk file audio atau video yang diunggah melalui konsol, masuk ke Konsol ApsaraVideo VOD dan pilih File Media > Audio/Video untuk melihat ID audio atau video.

    • Saat mengunggah file audio atau video dengan memanggil operasi CreateUploadVideo, ID audio atau video adalah nilai dari parameter respons VideoId.

    • Setelah file audio atau video diunggah, panggil operasi SearchMedia untuk mengkueri ID audio atau video, yang merupakan nilai dari parameter respons VideoId.

    93ab850b4f654b6e91d24d81d44****
    Formats

    string

    No

    Format aliran media. Pisahkan beberapa format dengan koma (,). Nilai valid:

    • mp4

    • m3u8

    • mp3

    • flv

    • mpd

    Catatan

    • Secara default, aliran dalam semua format dikembalikan.

    • Format mpd dikembalikan hanya ketika format kontainer dash dikonfigurasi dalam template transkoding. Untuk informasi lebih lanjut, lihat Container: format kontainer.

    mp4,m3u8
    AuthTimeout

    integer

    No

    Periode validitas URL pemutaran. Unit: detik.

    • Jika OutputType diatur ke cdn:

      • URL pemutaran kedaluwarsa secara berkala hanya jika otentikasi URL diaktifkan. Jika tidak, URL berlaku permanen. Untuk informasi tentang cara mengaktifkan dan mengonfigurasi otentikasi URL, lihat Otentikasi URL.

      • Nilai minimum: 1.

      • Nilai maksimum: tanpa batas.

      • Nilai default: Jika parameter ini tidak ditentukan, periode validitas default yang dikonfigurasi dalam otentikasi URL digunakan.

    • Jika OutputType diatur ke oss:

      • URL pemutaran kedaluwarsa secara berkala hanya jika izin penyimpanan bersifat privat. Jika tidak, URL berlaku permanen.

      • Nilai minimum: 1.

      • Nilai maksimum: Untuk mengurangi risiko keamanan pada server asal, ketika file audio atau video disimpan di bucket sistem ApsaraVideo VOD, nilai maksimum adalah 604800 (7 hari). Ketika file audio atau video disimpan di bucket OSS Anda sendiri, nilai maksimum adalah 129600 (36 jam). Jika nilai maksimum tidak memenuhi persyaratan Anda, atur OutputType ke cdn dan konfigurasikan otentikasi URL untuk mengatur periode validitas yang lebih lama.

      • Nilai default: Jika parameter ini tidak ditentukan, nilai default adalah 3600.

    1800
    OutputType

    string

    No

    Jenis URL output. Nilai valid:

    • oss: URL back-to-origin.

    • cdn (default): URL yang dipercepat.

    cdn.
    StreamType

    string

    No

    Jenis aliran media. Pisahkan beberapa jenis dengan koma (,). Nilai valid:

    • video: video.

    • audio: audio.

    Secara default, aliran dari semua jenis dikembalikan.

    video.
    ReAuthInfo

    string

    No

    Parameter reotentikasi CDN. Nilainya adalah string JSON. Ketika penandatanganan tipe A diaktifkan untuk otentikasi URL, Anda dapat menggunakan parameter ini untuk mengatur uid dan rand dari URL otentikasi. Untuk informasi lebih lanjut, lihat Penandatanganan Tipe A.

    {"uid":"12345","rand":"abckljd"}
    Definition

    string

    No

    Definisi aliran video. Pisahkan beberapa definisi dengan koma (,). Nilai valid:

    • FD: definisi rendah.

    • LD: definisi standar.

    • SD: definisi tinggi.

    • HD: definisi ultra-tinggi.

    • OD: definisi asli.

    • 2K: 2K.

    • 4K: 4K.

    • SQ: kualitas suara standar.

    • HQ: kualitas suara tinggi.

    • AUTO: streaming bitrate adaptif.

    Catatan

    • Secara default, aliran dari semua definisi dikembalikan.

    • Saat menghasilkan jejak watermark, parameter ini diperlukan dan harus konsisten dengan definisi yang dikonfigurasi selama transkoding jejak watermark.

    • Definisi AUTO dikembalikan hanya ketika pengemasan transkoding dikonfigurasi dalam template transkoding. Untuk informasi lebih lanjut, lihat PackageSetting: pengaturan pengemasan transkoding.

    LD
    ResultType

    string

    No

    Jenis data yang dikembalikan. Nilai valid:

    • Single (default): hanya mengembalikan aliran yang telah dikodekan ulang terbaru untuk setiap definisi dan format.

    • Multiple: mengembalikan semua aliran yang telah dikodekan ulang untuk setiap definisi dan format.

    Single.
    PlayConfig

    string

    No

    Pengaturan pemutaran kustom. Nilainya adalah string JSON yang mendukung penetapan pengaturan pemutaran nama domain. Untuk detail konstruksi parameter, lihat PlayConfig.

    Catatan

    • Jika PlayConfig tidak diatur atau PlayDomain di dalamnya tidak diatur, operasi menggunakan nama domain default yang dikonfigurasi di ApsaraVideo VOD. Jika tidak ada nama domain default yang dikonfigurasi, nama domain yang terakhir dimodifikasi digunakan sebagai nama domain pemutaran berdasarkan urutan waktu modifikasi terbalik. Untuk mencegah nama domain yang tidak diharapkan dikembalikan, atur nama domain pemutaran default. Masuk ke Konsol ApsaraVideo VOD dan pilih Manajemen Konfigurasi > Manajemen Media > Penyimpanan > Kelola > Nama domain yang melakukan pengambilan asal dari alamat penyimpanan ini untuk mengatur nama domain pemutaran default.

    • Ketika parameter EncryptType di PlayConfig diatur ke AliyunVoDEncryption, URL pemutaran aliran yang dienkripsi secara privat tidak dikembalikan secara default untuk memastikan keamanan video. Untuk mengembalikan URL pemutaran aliran yang dienkripsi secara privat, atur parameter ResultType ke Multiple.

    {"PlayDomain":"vod.test_domain","XForwardedFor":"yqCD7Fp1uqChoVj/sl/p5Q==","PreviewTime":"20","MtsHlsUriToken":"yqCD7Fp1uqChoVjslp5Q"}
    AdditionType

    string

    No

    Mengambil URL data masker layar bullet yang dapat diakses di Tiongkok. Nilai valid: danmu.

    Catatan

    Parameter ini hanya berlaku ketika outputType diatur ke cdn.

    danmu.
    Trace

    string

    No

    Pengaturan watermark digital kustom.

    • Ketika DigitalWatermarkType diatur ke TraceMark, masukkan parameter ini untuk mengatur informasi jejak watermark untuk video dan mengembalikan aliran video yang berisi informasi watermark. Hanya huruf Inggris, angka, dan karakter Tiongkok yang didukung. Maksimal 1024 karakter didukung.

    • Ketika DigitalWatermarkType diatur ke CopyrightMark, Trace sesuai dengan teks watermark yang dikonfigurasi saat template watermark dibuat. Masukkan parameter ini untuk mengkueri dan mengembalikan aliran video dengan teks watermark yang ditentukan.

    test mark.
    DigitalWatermarkType

    string

    No

    Jenis watermark digital. Nilai valid:

    • TraceMark: jejak watermark.

    • CopyrightMark: watermark hak cipta.

    TraceMark.
    ReferenceId

    string

    No

    A custom ID. It can be 6 to 64 characters in length and can contain lowercase letters, uppercase letters, digits, hyphens (-), and underscores (_). The ID must be unique for each user.

    H264

    No

    ID kustom. Hanya huruf kecil, huruf besar, angka, tanda hubung, dan garis bawah yang didukung. Panjangnya 6 hingga 64 karakter. ID ini unik per pengguna.

    123-123

    Elemen respons

    Element

    Type

    Description

    Example

    object

    Parameter respons.

    RequestId

    string

    ID permintaan.

    F552E596-967D-5500-842F-17E6364****
    VideoBase

    object

    Informasi dasar tentang file audio atau video.

    CreationTime

    string

    Waktu saat file audio atau video dibuat. Waktu mengikuti standar ISO 8601 dalam format yyyy-MM-ddTHH:mm:ssZ. Waktu ditampilkan dalam UTC.

    2017-06-26T06:38:48Z
    Status

    string

    Status file audio atau video. Untuk nilai valid dan deskripsi, lihat Status: status audio dan video.

    Normal.
    VideoId

    string

    ID audio atau video.

    93ab850b4f654b6e91d24d81d44****
    CoverURL

    string

    URL gambar mini file audio atau video.

    Catatan

    Untuk memperoleh URL gambar mini secara real-time setelah mengunggah video, konfigurasikan callback ApsaraVideo VOD. Untuk informasi lebih lanjut, lihat Callback HTTP dan Event SnapshotComplete.

    http://example.aliyundoc.com/sample.jpg?auth_key=2333232-atb****
    Duration

    string

    Durasi file audio atau video. Unit: detik.

    3.1667
    Title

    string

    Judul file audio atau video.

    Alibaba Cloud VOD.
    MediaType

    string

    Jenis file media. Nilai valid:

    • video: video.

    • audio: hanya audio.

    video.
    DanMuURL

    string

    URL data masker layar bullet yang dapat diakses di Tiongkok.

    http://example.aliyundoc.com/****?auth_key=abdf2123-6783232****
    StorageClass

    string

    Kelas penyimpanan aset media. Nilai valid:

    • Standard: Jenis Penyimpanan Standar.

    • IA: akses jarang aset media.

    • Archive: arsip aset media.

    • ColdArchive: arsip dingin aset media.

    • SourceIA: akses jarang file sumber.

    • SourceArchive: arsip file sumber.

    • SourceColdArchive: arsip dingin file sumber.

    • Changing: kelas penyimpanan aset media sedang diubah.

    • SourceChanging: kelas penyimpanan file sumber sedang diubah.

    Standard
    PlayInfoList

    object

    PlayInfo

    array<object>

    Informasi pemutaran (informasi aliran) file audio atau video.

    object

    Informasi detail tentang file audio atau video.

    CreationTime

    string

    The time when the stream was created. The time is in the yyyy-MM-ddTHH:mm:ssZ format in UTC.

    2022-04-18T07:37:15Z
    Status

    string

    The status of the media stream. Valid values:

    • Normal: The stream is in the normal state. This status is assigned to the latest transcoded stream for each definition and format.

    • Invisible: The stream is in the invisible state. If multiple streams are generated for the same definition and format, the latest stream is marked as Normal and the others are marked as Invisible.

    Normal
    Specification

    string

    The specifications of the transcoded output. For more information about the valid values and descriptions, see Specification: Output specifications.

    H264.LD
    NarrowBandType

    string

    The transcoding type. Valid values:

    • 0: Normal transcoding.

    • 1.0: Narrowband HD 1.0.

    • 2.0: Narrowband HD 2.0.

    0
    Height

    integer

    The height of the media stream. Unit: px.

    640
    Bitrate

    string

    The bitrate of the media stream. Unit: Kbps.

    Catatan

    Due to the dynamic sharding feature of M3U8, the calculated bitrate may have a drift.

    450.878
    ModificationTime

    string

    The time when the stream was last updated. The time is in the yyyy-MM-ddTHH:mm:ssZ format in UTC.

    2022-04-20T06:32:19Z
    WatermarkId

    string

    The ID of the watermark template associated with the current media stream.

    dgfn26457856****
    Encrypt

    integer

    Indicates whether the media stream is encrypted. Valid values:

    • 0: No.

    • 1: Yes.

    1
    Definition

    string

    The definition of the video stream. Valid values:

    • FD: Low definition.

    • LD: Standard definition.

    • SD: High definition.

    • HD: Ultra high definition.

    • OD: Original quality.

    • 2K: 2K.

    • 4K: 4K.

    • SQ: Standard quality.

    • HQ: High quality.

    • AUTO: Adaptive bitrate.

    LD
    EncryptType

    string

    The encryption type of the media stream. Valid values:

    • AliyunVoDEncryption: Alibaba Cloud proprietary cryptography.

    • HLSEncryption: HLS standard encryption.

    Catatan

    If the encryption type is AliyunVoDEncryption, you can play the stream only using ApsaraVideo Player SDK.

    AliyunVoDEncryption
    EncryptMode

    string

    The encryption mode of the media stream. Valid values:

    • License: Local decryption mode.

    Catatan

    If the encryption mode is License, you can play the stream only using ApsaraVideo Player SDK.

    License
    StreamType

    string

    The type of the media stream. The value is video for a video stream or audio for an audio-only stream.

    video
    JobId

    string

    The ID of the transcoding job for the media stream. This ID serves as the unique identifier for the media stream.

    80e9c6580e754a798c3c19c59b16****
    Size

    integer

    The size of the media stream. Unit: byte.

    Catatan

    Due to the dynamic sharding feature of M3U8, the calculated stream size may have a drift.

    418112
    Width

    integer

    The width of the media stream. Unit: px.

    360
    Fps

    string

    The frame rate of the media stream. Unit: frames per second.

    25
    Duration

    string

    The duration of the media stream. Unit: seconds.

    9.0464
    PlayURL

    string

    The playback URL of the video stream.

    https://example.aliyundoc.com/d52ee123f331466aabf6ab32a93d****/a777f9e24e6e47a2a942467d5c38ea37-8ee8e04293c6657fdda282bc422704****.m3u8
    Format

    string

    The format of the media stream.

    • The value is mp4 or m3u8 for a video file.

    • The value is mp3 for an audio-only file.

    m3u8
    HDRType

    string

    The High Dynamic Range (HDR) type of the media stream. Valid values:

    • HDR

    • HDR10

    • HLG

    • DolbyVision

    • HDRVivid

    • SDR+

    HLG
    BitDepth

    integer

    The color depth. The value is an integer.

    8
    JobType

    integer

    The type of the digital watermark. Valid values:

    • 1: Tracing watermark.

    • 2: Copyright watermark.

    2
    JobExt

    string

    The custom watermark information for the copyright watermark. This field is returned only when JobType is 2.

    CopyrightMarkTest
    CodecName

    string

    The encoding type. Valid values:

    • H264

    • H265

    H264

    Contoh

    Respons sukses

    JSONformat

    {
  "RequestId": "F552E596-967D-5500-842F-17E6364****",
  "VideoBase": {
    "CreationTime": "2017-06-26T06:38:48Z",
    "Status": "Normal",
    "VideoId": "93ab850b4f654b6e91d24d81d44****",
    "CoverURL": "http://example.aliyundoc.com/sample.jpg?auth_key=2333232-atb****",
    "Duration": "3.1667",
    "Title": "阿里云VOD",
    "MediaType": "video",
    "DanMuURL": "http://example.aliyundoc.com/****?auth_key=abdf2123-6783232****",
    "StorageClass": "Standard"
  },
  "PlayInfoList": {
    "PlayInfo": [
      {
        "CreationTime": "2022-04-18T07:37:15Z",
        "Status": "Normal",
        "Specification": "H264.LD",
        "NarrowBandType": "0",
        "Height": 640,
        "Bitrate": "450.878",
        "ModificationTime": "2022-04-20T06:32:19Z",
        "WatermarkId": "dgfn26457856****",
        "Encrypt": 1,
        "Definition": "LD",
        "EncryptType": "AliyunVoDEncryption",
        "EncryptMode": "License",
        "StreamType": "video",
        "JobId": "80e9c6580e754a798c3c19c59b16****",
        "Size": 418112,
        "Width": 360,
        "Fps": "25",
        "Duration": "9.0464",
        "PlayURL": "https://example.aliyundoc.com/d52ee123f331466aabf6ab32a93d****/a777f9e24e6e47a2a942467d5c38ea37-8ee8e04293c6657fdda282bc422704****.m3u8",
        "Format": "m3u8",
        "HDRType": "HLG",
        "BitDepth": 8,
        "JobType": 2,
        "JobExt": "CopyrightMarkTest",
        "CodecName": "H264"
      }
    ]
  }
}

    Kode kesalahan

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.