全部产品
Search
文档中心

ApsaraVideo VOD:GetVideoList

更新时间:Dec 15, 2025

Mengambil daftar informasi video.

Deskripsi operasi

Operasi ini mengambil hingga 5.000 file audio atau video berdasarkan kondisi filter, seperti status video atau ID kategori. Untuk mengambil data secara batch, tentukan parameter StartTime dan EndTime. Untuk mengkueri lebih banyak file atau menelusuri seluruh informasi aset media, lihat Cari aset media.

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

list

*All Resource

*

None None

Parameter permintaan

Parameter

Type

Required

Description

Example

CateId

integer

No

ID kategori. Dapatkan ID dengan salah satu cara berikut:

  • Login ke Konsol VOD dan pilih Configuration Management > Media Asset Management > Category Management untuk melihat ID kategori.

  • Nilai parameter CateId yang dikembalikan setelah Anda memanggil operasi AddCategory.

  • Nilai parameter CateId yang dikembalikan setelah Anda memanggil operasi GetCategories.

781111

Status

string

No

Status video. Untuk mengambil video dalam beberapa status, pisahkan status dengan koma (,). Nilai yang valid:

  • Uploading: Video sedang diunggah.

  • UploadFail: Pengunggahan video gagal.

  • UploadSucc: Video telah diunggah.

  • Transcoding: Video sedang ditranskode.

  • TranscodeFail: Transkode video gagal.

  • Checking: Video sedang ditinjau.

  • Blocked: Video diblokir.

  • Normal: Video dalam keadaan normal.

  • ProduceFail: Produksi video gagal.

Untuk informasi selengkapnya tentang setiap status video dan batasannya, lihat Status: Video status.

Uploading,Normal

PageNo

integer

No

Nomor halaman. Nilai default adalah 1.

1

PageSize

integer

No

Jumlah entri yang dikembalikan per halaman. Nilai default adalah 10. Nilai maksimum adalah 100.

10

SortBy

string

No

Aturan pengurutan untuk hasil kueri. Nilai yang valid:

  • CreationTime:Desc (default): Mengurutkan hasil berdasarkan waktu pembuatan secara menurun.

  • CreationTime:Asc: Mengurutkan hasil berdasarkan waktu pembuatan secara menaik.

CreationTime:Asc

StartTime

string

No

Awal rentang waktu untuk dikueri berdasarkan waktu pembuatan. Waktu dalam UTC. Formatnya adalah yyyy-MM-ddTHH:mm:ssZ.

2017-01-11T12:00:00Z

EndTime

string

No

Akhir rentang waktu untuk dikueri berdasarkan waktu pembuatan. Waktu akhir harus lebih lambat dari waktu mulai. Waktu dalam UTC. Formatnya adalah yyyy-MM-ddTHH:mm:ssZ.

2017-01-11T12:59:00Z

StorageLocation

string

No

Alamat penyimpanan file audio atau video.

out-****.oss-cn-shanghai.aliyuncs.com

ReferenceIds

string

No

Daftar satu atau beberapa ID kustom. Pisahkan beberapa ID dengan koma (,). Anda dapat menentukan hingga 20 ID.

123-123,1234-1234

Elemen respons

Element

Type

Description

Example

object

Parameter respons.

Total

integer

Total jumlah file audio atau video.

100

RequestId

string

ID permintaan.

25818875-5F78-4AF6-D7393642CA58****

VideoList

object

Video

array<object>

Daftar informasi audio atau video. Anda dapat mengambil maksimal 5.000 entri.

array<object>

Detail file audio atau video.

StorageLocation

string

Alamat penyimpanan file audio atau video.

out-****.oss-cn-shanghai.aliyuncs.com

Status

string

Status video. Nilai yang valid:

  • Uploading: Video sedang diunggah.

  • UploadFail: Pengunggahan video gagal.

  • UploadSucc: Video telah diunggah.

  • Transcoding: Video sedang ditranskode.

  • TranscodeFail: Transkode video gagal.

  • Checking: Video sedang ditinjau.

  • Blocked: Video diblokir.

  • Normal: Video dalam keadaan normal.

  • ProduceFail: Produksi video gagal.

Untuk informasi selengkapnya tentang setiap status video dan batasannya, lihat Status: Video status.

Normal

CreationTime

string

Waktu pembuatan file audio atau video. Waktu dalam UTC. Formatnya adalah yyyy-MM-ddTHH:mm:ssZ.

2017-11-14T09:15:50Z

CateId

integer

ID kategori.

781111

VideoId

string

ID audio atau video.

9ae2af636ca6c10412f44891fc****

Tags

string

Tag file audio atau video. Beberapa tag dipisahkan dengan koma (,).

标签1, 标签2

ModificationTime

string

Waktu terakhir video diperbarui. Waktu dalam UTC. Formatnya adalah yyyy-MM-ddTHH:mm:ssZ.

2017-11-14T09:16:50Z

CateName

string

Nama kategori.

分类名称

Description

string

Deskripsi file audio atau video.

阿里云VOD视频描述

AppId

string

ID aplikasi. Nilai default: app-1000000.

app-1000000

Size

integer

Ukuran file audio atau video sumber. Satuan: byte.

10897890

CoverURL

string

URL citra sampul untuk file audio atau video.

https://example.aliyundoc.com/****.jpg

Duration

number

Durasi file audio atau video. Satuan: detik.

135.6

Title

string

Judul file audio atau video.

阿里云VOD视频标题

Snapshots

object

Snapshot

array

Array URL tangkapan video.

string

URL tangkapan video.

Catatan

Data Snapshot hanya dikembalikan untuk video yang diproses oleh fitur video snapshot. Jika tidak, parameter ini kosong.

http://example.aliyundoc.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e27333****

StorageClass

string

Kelas penyimpanan aset media. Nilai yang valid:

  • Standard: Standard.

  • IA: Infrequent Access.

  • Archive: Archive.

  • ColdArchive: Cold Archive.

  • SourceIA: Infrequent Access untuk file sumber.

  • SourceArchive: Archive untuk file sumber.

  • SourceColdArchive: Cold Archive untuk file sumber.

  • Changing: Kelas penyimpanan aset media sedang diubah.

  • SourceChanging: Kelas penyimpanan file sumber sedang diubah.

Standard

RestoreStatus

string

Status pemulihan aset media. Nilai yang valid:

  • Processing: Aset media sedang dipulihkan.

  • Success: Aset media telah dipulihkan.

  • Failed: Pemulihan aset media gagal.

Success

RestoreExpiration

string

Waktu kedaluwarsa aset media yang telah dipulihkan.

2023-03-30T10:14:14Z

UserData

string

Pengaturan kustom. Ini adalah string JSON yang mendukung pengaturan seperti callback pesan dan akselerasi unggah. Untuk informasi selengkapnya, lihat UserData.

{"MessageCallback":{"CallbackURL":"http://example.aliyundoc.com"},"Extend":{"localId":"*****","test":"www"}}

ReferenceId

string

ID kustom. Hanya boleh berisi huruf kecil, huruf besar, angka, tanda hubung (-), dan garis bawah (_). Panjang ID harus antara 6 hingga 64 karakter. ID harus unik untuk setiap pengguna.

123-123

Contoh

Respons sukses

JSONformat

{
  "Total": 100,
  "RequestId": "25818875-5F78-4AF6-D7393642CA58****",
  "VideoList": {
    "Video": [
      {
        "StorageLocation": "out-****.oss-cn-shanghai.aliyuncs.com",
        "Status": "Normal",
        "CreationTime": "2017-11-14T09:15:50Z",
        "CateId": 781111,
        "VideoId": "9ae2af636ca6c10412f44891fc****",
        "Tags": "标签1, 标签2",
        "ModificationTime": "2017-11-14T09:16:50Z",
        "CateName": "分类名称",
        "Description": "阿里云VOD视频描述",
        "AppId": "app-1000000",
        "Size": 10897890,
        "CoverURL": "https://example.aliyundoc.com/****.jpg",
        "Duration": 135.6,
        "Title": "阿里云VOD视频标题",
        "Snapshots": {
          "Snapshot": [
            "http://example.aliyundoc.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e27333****"
          ]
        },
        "StorageClass": "Standard",
        "RestoreStatus": "Success",
        "RestoreExpiration": "2023-03-30T10:14:14Z",
        "UserData": "{\"MessageCallback\":{\"CallbackURL\":\"http://example.aliyundoc.com\"},\"Extend\":{\"localId\":\"*****\",\"test\":\"www\"}}",
        "ReferenceId": "123-123"
      }
    ]
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.