Domain name for API request: databuddy.intl.tencentcloudapi.com.
Get the folder and file list
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: ListFiles. |
| Version | Yes | String | Common Params. The value used for this API: 2026-07-15. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| WorkspaceId | Yes | String | Workspace id |
| Parent | No | FolderLocator | Parent directory. If left blank, the root node is queried by default. |
| FileTypes.N | No | Array of String | Filter by file type |
| NameKeyword | No | String | Fuzzy matching by file name |
| OwnerUserUins.N | No | Array of String | Filter by owner UIN. Multiple values are OR-related |
| OnlyFolder | No | Boolean | Whether to list folders only. Default false. |
| OrderBys.N | No | Array of OrderBy | Sorting field list, for example, creation time [{Name: 'CreateTime', Direction: 'DESC'}], file name [{Name: 'Name', Direction: 'ASC'}] |
| PageNumber | No | Integer | Page number. Default value: 1. Minimum value: 1. |
| PageSize | No | Integer | Entries per page. Default: 10. Minimum value: 10. Maximum value: 100 Value range: [10, 100] |
| Parameter Name | Type | Description |
|---|---|---|
| Data | ListFilesRsp | File list result |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
Get folder and file list
POST / HTTP/1.1
Host: databuddy.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListFiles
<Common request parameters>
{
"WorkspaceId": "17697****0**47629",
"Parent": {
"FolderId": "86553********46400"
},
"NameKeyword": "071*****"
}{
"Response": {
"Data": {
"Items": [
{
"Creator": {
"Nickname": "we***a*************t.com",
"UserName": "weda**3**********ent.com",
"UserTag": "0",
"UserUin": "70*******618"
},
"DeleteTime": "",
"GitConfig": null,
"Node": {
"AllowActions": [
"MANAGE"
],
"CreateTime": "1784168588000",
"FileId": "865539****5***5136",
"FileName": "07161023.ipynb",
"FileType": "NOTEBOOK_FILE",
"IsFavorite": false,
"IsSystemGenerated": false,
"PathName": "/Workspace/Users/weda********@tenc***************64618/0716/07161023.ipynb",
"UpdateTime": "1784168790000"
},
"NodeType": "",
"OriginPath": "",
"Owner": {
"Nickname": "",
"UserName": "",
"UserTag": "",
"UserUin": "700*******18"
},
"Parent": {
"AllowActions": [],
"CreateTime": "",
"FileId": "86553*********6400",
"FileName": "",
"FileType": "",
"IsFavorite": false,
"IsSystemGenerated": false,
"PathName": "",
"UpdateTime": ""
}
}
],
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 1,
"TotalPageNumber": 1
},
"RequestId": "6decf098-7409-4899-8018-a563aa53fa73"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
There is no error code related to the API business logic. For other error codes, please see Common Error Codes.
フィードバック