Menanyakan detail satu atau beberapa kategori di bawah ruang kerja yang ditentukan.
Deskripsi operasi
- Mengkueri tabel data melalui API belum didukung.
- Pengguna RAM (sub-akun) harus terlebih dahulu mendapatkan izin API untuk Alibaba Cloud Model Studio (
AliyunBailianDataFullAccessdiperlukan, yang sudah mencakup izin sfm:ListCategory) dan bergabung dengan ruang kerja sebelum dapat memanggil API ini. Akun Alibaba Cloud (akun utama) dapat memanggil API ini secara langsung tanpa otorisasi. Kami menyarankan Anda memanggil API ini menggunakan versi terbaru dari Alibaba Cloud Model Studio SDK. - Saat mengkueri halaman pertama dari kueri paginasi, Anda hanya perlu mengatur
MaxResultsuntuk membatasi jumlah entri yang dikembalikan.NextTokendalam hasil yang dikembalikan berfungsi sebagai token untuk mengkueri halaman berikutnya. Saat mengkueri halaman berikutnya, atur parameterNextTokenkeNextTokenyang diperoleh dari respons sebelumnya sebagai token kueri (jikaNextTokenkosong, semua hasil telah dikembalikan dan tidak diperlukan permintaan lebih lanjut), dan aturMaxResultsuntuk membatasi jumlah entri yang dikembalikan. - API ini bersifat idempoten.
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.
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
Actionpada 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
Resourcepada kebijakan. - Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen
Resourcepada kebijakan.
- 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
- 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 |
|---|---|---|---|---|
sfm:ListCategory | list | *全部资源
| None | None |
Sintaks permintaan
Path Parameters
Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| WorkspaceId | string | Yes | ID ruang kerja. Untuk informasi tentang cara mendapatkannya, lihat Cara menggunakan ruang kerja. | llm-3shx2gu255oqxxxx |
Parameter permintaan
Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| ConnectorId | string | No | ID Konektor | file_conn_xxxxx |
| CategoryType | string | Yes | Tipe kategori yang akan dikueri. Nilai yang valid:
Mengkueri tabel data terstruktur melalui API belum didukung. | UNSTRUCTURED |
| ParentCategoryId | string | No | ID kategori induk dari kategori yang akan dikueri. | cate_cdd11b1b79a74e8bbd675c356a91ee3xxxxxxxx |
| NextToken | string | No | Token kueri. Atur nilai ini ke nilai NextToken yang dikembalikan oleh panggilan API sebelumnya. | AAAAAdH70eOCSCKtacdomNzak4U= |
| MaxResults | integer | No | Jumlah kategori yang dikembalikan per halaman dalam kueri paginasi. Nilai maksimum adalah 200. Rentang nilai yang valid: [1-200]. Nilai default: Jika parameter ini tidak diatur atau diatur ke nilai kurang dari 1, nilai defaultnya adalah 20. Jika diatur ke nilai lebih besar dari 200, nilai defaultnya adalah 200. | 20 |
| CategoryName | string | No | Melakukan pencocokan/penyaringan eksak pada daftar kategori yang dikembalikan oleh API berdasarkan nama kategori. Nilai defaultnya kosong, yang berarti penyaringan nama kategori dinonaktifkan. | 产品清单 |
Elemen respons
Element | Type | Description | Example |
|---|---|---|---|
object | Schema of Response | ||
| Code | string | Kode status kesalahan. | success |
| Data | object | Bidang data bisnis yang dikembalikan oleh API. | |
| CategoryList | array<object> | Daftar kategori. | |
object | Objek kategori. | ||
| CategoryId | string | The category ID. | cate_cdd11b1b79a74e8bbd675c356a91ee3xxxxxxxx |
| CategoryName | string | The category name. | 类目1 |
| CategoryType | string | The category type. Valid value:
| UNSTRUCTURED |
| IsDefault | boolean | Indicates if this is the default category. Valid values:
You cannot delete the default category. | true |
| ParentCategoryId | string | The parent category ID. | cate_addd11b1b79a74e8bbd675c356a91ee3xxxxxxxx |
| HasNext | boolean | Menunjukkan apakah ada halaman berikutnya dari data kategori yang sesuai dengan kriteria kueri. Kemungkinan nilai:
| true |
| MaxResults | integer | Jumlah kategori yang dikembalikan per halaman dalam kueri paginasi. | 20 |
| NextToken | string | Token kueri yang dikembalikan oleh panggilan ini. | AAAAALHWGpGoYCcYMxiFfmlhvh7Z4G8jiXR6IjHYd+M9WQVJ |
| TotalCount | integer | Jumlah total kategori dalam hasil yang dikembalikan. | 20 |
| Message | string | Pesan kesalahan. | workspace id is null or invalid. |
| RequestId | string | ID permintaan. | 17204B98-xxxx-4F9A-8464-2446A84821CA |
| Status | string | Kode status yang dikembalikan oleh API. | 200 |
| Success | boolean | Menunjukkan apakah panggilan API berhasil. Kemungkinan nilai:
| true |
Contoh
Respons sukses
JSONformat