Buat sebuah kategori dalam ruang bisnis yang ditentukan untuk mengklasifikasikan dan mengelola file. Setiap ruang bisnis dapat membuat maksimal 500 kategori.
Deskripsi operasi
- Penambahan tabel data melalui API tidak didukung, silakan lakukan melalui Data Aplikasi di konsol.
- Pengguna RAM (sub-akun) harus terlebih dahulu memperoleh izin API Alibaba Cloud Bailian (memerlukan
AliyunBailianDataFullAccess, yang sudah mencakup titik izin sfm:AddCategory), dan bergabung dengan suatu ruang bisnis, barulah dapat memanggil antarmuka ini. Akun Alibaba Cloud (akun utama) dapat langsung memanggil tanpa otorisasi. Disarankan untuk memanggil antarmuka ini melalui versi terbaru SDK Alibaba Cloud Bailian. - Antarmuka ini tidak bersifat idempoten.
Penjelasan pembatasan laju: Pemanggilan antarmuka ini secara sering akan dibatasi, frekuensinya jangan melebihi 5 kali/detik. Jika terkena pembatasan, silakan coba lagi nanti.
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:AddCategory | create | *全部资源
| None | None |
Sintaks permintaan
POST /{WorkspaceId}/datacenter/category/ HTTP/1.1
Path Parameters
Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| WorkspaceId | string | Yes | ID ruang bisnis, yaitu ruang bisnis tempat kategori baru ditambahkan. Untuk cara memperolehnya, lihat Cara menggunakan ruang bisnis. | llm-3z7uw7fwz0vxxxx |
Parameter permintaan
Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| CategoryName | string | Yes | Nama kategori. Panjangnya 1~20 karakter, mendukung karakter di bawah klasifikasi letter dalam Unicode (termasuk bahasa Inggris, bahasa Cina, dan angka, dll.). Dapat berisi titik dua setengah lebar (:), garis bawah (_), titik setengah lebar (.), atau tanda hubung (-). | 产品清单 |
| CategoryType | string | Yes | Jenis kategori. Rentang nilai:
| UNSTRUCTURED |
| ParentCategoryId | string | No | ID kategori dari kategori induk. Buat kategori baru di bawah kategori induk ini; jika nilai ini kosong, buat kategori tingkat pertama. | cate_cdd11b1b79a74e8bbd675c356a91ee3xxxxxxxx |
| ConnectorId | string | No | ID instance dari koneksi data (Connector) yang dimiliki, silakan ambil di konsol Bailian. | conn_xxxx |
Elemen respons
Element | Type | Description | Example |
|---|---|---|---|
object | Schema of Response | ||
| Code | string | Kode status error. | success |
| Data | object | Bidang data bisnis antarmuka. | |
| CategoryId | string | ID kategori. Harap simpan nilai ini dengan baik, karena akan digunakan untuk semua operasi API berikutnya yang terkait dengan kategori ini. | cate_cdd11b1b79a74e8bbd675c356a91ee3xxxxxxxx |
| CategoryName | string | Nama kategori. | 类目名称 |
| Message | string | Pesan error. | Requests throttling triggered. |
| RequestId | string | ID permintaan. | 778C0B3B-xxxx-5FC1-A947-36EDD13606AB |
| Status | string | Kode status yang dikembalikan oleh antarmuka. | 200 |
| Success | boolean | Apakah pemanggilan antarmuka berhasil, kemungkinan nilainya adalah:
| true |
Contoh
Respons sukses
JSONformat
{
"Code": "success",
"Data": {
"CategoryId": "cate_cdd11b1b79a74e8bbd675c356a91ee3xxxxxxxx",
"CategoryName": "类目名称"
},
"Message": "Requests throttling triggered.",
"RequestId": "778C0B3B-xxxx-5FC1-A947-36EDD13606AB",
"Status": "200",
"Success": true
}
Kode kesalahan
Lihat Error Codes untuk daftar lengkap.
Catatan rilis
Lihat Release Notes untuk daftar lengkap.