ListKnowledgeFiles - 查询知识库文件-云原生数据仓库AnalyticDB(AnalyticDB)-阿里云帮助中心

查询知识库文件

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

adb:ListKnowledgeFiles

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
DBClusterId	string	是	ADB 实例 ID	am-bp19aaaaaa****
FileIds	string	否	文件 ID 数组的 JSON 字符串，最多 200 个正整数。	[1001,1002,1003]
Status	string	否	处理状态：PENDING、PROCESSING、COMPLETED、FAILED、DUPLICATED 或 SKIPPED。	FAILED
User	string	否	授权用户稳定 ID；不传表示全库可查。	u123
Page	string	否	页码，从 1 开始；不传时 Ray 默认为 1。	1
PageSize	string	否	每页条数，范围 1～100；不传时 Ray 默认为 20。	20

返回参数

名称	类型	描述	示例值
	object	Schema of Response
Data	object	返回数据。
Files	array<object>	文件信息列表。
	object	文件信息。
CreatedAt	string	入库时间，格式为 yyyy-MM-dd HH:mm:ss。	2026-06-09 10:27:35
FileId	integer	文件的 ID。	137
FileSizeBytes	integer	文件的大小。	1024
FileUrl	string	文件 OSS 地址。	oss://bucketName/path/to/file
Format	string	格式。	mp4
IsDirectory	boolean	是否是目录。	false
OwnerFileId	integer	内容宿主 `file_id`。	122
PageCount	integer	文件总页数（如 pdf 文件页数）	2
ProcessMessage	string	知识库文件处理信息。	successful
ProcessStatus	string	文件在知识库的状态，可能的取值： Processing: 进行中。 Finished：已完成。	Finished
UpdatedAt	string	更新时间，格式为 yyyy-MM-dd HH:mm:ss。	2026-06-10 10:23:46
Message	string	请求返回信息。	Successful
Page	integer	当前页数。	1
PageSize	integer	每页记录数。	20
Success	boolean	请求是否成功，取值说明： true：成功。 false：失败。	true
Total	integer	总记录数。	100
RequestId	string	Id of the request	1AD222E9-E606-4A42-BF6D-8A4442913CEF

示例

正常返回示例

JSON格式

{
  "Data": {
    "Files": [
      {
        "CreatedAt": "2026-06-09 10:27:35",
        "FileId": 137,
        "FileSizeBytes": 1024,
        "FileUrl": "oss://bucketName/path/to/file",
        "Format": "mp4",
        "IsDirectory": false,
        "OwnerFileId": 122,
        "PageCount": 2,
        "ProcessMessage": "successful",
        "ProcessStatus": "Finished",
        "UpdatedAt": "2026-06-10 10:23:46"
      }
    ],
    "Message": "Successful",
    "Page": 1,
    "PageSize": 20,
    "Success": true,
    "Total": 100
  },
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF"
}

错误码

HTTP status code	错误码	错误信息	描述
400	MDS.CatalogAlreadyExist	The catalog already exists.	目录已经存在
400	MDS.IllegalArgument	Invalid argument.	用户使用了非法参数
400	MDS.InvalidPrivilege	No permissions.	用户无权限进行操作
400	MDS.MetaSchemaAlreadyExist	The database already exists.	数据库已存在
400	MDS.MetaSchemaNotExist	The database does not exist.	操作的数据库不存在
400	MDS.MetaTableAlreadyExist	The table already exists.	操作的表已经存在
400	MDS.MetaTableNotExist	The table is not found.	操作的表不存在
400	MDS.SemanticViewAlreadyExist	The semantic view already exists.	此语义视图已经存在
500	MDS.InternalError	An internal MDS error occurred.	MDS服务内部错误
500	MDS.MetaVisitError	Failed to access metadata.	访问元数据失败
403	MDS.RamAuthAccessDenied	ram auth access denied.	RAM鉴权失败
404	MDS.InstanceNotExist	ADB instance does not exist.	ADB 实例不存在

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

变更历史

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