在指定的业务空间中创建一个类目,用于分类和管理文件。每个业务空间最多创建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格式