SearchMedia - ApsaraVideo VOD

Operasi ini mencari aset media di ApsaraVideo VOD, seperti video, audio, dan citra. Anda dapat memanggil operasi ini dan menggunakan protokol pencarian media untuk melakukan pencarian multidimensi, menentukan bidang yang akan dikembalikan, menerapkan pencocokan eksak, kueri fuzzy, kueri multivalue, serta kueri rentang, dan menetapkan bidang untuk pengurutan.

Deskripsi operasi

Untuk bidang yang mendukung pencocokan eksak maupun kueri fuzzy, hasil dari jenis kueri lainnya didasarkan pada metode kueri yang didukung. Misalnya, jika suatu bidang hanya mendukung kueri fuzzy, maka kueri multivalue pada bidang tersebut juga mengembalikan hasil berdasarkan pencocokan fuzzy.

Batasan jumlah hasil pencarian yang dapat Anda ambil adalah sebagai berikut:

Metode 1: Paging

Anda dapat menjelajahi hingga 5.000 hasil pencarian dengan mengatur parameter PageNo (nomor halaman) dan PageSize (jumlah catatan per halaman). Jika jumlah hasil pencarian melebihi 5.000, Anda harus menyesuaikan kondisi pencarian untuk mempersempit set hasil. Perhatikan bahwa metode ini tidak dapat menjelajahi seluruh dataset. Untuk menjelajahi lebih banyak data, lihat Metode 2.
Metode 2: Penjelajahan penuh (hanya untuk pencarian audio dan video)

Metode ini hanya berlaku untuk pencarian audio dan video serta mendukung penjelajahan semua hasil pencarian hingga maksimal 2 juta catatan. Jika jumlah hasil pencarian melebihi 2 juta, Anda harus menambahkan lebih banyak kondisi filter untuk mengurangi set hasil. Saat menggunakan metode ini, Anda harus menggunakan parameter ScrollToken selain parameter PageNo dan PageSize untuk paging. Perhatikan bahwa Anda dapat menjelajahi maksimal 100 catatan ke belakang sekaligus. Contoh berikut menunjukkan logika paging ketika PageSize diatur ke 20:
- Jika PageNo adalah 1, Anda dapat mengambil data hingga 5 halaman berikutnya.
- Jika PageNo adalah 2, Anda dapat mengambil data hingga 6 halaman berikutnya.

Anda harus mengatur parameter paging secara tepat sesuai kebutuhan pencarian dan memilih metode penjelajahan yang sesuai berdasarkan ukuran set hasil. Untuk melakukan paging lebih dari 1.000 catatan, gunakan Metode 2 agar pemrosesan data lebih cepat dan nyaman.

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

list

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
SearchType	string	No	Jenis aset media yang akan dicari. Nilai yang valid: video (default): video. audio: audio. image: citra. attached: aset media pendukung. Catatan Jika parameter ini diatur ke video atau audio dan Anda perlu menjelajahi semua data yang memenuhi kriteria pencarian, Anda harus mengatur parameter ScrollToken.	video
Fields	string	No	Bidang aset media yang dikembalikan dalam hasil pencarian. Secara default, hanya bidang dasar aset media yang dikembalikan. Anda dapat menentukan lebih banyak bidang untuk dikembalikan. Untuk informasi selengkapnya, lihat Contoh.	Title,CoverURL
Match	string	No	Kondisi filter. Untuk informasi lebih lanjut tentang sintaksisnya, lihat Sintaksis protokol pencarian.	field = value
SortBy	string	No	Bidang pengurutan dan urutannya. Pisahkan beberapa nilai dengan koma (,). Nilai yang valid: CreationTime:Desc (default): Mengurutkan berdasarkan waktu pembuatan secara menurun. CreationTime:Asc: Mengurutkan berdasarkan waktu pembuatan secara menaik. Catatan Untuk informasi lebih lanjut tentang bidang pengurutan, lihat Bidang pengurutan. Saat mengambil 5.000 catatan data pertama yang memenuhi kriteria pencarian, Anda dapat menentukan hingga tiga bidang pengurutan. Saat mengambil semua data yang memenuhi kriteria pencarian, Anda hanya dapat menentukan satu bidang pengurutan.	CreationTime:Desc
PageNo	integer	No	Nomor halaman. Nilai default-nya adalah 1. Catatan Jika nilai parameter ini melebihi 200, kami menyarankan agar Anda juga mengatur parameter ScrollToken.	1
PageSize	integer	No	Jumlah catatan data yang dikembalikan di setiap halaman. Nilai default-nya adalah 10. Nilai maksimumnya adalah 100.	10
ScrollToken	string	No	Token pagination. Ini adalah string sepanjang 32 karakter. Anda tidak perlu mengatur parameter ini untuk permintaan pencarian pertama. Sisi server mengembalikan parameter ini untuk menandai posisi saat ini dalam hasil pencarian. Catat nilai yang dikembalikan. Untuk pencarian berikutnya, atur parameter ini sesuai kebutuhan atau rekomendasi berikut: Jika parameter SearchType diatur ke video atau audio dan Anda perlu menjelajahi semua data yang memenuhi kriteria pencarian, Anda harus mengatur parameter ini. Jika nilai parameter PageNo melebihi 200, kami menyarankan agar Anda mengatur parameter ini untuk mengoptimalkan performa pencarian.	24e0fba7188fae707e146esa54****

Elemen respons

Element	Type	Description	Example
	object	Tanggapan.
RequestId	string	ID permintaan.	3E0CEF83-FB09-4E34-BA1451814B03****
Total	integer	Jumlah total aset media yang memenuhi kriteria pencarian.	10
ScrollToken	string	Token pagination.	24e0fba7188fae707e146esa54****
MediaList	array<object>	Daftar aset media.
	array<object>	Detail aset media.
CreationTime	string	Waktu saat aset media dibuat. Waktu dalam format UTC yyyy-MM-ddTHH:mm:ssZ.	2018-07-19T03:45:25Z
MediaType	string	Jenis aset media. Nilai yang valid: video: video. audio: audio. image: citra. attached: aset media pendukung.	video
MediaId	string	ID aset media.	a82a2cd7d4e147bbed6c1ee372****
Video	object	Informasi video.
Status	string	Status. Nilai yang valid: Uploading: Video sedang diunggah. UploadFail: Pengunggahan video gagal. UploadSucc: Video telah diunggah. Transcoding: Video sedang ditranskode. TranscodeFail: Transkoding video gagal. Blocked: Video diblokir. Normal: Video dalam keadaan normal.	UploadSucc
CreationTime	string	Waktu saat informasi video dibuat. Waktu dalam format UTC yyyy-MM-ddTHH:mm:ssZ.	2018-07-19T03:45:25Z
StorageLocation	string	Wilayah penyimpanan.	outin-bfefbb90a47c******163e1c7426.oss-cn-shanghai.aliyuncs.com
CateId	integer	ID kategori.	10000123
Tags	string	Tag video.	tag1
ModificationTime	string	Waktu terakhir informasi video diperbarui. Waktu dalam format UTC yyyy-MM-ddTHH:mm:ssZ.	2018-07-19T03:48:25Z
MediaSource	string	Sumber. Nilai yang valid: general: Unggahan VOD. short_video: SDK video pendek. editing: Pengeditan dan produksi video. live: Rekaman aliran langsung.	general
Description	string	Deskripsi video.	Alibaba Cloud VOD video description
AppId	string	ID aplikasi.	app-****
CoverURL	string	URL gambar mini.	https://example.aliyundoc.com/image01.png
VideoId	string	ID video.	a82a2asdasqadaf3faa0ed6c1ee372****
DownloadSwitch	string	Sakelar unduhan. Unduhan offline hanya diizinkan ketika sakelar diaktifkan. Nilai yang valid: on: Keadaan awal. Unduhan offline diizinkan. off: Unduhan offline dinonaktifkan.	on
CateName	string	Nama kategori.	video1
TranscodeMode	string	Mode transkoding. Nilai yang valid: FastTranscode (Transkoding Normal): Mode default. Transkoding dimulai segera setelah pengunggahan selesai. Pemutaran tersedia setelah transkoding selesai. NoTranscode (Distribusi tanpa transkoding): Tidak ada transkoding setelah pengunggahan selesai. Pemutaran tersedia segera. AsyncTranscode (Distribusi saat pengunggahan dan transkoding asinkron): Pemutaran tersedia segera setelah pengunggahan selesai. Transkoding dilakukan secara asinkron.	FastTranscode
PreprocessStatus	string	Status pra-pemrosesan. Nilai yang valid: UnPreprocess: Belum dipra-pemroses. Preprocessing: Sedang dipra-pemroses. PreprocessSucceed: Pra-pemrosesan berhasil. PreprocessFailed: Pra-pemrosesan gagal.	Preprocessing
RestoreExpiration	string	Waktu kedaluwarsa aset media yang dipulihkan.	2023-03-30T10:14:14Z
RestoreStatus	string	Keadaan dipulihkan aset media. Nilai yang valid: Processing: Sedang memulihkan. Success: Telah dipulihkan. Failed: Pemulihan gagal.	Success
StorageClass	string	Kelas penyimpanan aset media. Nilai yang valid: Standard: Standard. IA: Infrequent Access (IA). Archive: Archive. ColdArchive: Cold Archive. SourceIA: Source IA. SourceArchive: Source Archive. SourceColdArchive: Source Cold Archive. Changing: Kelas penyimpanan sedang diubah. SourceChanging: Kelas penyimpanan file sumber sedang diubah.	Standard
Size	integer	Ukuran video.	123
Duration	number	Durasi video. Satuan: detik.	123
Title	string	Judul video.	Alibaba Cloud VOD Video Title
SpriteSnapshots	array	Daftar sprite.
	string	Daftar sprite.	{“http://example.aliyundoc.com/image02.jpg”}
Snapshots	array	Daftar snapshot yang diambil secara otomatis.
	string	Daftar snapshot yang diambil secara otomatis.	{“http://example.aliyundoc.com/image03.jpg”}
ReferenceId	string	ID kustom. Dapat berisi huruf kecil, huruf besar, angka, tanda hubung (-), dan garis bawah (_). ID harus terdiri dari 6 hingga 64 karakter dan unik untuk setiap pengguna.	123-123
Audio	object	Informasi audio.
Status	string	Status. Nilai yang valid: Uploading: Audio sedang diunggah. Normal: Audio dalam keadaan normal. UploadFail: Pengunggahan audio gagal. Deleted: Audio telah dihapus.	Normal
CreationTime	string	Waktu saat audio dibuat. Waktu dalam format UTC yyyy-MM-ddTHH:mm:ssZ.	2018-07-19T03:45:25Z
StorageLocation	string	Wilayah penyimpanan.	outin-aaa*****aa.oss-cn-shanghai.aliyuncs.com
CateId	integer	ID kategori.	10000123
Tags	string	Tag.	tag1,tag2
ModificationTime	string	Waktu terakhir audio diperbarui. Waktu dalam format UTC yyyy-MM-ddTHH:mm:ssZ.	2018-07-19T03:48:25Z
MediaSource	string	Sumber. Nilai yang valid: general (Unggahan VOD): File diunggah menggunakan metode biasa. short_video (SDK video pendek): File diunggah ke VOD menggunakan SDK video pendek. Untuk informasi selengkapnya, lihat SDK video pendek. editing (Pengeditan daring): File diunggah ke VOD setelah disintesis menggunakan pengeditan daring. Untuk informasi selengkapnya, lihat Sintesis video. live (Rekaman aliran langsung): File diunggah ke VOD setelah direkam dari aliran langsung.	general
Description	string	Deskripsi.	Alibaba Cloud VOD Audio Description
AppId	string	ID aplikasi.	app-****
CoverURL	string	URL gambar mini.	http://example.com/image04.jpg
AudioId	string	ID audio.	a82a2cd7d4e147bbed6c1ee372****
DownloadSwitch	string	Sakelar unduhan. Unduhan offline hanya diizinkan ketika sakelar diaktifkan. Nilai yang valid: on: Keadaan awal. Unduhan offline diizinkan. off: Unduhan offline dinonaktifkan.	on
CateName	string	Nama kategori.	cate1
TranscodeMode	string	Mode transkoding. Nilai yang valid: FastTranscode (Transkoding Normal, default): Transkoding dimulai segera setelah pengunggahan selesai. Pemutaran tersedia setelah transkoding selesai. NoTranscode (Distribusi tanpa transkoding): Tidak ada transkoding setelah pengunggahan selesai. Pemutaran tersedia segera. AsyncTranscode (Distribusi saat pengunggahan dan transkoding asinkron): Pemutaran tersedia segera setelah pengunggahan selesai. Transkoding dilakukan secara asinkron.	FastTranscode
PreprocessStatus	string	Status pra-pemrosesan. Hanya file audio yang telah dipra-pemroses yang dapat digunakan untuk pengarahan aliran langsung. Nilai yang valid: UnPreprocess: Belum dipra-pemroses. Preprocessing: Sedang dipra-pemroses. PreprocessSucceed: Pra-pemrosesan berhasil. PreprocessFailed: Pra-pemrosesan gagal.	UnPreprocess
RestoreExpiration	string	Waktu kedaluwarsa aset media yang dipulihkan.	2023-03-30T10:14:14Z
RestoreStatus	string	Keadaan dipulihkan aset media. Nilai yang valid: Processing: Sedang memulihkan. Success: Telah dipulihkan. Failed: Pemulihan gagal.	Success
StorageClass	string	Kelas penyimpanan aset media. Nilai yang valid: Standard: Standard. IA: IA. Archive: Archive. ColdArchive: Cold Archive. SourceIA: Source IA. SourceArchive: Source Archive. SourceColdArchive: Source Cold Archive. Changing: Kelas penyimpanan sedang diubah.	Standard
Size	integer	Ukuran.	123
Duration	number	Durasi.	123
Title	string	Judul.	Alibaba Cloud VOD Audio Title
SpriteSnapshots	array	Daftar sprite.
	string	Daftar sprite.	{“http://example.aliyundoc.com/image02.jpg”}
Snapshots	array	Daftar snapshot yang diambil secara otomatis.
	string	Daftar snapshot yang diambil secara otomatis.	{“http://example.aliyundoc.com/image03.jpg”}
ReferenceId	string	ID kustom. Dapat berisi huruf kecil, huruf besar, angka, tanda hubung (-), dan garis bawah (_). ID harus terdiri dari 6 hingga 64 karakter dan unik untuk setiap pengguna.	123-123
Image	object	Informasi citra.
StorageLocation	string	Wilayah penyimpanan.	outin-bfefbb90a47c******163e1c7426.oss-cn-shanghai.aliyuncs.com
CreationTime	string	Waktu saat citra dibuat. Waktu dalam format UTC yyyy-MM-ddTHH:mm:ssZ.	2018-07-19T03:45:25Z
Status	string	Status citra. Uploading: Keadaan awal. Citra sedang diunggah. Normal: Citra telah diunggah. UploadFail: Pengunggahan citra gagal.	Uploading
CateId	integer	ID kategori.	1000123
Tags	string	Tag.	tag1
ModificationTime	string	Waktu terakhir citra diperbarui. Waktu dalam format UTC yyyy-MM-ddTHH:mm:ssZ.	2018-07-19T03:48:25Z
CateName	string	Nama kategori.	cate1
Description	string	Deskripsi.	Alibaba Cloud VOD Image Description
AppId	string	ID aplikasi.	app-****
URL	string	URL citra.	https://example.com/****.png
Title	string	Judul.	Alibaba Cloud VOD Image Title
ImageId	string	ID citra.	11130843741se99wqmoes****
AttachedMedia	object	Informasi aset media pendukung.
CreationTime	string	Waktu saat aset dibuat. Waktu dalam format UTC yyyy-MM-ddTHH:mm:ssZ.	2018-07-19T03:45:25Z
Status	string	Status. Nilai yang valid: Uploading: Keadaan awal. Aset media pendukung sedang diunggah. Normal: Aset media pendukung telah diunggah. UploadFail: Pengunggahan aset media pendukung gagal.	Normal
StorageLocation	string	Wilayah penyimpanan.	outin-bfefbb90a47c11*****7426.oss-cn-shanghai.aliyuncs.com
Tags	string	Tag.	tag1
ModificationTime	string	Waktu terakhir aset diperbarui. Waktu dalam format UTC yyyy-MM-ddTHH:mm:ssZ.	2018-07-19T03:48:25Z
MediaId	string	ID aset media pendukung.	a82a2cd7d4e147ba0ed6c1ee372****
BusinessType	string	Jenis bisnis. Nilai yang valid: watermark: watermark. subtitle: subtitle. material: material.	watermark
Description	string	Deskripsi.	Alibaba Cloud VOD-assisted media asset description
AppId	string	ID aplikasi.	app-****
URL	string	URL aset media pendukung.	https://example.com/****.png
Title	string	Judul.	Alibaba Cloud VOD-assisted media asset Title
Categories	array<object>	Daftar ID kategori.
	object	Detail kategori.
ParentId	integer	ID node induk.	-1
CateName	string	Nama kategori.	cate1
CateId	integer	ID kategori.	10027394
Level	integer	Tingkat kategori.	1

Contoh

Respons sukses

JSONformat

{
  "RequestId": "3E0CEF83-FB09-4E34-BA1451814B03****",
  "Total": 10,
  "ScrollToken": "24e0fba7188fae707e146esa54****",
  "MediaList": [
    {
      "CreationTime": "2018-07-19T03:45:25Z",
      "MediaType": "video",
      "MediaId": "a82a2cd7d4e147bbed6c1ee372****",
      "Video": {
        "Status": "UploadSucc",
        "CreationTime": "2018-07-19T03:45:25Z",
        "StorageLocation": "outin-bfefbb90a47c******163e1c7426.oss-cn-shanghai.aliyuncs.com",
        "CateId": 10000123,
        "Tags": "tag1",
        "ModificationTime": "2018-07-19T03:48:25Z",
        "MediaSource": "general",
        "Description": "Alibaba Cloud VOD video description",
        "AppId": "app-****",
        "CoverURL": "https://example.aliyundoc.com/image01.png",
        "VideoId": "a82a2asdasqadaf3faa0ed6c1ee372****",
        "DownloadSwitch": "on",
        "CateName": "video1",
        "TranscodeMode": "FastTranscode",
        "PreprocessStatus": "Preprocessing",
        "RestoreExpiration": "2023-03-30T10:14:14Z",
        "RestoreStatus": "Success",
        "StorageClass": "Standard",
        "Size": 123,
        "Duration": 123,
        "Title": "Alibaba Cloud VOD Video Title",
        "SpriteSnapshots": [
          "{“http://example.aliyundoc.com/image02.jpg”}"
        ],
        "Snapshots": [
          "{“http://example.aliyundoc.com/image03.jpg”}"
        ],
        "ReferenceId": "123-123"
      },
      "Audio": {
        "Status": "Normal",
        "CreationTime": "2018-07-19T03:45:25Z",
        "StorageLocation": "outin-aaa*****aa.oss-cn-shanghai.aliyuncs.com",
        "CateId": 10000123,
        "Tags": "tag1,tag2",
        "ModificationTime": "2018-07-19T03:48:25Z",
        "MediaSource": "general",
        "Description": "Alibaba Cloud VOD Audio Description",
        "AppId": "app-****",
        "CoverURL": "http://example.com/image04.jpg",
        "AudioId": "a82a2cd7d4e147bbed6c1ee372****",
        "DownloadSwitch": "on",
        "CateName": "cate1",
        "TranscodeMode": "FastTranscode",
        "PreprocessStatus": "UnPreprocess",
        "RestoreExpiration": "2023-03-30T10:14:14Z",
        "RestoreStatus": "Success",
        "StorageClass": "Standard",
        "Size": 123,
        "Duration": 123,
        "Title": "Alibaba Cloud VOD Audio Title",
        "SpriteSnapshots": [
          "{“http://example.aliyundoc.com/image02.jpg”}"
        ],
        "Snapshots": [
          "{“http://example.aliyundoc.com/image03.jpg”}"
        ],
        "ReferenceId": "123-123"
      },
      "Image": {
        "StorageLocation": "outin-bfefbb90a47c******163e1c7426.oss-cn-shanghai.aliyuncs.com",
        "CreationTime": "2018-07-19T03:45:25Z",
        "Status": "Uploading",
        "CateId": 1000123,
        "Tags": "tag1",
        "ModificationTime": "2018-07-19T03:48:25Z",
        "CateName": "cate1",
        "Description": "Alibaba Cloud VOD Image Description",
        "AppId": "app-****",
        "URL": "https://example.com/****.png",
        "Title": "Alibaba Cloud VOD Image Title",
        "ImageId": "11130843741se99wqmoes****"
      },
      "AttachedMedia": {
        "CreationTime": "2018-07-19T03:45:25Z",
        "Status": "Normal",
        "StorageLocation": "outin-bfefbb90a47c11*****7426.oss-cn-shanghai.aliyuncs.com",
        "Tags": "tag1",
        "ModificationTime": "2018-07-19T03:48:25Z",
        "MediaId": "a82a2cd7d4e147ba0ed6c1ee372****",
        "BusinessType": "watermark",
        "Description": "Alibaba Cloud VOD-assisted media asset description",
        "AppId": "app-****",
        "URL": "https://example.com/****.png",
        "Title": "Alibaba Cloud VOD-assisted media asset Title",
        "Categories": [
          {
            "ParentId": -1,
            "CateName": "cate1",
            "CateId": 10027394,
            "Level": 1
          }
        ]
      }
    }
  ]
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.