Gunakan GetVideoList untuk mengambil informasi video - ApsaraVideo VOD - Alibaba Cloud - ApsaraVideo VOD

Mengambil daftar informasi video.

Deskripsi operasi

Operasi ini mengambil hingga 5000 file media 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 semua informasi aset media, lihat SearchMedia.

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

Parameter permintaan

Parameter	Type	Required	Description	Example
CateId	integer	No	ID kategori. Dapatkan ID dengan salah satu cara berikut: Masuk ke konsol VOD dan pilih Manajemen Konfigurasi > Manajemen Media > Kategori 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 tanda koma (,). Nilai yang valid: Uploading: Video sedang diunggah. UploadFail: Video gagal diunggah. UploadSucc: Video sudah 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 selengkapnya tentang setiap status video dan batasannya, lihat Status: Status video.	Uploading,Normal
PageNo	integer	No	Nomor halaman. Nilai default-nya adalah 1.	1
PageSize	integer	No	Jumlah entri yang akan dikembalikan pada setiap halaman. Nilai default-nya adalah 10. Nilai maksimumnya adalah 100.	10
SortBy	string	No	Aturan pengurutan untuk hasil kueri. Nilai yang valid: CreationTime:Desc (default): Mengurutkan hasil berdasarkan waktu pembuatan dalam urutan menurun. CreationTime:Asc: Mengurutkan hasil berdasarkan waktu pembuatan dalam urutan 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 tanda koma (,). Anda dapat menentukan hingga 20 ID.	123-123,1234-1234

Elemen respons

Element	Type	Description	Example
	object	Parameter respons.
Total	integer	Jumlah total 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 maksimum 5.000 entri.
	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 status of the video. Valid values: Uploading: The video is being uploaded. UploadFail: The video failed to be uploaded. UploadSucc: The video is 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 each video status and its limits, see Status: Video status.	Normal
CreationTime	string	The time when the audio or video file was created. The time is in UTC. The format is yyyy-MM-ddTHH:mm:ssZ.	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 a comma (,).	标签1, 标签2
ModificationTime	string	The time when the video was last updated. The time is in UTC. The format is yyyy-MM-ddTHH:mm:ssZ.	2017-11-14T09:16:50Z
CateName	string	The category name.	分类名称
Description	string	The description of the audio or video file.	阿里云VOD视频描述
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 URL of the cover image for 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.	阿里云VOD视频标题
Snapshots	object
Snapshot	array	An array of video snapshot URLs.
	string	The URL of a video snapshot. Catatan Snapshot data is returned only for videos that are processed by the video snapshot feature. Otherwise, this parameter is empty.	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. Archive: Archive. ColdArchive: Cold Archive. SourceIA: Infrequent Access for the source file. SourceArchive: Archive for the source file. SourceColdArchive: Cold Archive for the source file. 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 is restored. Failed: The media asset failed to be restored.	Success
RestoreExpiration	string	The expiration time of the restored media asset.	2023-03-30T10:14:14Z
UserData	string	Custom settings. This 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. It can contain only lowercase letters, uppercase letters, digits, hyphens (-), and underscores (_). The ID must be 6 to 64 characters in length. The ID must be unique for each user.	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.