ListIndexDocuments_大模型服务平台百炼_API文档-阿里云OpenAPI开发者门户

接口说明

RAM 用户（子账号）需要首先获取百炼的数据权限（需要AliyunBailianDataFullAccess，已包括 sfm:ListIndexFiles 权限点），然后才能调用本接口，详见为 RAM 用户授予数据权限。阿里云账号（主账号）可直接调用无须授权。建议您通过最新版百炼 SDK来调用本接口。
调用本接口前，请确保您的知识库已经创建完成且未被删除（即知识库 IDIndexId有效）。
本接口具有幂等性。

限流说明： 本接口频繁调用会被限流，频率请勿超过 15 次/秒。如遇限流，请稍后重试。

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

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

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

sfm:ListIndexFiles	List	全部资源 *	无	无

GET /{WorkspaceId}/index/list_index_documents HTTP/1.1

字段名称	字段详情
WorkspaceIdstring	知识库所属的业务空间 ID。获取方式请参见如何使用业务空间。示例值:llm-3z7uw7fwz0vexxxx

字段名称	字段详情
IndexIdstring	知识库 ID，即 CreateIndex 接口返回的`Data.Id`。示例值:79c0alxxxx参考取值来源: SubmitIndexJob
DocumentStatusstring	即通过文档导入状态对接口返回的文档列表进行过滤。取值范围：展开详情示例值:FINISH枚举值:INSERT_ERRORRUNNINGDELETEDFINISH
DocumentNamestring	即通过文档名称对接口返回的文档列表进行过滤。默认值为空，即不使用文档名称对结果进行过滤。示例值:翻译平台运维文档
PageNumberinteger<int32>	指定要查询的页码。起始值为 1。默认值为 1。示例值:1
PageSizeinteger<int32>	指定分页查询时每页展示的文档数量。最大值不限。展开详情示例值:10

字段名称	字段详情
RequestIdstring	请求 ID。示例值:35A267BF-xxxx-54DB-8394-AA3B0742D833
Codestring	错误状态码。示例值:InvalidParameter
Messagestring	错误信息。示例值:Required parameter(%s) missing or invalid, please check the request parameters.
Successboolean	接口调用是否成功，可能值：展开详情示例值:true
Dataobject	接口业务数据字段。
Statusstring	接口返回的状态码。示例值:200

	变更时间	变更内容概要	操作
	2025-03-25	变更返回参数