ListDocuments - 查询文档列表-数据管理 DMS-阿里云帮助中心

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求语法

POST  HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
KbUuid	string	是	知识库 ID。	kb-***
NextToken	string	否	分页游标标识。说明如果不设置该参数，则表示获取第一页的数据。当该参数有返回值时，说明还有下一页，您可以将返回的 NextToken 作为参数再次请求获得下一页的数据，直到返回为 Null 为止，表示获取到了所有的数据。	zCXSmY0CJbybp6FZV7vo0Wjw64X-*****
MaxResults	integer	否	每页的最大数据条数。取值范围：1~100。默认值：20。	20
NamePattern	string	否	文档名称过滤，返回文档名称中包含该值的文档	test
SortFieldName	string	否	排序字段，取值： id：文档 ID（默认值）。 hits：热度。 modifyTime：修改时间。	hits
SortOrder	string	否	排序方向，取值范围： ASC（默认值）：升序。 DESC：降序。	DESC
Filters	string	否	文档属性过滤，支持以下两种属性： fileExt：文档扩展类型。 state：文档状态。	{"fileExt":"pdf","state":0}

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	本次调用的唯一 ID。出现错误后，您可以根据该 ID 排查问题。	67E910F2-4B62-5B0C-ACA3-7547695C****
TotalCount	integer	满足条件的文档总数（目前暂不支持，返回值恒定为 0）。	0
Data	array	文档列表。
	OneMetaKnowledgeBaseDocument	返回结构体
NextToken	string	分页游标标识。	zCXSmY0CJbybp6FZV7vo0Wjw64X-*****
MaxResults	integer	分页大小。	20
Success	boolean	请求是否成功，返回值如下： true：请求成功。 false：请求失败。	true
ErrorCode	string	错误码，请求异常时返回。	KnowledgeBaseNotFound
ErrorMessage	string	调用失败时，返回的错误信息。	Resource not found kb-***

示例

正常返回示例

JSON格式

{
  "RequestId": "67E910F2-4B62-5B0C-ACA3-7547695C****",
  "TotalCount": 0,
  "Data": [
    {
      "KbUuid": "",
      "Name": "",
      "Description": "",
      "FileExt": "",
      "DocumentLoaderName": "",
      "TextSplitterName": "",
      "GmtCreate": "",
      "GmtModified": "",
      "FileSize": 0,
      "DocsCount": 0,
      "State": 0,
      "Summary": "",
      "Keywords": ""
    }
  ],
  "NextToken": "zCXSmY0CJbybp6FZV7vo0Wjw64X-*****",
  "MaxResults": 20,
  "Success": true,
  "ErrorCode": "KnowledgeBaseNotFound",
  "ErrorMessage": "Resource not found kb-***"
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。