获取指定知识库中的文件，以及它们的概要信息。
接口说明
- RAM 用户（子账号）需要首先获取阿里云百炼的 API 权限（需要
AliyunBailianDataFullAccess，已包括 sfm:ListIndexFiles 权限点），并加入一个业务空间后，方可调用本接口。阿里云账号（主账号）可直接调用无须授权。建议您通过最新版阿里云百炼 SDK来调用本接口。 - 调用本接口前，请确保您的知识库已经创建完成且未被删除（即知识库 ID
IndexId有效）。 - 本接口具有幂等性。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
-
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
sfm:ListIndexFiles | list | *全部资源
| 无 | 无 |
请求语法
路径参数
名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| WorkspaceId | string | 是 | 知识库所属的业务空间 ID。获取方式请参见如何使用业务空间。 | llm-3z7uw7fwz0vexxxx |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| IndexId | string | 是 | 知识库 ID，即 CreateIndex 接口返回的 | 79c0alxxxx |
| DocumentStatus | string | 否 | 即通过文件导入状态对接口返回的文件列表进行过滤。取值范围：
默认值为空，即不使用文件导入状态对结果进行过滤。 | FINISH |
| DocumentName | string | 否 | 即通过文件名称（不含后缀）对接口返回的文件列表进行过滤。默认值为空，即不使用文件名称对结果进行过滤。 | product-overview |
| EnableNameLike | string | 否 | 是否开启文件名称的模糊匹配，与
默认值为 false。 枚举值：
| false |
| PageNumber | integer | 否 | 指定要查询的页码。起始值为 1。默认值为 1。 | 1 |
| PageSize | integer | 否 | 指定分页查询时每页展示的文件数量。最大值不限。 默认值为 10。 | 10 |
返回参数
名称 | 类型 | 描述 | 示例值 |
|---|---|---|---|
object | Schema of Response | ||
| RequestId | string | 请求 ID。 | 35A267BF-xxxx-54DB-8394-AA3B0742D833 |
| Code | string | 错误状态码。 | InvalidParameter |
| Message | string | 错误信息。 | Required parameter(%s) missing or invalid, please check the request parameters. |
| Success | boolean | 接口调用是否成功，可能值：
| true |
| Data | object | 接口业务数据字段。 | |
| Documents | array<object> | 返回知识库中的文件列表，按文档导入时间倒序排序（与控制台一致）。 | |
object | 文件对象。 | ||
| SourceId | string | cate_21a407a3372c4ba7aedc649709143f0cxxxxxxxx | |
| Id | string | 文件 ID。 | doc_c134aa2073204a5d936d870bf960f56axxxxxxxx |
| Name | string | 文件名称。 | product-overview |
| Size | integer | 文件大小，单位字节 Byte。 | 996765 |
| DocumentType | string | 文件格式类型。可能值为： pdf、docx、doc、txt、md、pptx、ppt、png、jpg、jpeg、bmp、gif、EXCEL。 | |
| Status | string | 文件导入状态。可能值为：
枚举值：
| RUNNING |
| Code | string | 文件导入错误状态码。 | 110002 |
| Message | string | 文件导入错误信息。 | check fileUrlKey[file_path] / fileNameKey[null] / fileExtensionKey[file_extension] is invalid |
| GmtModified | integer | 文件导入知识库的时间，采用 Unix timestamp 格式。 | 1744856423000 |
| IndexId | string | 知识库 ID。 | pno97txxxx |
| TotalCount | integer | 返回结果的总条数。 | 2437 |
| PageNumber | integer | 返回指定的页码。 | 1 |
| PageSize | integer | 返回指定的每页条数。 | 10 |
| Status | string | 接口返回的状态码。 | 200 |
示例
正常返回示例
JSON格式