获取指定类目下一个或多个文档的详细信息。
接口说明
-
分页查询首页时，仅需设置
MaxResults以限制返回信息的条目数，返回结果中的NextToken将作为查询后续页的凭证。查询后续页时，将NextToken参数设置为上一次返回结果中获取到的NextToken作为查询凭证（如果NextToken为空，表示结果已经完全返回，不需要再请求），并设置MaxResults限制返回条目数。 -
本接口具有幂等性。
限流说明： 本接口频繁调用会被限流，频率请勿超过 5 次/秒。如遇限流，请稍后重试。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| sfm:ListFile | list | *全部资源 * |
| 无 |
请求语法
GET /{WorkspaceId}/datacenter/files HTTP/1.1
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| WorkspaceId | string | 是 | 类目所属的业务空间 ID。在百炼的控制台首页，单击页面左上角业务空间详情图标获取。 | llm-3shx2gu255oqxxxx |
| CategoryId | string | 是 | 类目 ID，即 AddCategory 接口返回的 | cate_cdd11b1b79a74e8bbd675c356a91ee35xxxxxxxx |
| NextToken | string | 否 | 查询凭证（Token），取值为上一次 API 调用返回的 NextToken 参数值。 | AAAAAdH70eOCSCKtacdomNzak4U= |
| MaxResults | integer | 否 | 分页查询时每页行数。取值范围[1-200]。 默认值： 当不设置值或设置的值小于 1 时，默认值为 20。当设置的值大于 200 时，默认值为 200。 | 20 |
| FileName | string | 否 | 文件名称（不含后缀），仅支持按照文件名精准查找，不支持模糊搜索。 | 测试文件名 |
返回参数
示例
正常返回示例
JSON格式
{
"Code": "success",
"Data": {
"FileList": [
{
"CategoryId": "cate_cdd11b1b79a74e8bbd675c356a91ee35xxxxxxxx",
"CreateTime": "2024-09-09 11:03:35",
"FileId": "file_5ff599b3455a45db8c41b0054b361518_xxxxxxxx",
"FileName": "XXX产品介绍.pdf",
"FileType": "docx",
"Parser": "DASHSCOPE_DOCMIND",
"SizeInBytes": 512,
"Status": "PARSE_SUCCESS",
"Tags": [
"产品介绍"
]
}
],
"HasNext": true,
"MaxResults": 20,
"NextToken": "4jzbJk9J6lNeuXD9hP0viA==",
"TotalCount": 48
},
"Message": "Requests throttling triggered.",
"RequestId": "8F97A63B-xxxx-527F-9D6E-467B6A7E8CF1",
"Status": "200",
"Success": true
}错误码
访问错误中心查看更多错误码。