获取文档库内文档列表，可分页查询，也根据文档状态进行过滤查询。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| dianjin:GetDocumentList | get | *全部资源 * |
| 无 |
请求语法
GET /{workspaceId}/api/library/listDocument HTTP/1.1
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| workspaceId | string | 是 | 路径参数，业务空间 id。 | llm-xxxx |
| page | integer | 否 | 页码 | 1 |
| pageSize | integer | 否 | 页数 | 10 |
| status | string | 否 | 文档状态 | 即将可用 |
| libraryId | string | 是 | 文档库 id | 3akzl28vap |
返回参数
示例
正常返回示例
JSON格式
{
"cost": 0,
"data": {
"currentPage": 1,
"pageSize": 10,
"records": [
{
"docId": "8326748346",
"documentMeta": {
"test": "test",
"test2": 1
},
"fileType": "pdf",
"gmtCreate": "2024-01-01 00:00:00",
"gmtModified": "2024-01-01 00:00:00",
"libraryId": "skjdhshbv",
"statusCode": "WaitRefresh",
"title": "test",
"url": "null"
}
],
"totalPages": 10,
"totalRecords": 100
},
"dataType": "null",
"errCode": "0",
"message": "ok",
"requestId": "5E3FBAF1-17AF-53B7-AF0A-CDCEEB6DE658",
"success": true,
"time": "2024-04-24 11:54:34"
}错误码
访问错误中心查看更多错误码。