在指定的業務空間中建立一個類目,用於分類和管理檔案。每個業務空間最多建立500個類目。
介面說明
- 不支援通過 API 新增資料表,請通過控制台的應用資料操作。
- RAM 使用者(子帳號)需要首先擷取阿里雲百鍊的 API 許可權(需要
AliyunBailianDataFullAccess,已包括 sfm:AddCategory 許可權點),並加入一個業務空間後,方可調用本介面。阿里雲帳號(主帳號)可直接調用無須授權。建議您通過最新版阿里雲百鍊 SDK來調用本介面。 - 本介面不具備等冪性。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
授權資訊
下表是API對應的授權資訊,可以在RAM權限原則語句的Action元素中使用,用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下:
- 操作:是指具體的許可權點。
- 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。
-
資源類型:是指操作中支援授權的資源類型。具體說明如下:
- 對於必選的資源類型,用前面加 * 表示。
- 對於不支援資源級授權的操作,用
全部資源表示。
- 條件關鍵字:是指雲產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。
操作 | 存取層級 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
sfm:AddCategory | create | *全部資源
| 無 | 無 |
請求文法
路徑參數
名稱 | 類型 | 必填 | 描述 | 樣本值 |
|---|---|---|---|---|
| WorkspaceId | string | 是 | 業務空間 ID,即在該業務空間中新增類目。擷取方式請參見如何使用業務空間。 | llm-3z7uw7fwz0vxxxx |
請求參數
名稱 | 類型 | 必填 | 描述 | 樣本值 |
|---|---|---|---|---|
| CategoryName | string | 是 | 類目名稱。長度為 1~20 個字元,支援 Unicode 中 letter 分類下的字元(其中包括英文、中文和數字等)。可以包含半形冒號(:)、底線(_)、半形句號(.)或者短劃線(-)。 | 產品清單 |
| CategoryType | string | 是 | 類目類型。取值範圍:
| UNSTRUCTURED |
| ParentCategoryId | string | 否 | 父類目的類目 ID。在此父類目下建立新類目,此值為空白時建立一級類目。 | cate_cdd11b1b79a74e8bbd675c356a91ee3xxxxxxxx |
| ConnectorId | string | 否 | 所屬資料連線(Connector)的執行個體 id,請到百鍊控制台擷取。 | conn_xxxx |
返回參數
名稱 | 類型 | 描述 | 樣本值 |
|---|---|---|---|
object | Schema of Response | ||
| Code | string | 錯誤狀態代碼。 | success |
| Data | object | 介面業務資料欄位。 | |
| CategoryId | string | 類目 ID。請妥善保管該值,它將用於後續所有與此類目相關的 API 操作。 | cate_cdd11b1b79a74e8bbd675c356a91ee3xxxxxxxx |
| CategoryName | string | 類目名稱。 | 類目名稱 |
| Message | string | 錯誤資訊。 | Requests throttling triggered. |
| RequestId | string | 請求 ID。 | 778C0B3B-xxxx-5FC1-A947-36EDD13606AB |
| Status | string | 介面返回的狀態代碼。 | 200 |
| Success | boolean | 介面調用是否成功,可能值為:
| true |
樣本
正常返回樣本
JSON格式