Gunakan GetCategories untuk mengkueri informasi kategori dan subkategori - ApsaraVideo VOD - Alibaba Cloud - ApsaraVideo VOD

Mengkueri informasi tentang kategori tertentu dan subkategorinya berdasarkan ID atau tipe kategori.

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

list

*All Resource

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
CateId	integer	No	ID kategori. Jika Anda menentukan parameter ini, sistem mengkueri kategori berdasarkan ID. Anda hanya dapat menentukan satu ID kategori. Anda dapat menggunakan salah satu metode berikut untuk memperoleh ID: Masuk ke Konsol ApsaraVideo VOD. Pilih Manajemen Konfigurasi > Manajemen media > Kategori. Pada tab Kategori Audio dan Video / Image atau Kategori Materi Video Pendek, Tampilan ID kategori. Peroleh ID kategori dari tanggapan operasi AddCategory.	49339****
PageNo	integer	No	Nomor halaman tempat subkategori yang akan dikembalikan terdaftar. Nilai default: 1.	1
PageSize	integer	No	Jumlah entri yang dikembalikan pada setiap halaman daftar subkategori. Nilai default: 10. Nilai maksimum: 100.	10
SortBy	string	No	Metode pengurutan hasil. Nilai valid: CreationTime:Desc (default): Hasil diurutkan dalam Pesanan kronologis terbalik berdasarkan pengatur waktu pembuatan. CreationTime:Asc: Hasil diurutkan dalam Pesanan kronologis berdasarkan pengatur waktu pembuatan.	CreationTime:Desc
Type	string	No	Tipe kategori. Jika Anda menentukan parameter ini, sistem mengkueri kategori berdasarkan tipe. Nilai valid: default (default): file audio, video, dan image material: materi video pendek.	default

Elemen respons

Element	Type	Description	Example
	object	The response parameters.
SubTotal	integer	The total number of subcategories.	3795
RequestId	string	The ID of the request.	25818875-5F78-4AF6-D7393642CA58****
Category	object	The information about the category.
Type	string	The type of the category. Valid values: default: audio, video, and image files material: short video materials	default
ParentId	integer	The ID of the parent category.	100012****
CateName	string	The name of the category.	film
CateId	integer	The ID of the category.	100
Level	integer	The level of the category. Valid values: 0: level 1 category 1: level 2 category 2: level 3 category	0
SubCategories	object
Category	array<object>	The details of the subcategory.
	object
Type	string	The type of the subcategory. Valid values: default: audio, video, and image files material: short video materials	default
CateName	string	The name of the category.	film
ParentId	integer	The ID of the parent category.	10020****
CateId	integer	The ID of the category.	100
SubTotal	integer	The total number of subcategories.	1
Level	integer	The level of the category. Valid values: 0: level 1 category 1: level 2 category 2: level 3 category	1

Contoh

Respons sukses

JSONformat

{
  "SubTotal": 3795,
  "RequestId": "25818875-5F78-4AF6-D7393642CA58****",
  "Category": {
    "Type": "default",
    "ParentId": 0,
    "CateName": "film",
    "CateId": 100,
    "Level": 0
  },
  "SubCategories": {
    "Category": [
      {
        "Type": "default",
        "CateName": "film",
        "ParentId": 0,
        "CateId": 100,
        "SubTotal": 1,
        "Level": 1
      }
    ]
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.