ListCategory_大模型服务平台百炼_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

  • 暂不支持通过 API 查询结构化数据表。
  • RAM 用户(子账号)需要首先获取百炼的数据权限(需要AliyunBailianDataFullAccess,已包括 sfm:ListCategory 权限点),然后才能调用本接口,详见为 RAM 用户授予数据权限。阿里云账号(主账号)可直接调用无须授权。建议您通过最新版百炼 SDK来调用本接口。
  • 分页查询首页时,仅需设置MaxResults以限制返回信息的条目数,返回结果中的NextToken将作为查询后续页的凭证。查询后续页时,将NextToken参数设置为上一次返回结果中获取到的NextToken作为查询凭证(如果NextToken为空,表示结果已经完全返回,不需要再请求),并设置MaxResults限制返回条目数。
  • 本接口具有幂等性。

限流说明: 注意本接口频繁调用会被限流,频率请勿超过 5 次/秒。如遇限流,请稍后重试。

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
sfm:ListCategory
List
全部资源
*

请求语法

POST /{WorkspaceId}/datacenter/categories HTTP/1.1

路径参数

字段名称字段详情
WorkspaceIdstring

业务空间 ID。获取方式请参见如何使用业务空间

示例值:llm-3shx2gu255oqxxxx

请求参数

字段名称字段详情
CategoryTypestring

要查询的类目类型。取值范围:展开详情

示例值:UNSTRUCTURED枚举值:UNSTRUCTURED
ParentCategoryIdstring

要查询类目的父类目 ID。

示例值:cate_cdd11b1b79a74e8bbd675c356a91ee3xxxxxxxx
NextTokenstring

查询凭证(Token),取值为上一次 API 调用返回的 NextToken 参数值。

示例值:AAAAAdH70eOCSCKtacdomNzak4U=
MaxResultsinteger<int32>

分页查询时每页类目数量。最大值为 200。取值范围[1-200]展开详情

示例值:20取值 <= 500

返回参数

字段名称字段详情
Codestring

错误状态码。

示例值:success
Dataobject

接口业务数据字段。

Messagestring

错误信息。

示例值:workspace id is null or invalid.
RequestIdstring

请求 ID。

示例值:17204B98-xxxx-4F9A-8464-2446A84821CA
Statusstring

接口返回的状态码。

示例值:200
Successboolean

接口调用是否成功,可能值为:展开详情

示例值:true

返回示例

变更历史

暂无变更历史

相关示例