All Products
Search
Document Center

ApsaraVideo VOD:GetVideoList

Last Updated:Jul 21, 2026

Mengambil daftar informasi audio dan video.

Deskripsi operasi

Operasi ini mengambil hingga 5000 file audio dan video yang sesuai dengan kondisi filter yang ditentukan (seperti status video dan ID kategori). Tentukan StartTime dan EndTime untuk mengambil data secara bertahap. Untuk mengkueri lebih banyak file audio dan video atau menelusuri semua informasi audio dan video, lihat Mencari informasi 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. Anda dapat memperoleh ID kategori dengan menggunakan metode berikut:

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

  • Dapatkan nilai CateId dari tanggapan saat Anda memanggil operasi CreateCategory.

  • Dapatkan nilai CateId dari tanggapan saat Anda memanggil operasi GetCategories.

781111

Status

string

No

Status video. Anda dapat menentukan beberapa status. Pisahkan beberapa status dengan koma (,). Nilai valid:

  • Uploading: Video sedang diunggah.

  • UploadFail: Video gagal diunggah.

  • UploadSucc: Video telah diunggah.

  • Transcoding: Video sedang ditranskode.

  • TranscodeFail: Video gagal ditranskode.

  • Checking: Video sedang ditinjau.

  • Blocked: Video diblokir.

  • Normal: Video dalam keadaan normal.

  • ProduceFail: Video gagal diproduksi.

Untuk informasi lebih lanjut tentang status video dan batasan terkait, lihat Status: status video.

Uploading,Normal.

PageNo

integer

No

Nomor halaman. Nilai default: 1.

1

PageSize

integer

No

Jumlah entri per halaman. Nilai default: 10. Nilai maksimum: 100.

10

SortBy

string

No

Aturan pengurutan hasil. Nilai valid:

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

  • CreationTime:Asc: diurutkan berdasarkan waktu pembuatan secara menaik.

CreationTime:Asc.

StartTime

string

No

Awal rentang waktu untuk dikueri berdasarkan CreationTime (waktu pembuatan). Tentukan waktu dalam format yyyy-MM-ddTHH:mm:ssZ (UTC).

2017-01-11T12:00:00Z

EndTime

string

No

Akhir rentang waktu untuk dikueri berdasarkan CreationTime. Waktu akhir harus lebih lambat daripada waktu mulai. Tentukan waktu dalam format yyyy-MM-ddTHH:mm:ssZ (UTC).

2017-01-11T12:59:00Z

StorageLocation

string

No

Alamat penyimpanan file audio atau video.

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

ReferenceIds

string

No

Daftar ID kustom. Tentukan satu atau lebih ID kustom yang dipisahkan oleh koma (,). Mendukung maksimal 20 ID.

123-123,1234-1234

Elemen respons

Element

Type

Description

Example

object

Parameter tanggapan.

Total

integer

Jumlah total file audio dan video.

100

RequestId

string

ID permintaan.

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

VideoList

object

Video

array<object>

Daftar informasi audio dan video. Maksimal 5000 entri dapat dikembalikan.

array<object>

Detail file audio atau video.

StorageLocation

string

The storage address of the audio or video file.

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

Status

string

The video status. Valid values:

  • Uploading: The video is being uploaded.

  • UploadFail: The video failed to be uploaded.

  • UploadSucc: The video has been uploaded.

  • Transcoding: The video is being transcoded.

  • TranscodeFail: The video failed to be transcoded.

  • Checking: The video is being reviewed.

  • Blocked: The video is blocked.

  • Normal: The video is in a normal state.

  • ProduceFail: The video failed to be produced.

For more information about video statuses and related limits, see Status: video status.

Normal

CreationTime

string

The creation time of the audio or video file. The time is in the yyyy-MM-ddTHH:mm:ssZ format (UTC).

2017-11-14T09:15:50Z

CateId

integer

The category ID.

781111

VideoId

string

The audio or video ID.

9ae2af636ca6c10412f44891fc****

Tags

string

The tags of the audio or video file. Multiple tags are separated by commas (,).

Tag 1, Tag 2

ModificationTime

string

The last modification time of the video. The time is in the yyyy-MM-ddTHH:mm:ssZ format (UTC).

2017-11-14T09:16:50Z

CateName

string

The category name.

Category name

Description

string

The description of the audio or video file.

Alibaba Cloud VOD video description

AppId

string

The application ID. Default value: app-1000000.

app-1000000

Size

integer

The size of the source audio or video file. Unit: bytes.

10897890

CoverURL

string

The thumbnail URL of the audio or video file.

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

Duration

number

The duration of the audio or video file. Unit: seconds.

135.6

Title

string

The title of the audio or video file.

Alibaba Cloud VOD video title

Snapshots

object

Snapshot

array

The array of video snapshot URLs.

string

The video snapshot URL.

Catatan

Snapshot data is returned only for videos that have been processed by video snapshots. Otherwise, an empty value is returned.

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

StorageClass

string

The storage class of the media asset. Valid values:

  • Standard: standard.

  • IA: Infrequent Access for media assets.

  • Archive: Archive for media assets.

  • ColdArchive: Cold Archive for media assets.

  • SourceIA: Infrequent Access for source files.

  • SourceArchive: Archive for source files.

  • SourceColdArchive: Cold Archive for source files.

  • Changing: The storage class of the media asset is being changed.

  • SourceChanging: The storage class of the source file is being changed.

Standard

RestoreStatus

string

The restoration status of the media asset. Valid values:

  • Processing: The media asset is being restored.

  • Success: The media asset has been restored.

  • Failed: The media asset failed to be restored.

Success

RestoreExpiration

string

The expiration time of the media asset restoration.

2023-03-30T10:14:14Z

UserData

string

The custom settings. The value is a JSON string that supports settings such as message callbacks and upload acceleration. For more information, see UserData.

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

ReferenceId

string

The custom ID. Only lowercase letters, uppercase letters, digits, hyphens, and underscores are supported. The value must be 6 to 64 characters in length and is unique at the user level.

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": "Tag 1, Tag 2",
        "ModificationTime": "2017-11-14T09:16:50Z",
        "CateName": "Category name",
        "Description": "Alibaba Cloud VOD video description",
        "AppId": "app-1000000",
        "Size": 10897890,
        "CoverURL": "https://example.aliyundoc.com/****.jpg",
        "Duration": 135.6,
        "Title": "Alibaba Cloud VOD video title",
        "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.