ListKnowledgeFiles-阿里云帮助中心

Queries knowledge base files.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

adb:ListKnowledgeFiles

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The ADB instance ID.	am-bp19aaaaaa****
FileIds	string	No	The JSON string of the file ID array, which contains up to 200 positive integers.	[1001,1002,1003]
Status	string	No	The processing status. Valid values: PENDING, PROCESSING, COMPLETED, FAILED, DUPLICATED, and SKIPPED.	FAILED
User	string	No	The stable ID of the authorized user. If this parameter is not specified, all files in the knowledge base can be queried.	u123
Page	string	No	The page number, starting from 1. If this parameter is not specified, the default value is 1.	1
PageSize	string	No	The number of entries per page. Valid values: 1 to 100. If this parameter is not specified, the default value is 20.	20

Response elements

Element	Type	Description	Example
	object	Schema of Response
Data	object	The returned data.
Files	array<object>	The list of file information.
	object	The file information.
CreatedAt	string	The time when the file was added to the knowledge base. The format is yyyy-MM-dd HH:mm:ss.	2026-06-09 10:27:35
FileId	integer	The ID of the file.	137
FileSizeBytes	integer	The size of the file.	1024
FileUrl	string	The OSS URL of the file.	oss://bucketName/path/to/file
Format	string	The format of the file.	mp4
IsDirectory	boolean	Indicates whether the file is a directory.	false
OwnerFileId	integer	The file_id of the content host.	122
PageCount	integer	The total number of pages in the file, such as the number of pages in a PDF file.	2
ProcessMessage	string	The processing information of the knowledge base file.	successful
ProcessStatus	string	The status of the file in the knowledge base. Valid values: Processing: The file is being processed. Finished: The file has been processed.	Finished
UpdatedAt	string	The update time. The format is yyyy-MM-dd HH:mm:ss.	2026-06-10 10:23:46
Message	string	The message returned for the request.	Successful
Page	integer	The current page number.	1
PageSize	integer	The number of entries per page.	20
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
Total	integer	The total number of records.	100
RequestId	string	Id of the request	1AD222E9-E606-4A42-BF6D-8A4442913CEF

Examples

Success response

JSON format

{
  "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"
}

Error codes

HTTP status code	Error code	Error message	Description
400	MDS.CatalogAlreadyExist	The catalog already exists.	Catalog already exists
400	MDS.IllegalArgument	Invalid argument.	An invalid parameter is used.
400	MDS.InvalidPrivilege	No permissions.	You are not authorized to perform this operation.
400	MDS.MetaSchemaAlreadyExist	The database already exists.	The specified database already exists.
400	MDS.MetaSchemaNotExist	The database does not exist.	The specified database does not exist.
400	MDS.MetaTableAlreadyExist	The table already exists.	The specified table already exists.
400	MDS.MetaTableNotExist	The table is not found.	The specified table does not exist.
400	MDS.SemanticViewAlreadyExist	The semantic view already exists.	Semantic view already exists
500	MDS.InternalError	An internal MDS error occurred.	An internal error occurred.
500	MDS.MetaVisitError	Failed to access metadata.	Failed to access the metadata.
403	MDS.RamAuthAccessDenied	ram auth access denied.	RAM authentication failed
404	MDS.InstanceNotExist	ADB instance does not exist.	ADB instance does not exist

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.