GetCategories - ApsaraVideo VOD

Mengambil informasi kategori tertentu beserta subkategorinya berdasarkan ID atau tipe kategori tersebut.

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 akan mengambil kategori berdasarkan ID tersebut. Anda hanya dapat menentukan satu ID kategori. Anda dapat memperoleh ID tersebut dengan salah satu cara berikut: Masuk ke Konsol ApsaraVideo VOD. Pilih Configuration Management > Media Management > Categories. Pada tab Audio and Video / Image Category atau Short Video Material Category, lihat ID kategori tersebut. Ambil ID kategori dari respons operasi AddCategory.	49339****
PageNo	integer	No	Nomor halaman tempat subkategori yang akan dikembalikan tercantum. 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 yang valid: CreationTime:Desc (default): Hasil diurutkan secara menurun berdasarkan waktu pembuatan. CreationTime:Asc: Hasil diurutkan secara menaik berdasarkan waktu pembuatan.	CreationTime:Desc
Type	string	No	Tipe kategori. Jika Anda menentukan parameter ini, sistem akan mengambil kategori berdasarkan tipe tersebut. Nilai yang valid: default (default): file audio, video, dan citra material: materi video pendek	default

Elemen respons

Element	Type	Description	Example
	object	Parameter respons.
SubTotal	integer	Total jumlah subkategori.	3795
RequestId	string	ID permintaan.	25818875-5F78-4AF6-D7393642CA58****
Category	object	Informasi mengenai kategori.
Type	string	Tipe kategori. Nilai yang valid: default: file audio, video, dan citra material: materi video pendek	default
ParentId	integer	ID kategori induk.	100012****
CateName	string	Nama kategori.	film
CateId	integer	ID kategori.	100
Level	integer	Tingkat kategori. Nilai yang valid: 0: Kategori tingkat 1 1: Kategori tingkat 2 2: Kategori tingkat 3	0
SubCategories	object
Category	array<object>	Detail subkategori.
	object	Daftar subkategori.
Type	string	Tipe subkategori. Nilai yang valid: default: file audio, video, dan citra material: materi video pendek	default
CateName	string	Nama kategori.	film
ParentId	integer	ID kategori induk.	10020****
CateId	integer	ID kategori.	100
SubTotal	integer	Total jumlah subkategori.	1
Level	integer	Tingkat kategori. Nilai yang valid: 0: Kategori tingkat 1 1: Kategori tingkat 2 2: Kategori tingkat 3	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.