> ## Documentation Index > Fetch the complete documentation index at: https://help.dingtalk.io/llms.txt > Use this file to discover all available pages before exploring further. # 获取空间下所有文件或文件夹列表 > 调用本接口可平铺获取钉钉云盘空间下的所有文件和文件夹列表,不区分层级结构。 调用本接口，平铺获取空间下所有文件或文件夹列表。 ## 请求 ### 基本信息 | 字段 | 值 | | ----------- | ------------------------------------------------------------------------ | | HTTP URL | `https://api.dingtalk.io/v1.0/storage/spaces/{spaceId}/dentries/listAll` | | HTTP Method | POST | | 支持的应用类型 | appType-企业内部应用　appType-第三方企业应用 | | 权限要求 | permission-Storage.File.Read-企业存储文件读权限 | ### 请求头 | 名称 | 类型 | 是否必填 | 描述 | | --------------------------- | ------ | ---- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | x-acs-dingtalk-access-token | String | 是 | 调用该接口的访问凭证，通过以下获取： - 企业内部应用，调用[获取企业内部应用的accessToken](/zh/open/development/obtain-the-access-token-of-an-internal-app#)接口获取。 - 第三方企业应用，调用[获取第三方应用授权企业的accessToken](https://open.dingtalk.com/document/development/obtain-the-access-token-of-the-authorized-enterprise-1#)接口获取。 | ### 路径参数 | 名称 | 类型 | 是否必填 | 描述 | | ------- | ------ | ---- | -------------------------------------------------------- | | spaceId | String | 是 | 空间ID，调用[添加空间](/zh/open/development/add-space#)接口获取id参数值。 | ### 查询参数 | 名称 | 类型 | 是否必填 | 描述 | | ------- | ------ | ---- | ---------------------------------------------------------------------- | | unionId | String | 是 | 操作人的unionId，可调用[查询用户详情](/zh/open/development/query-user-details#)接口获取。 | ### 请求体 | 名称 | 类型 | 是否必填 | 描述 | | ------------- | ------- | ---- | -------------------------------------------------------------------------------------------------------------------------------- | | option | Object | 否 | 可选参数。 | | nextToken | String | 否 | 分页游标。 - 如果是首次调用，该参数不传。 - 如果是非首次调用，该参数传上次调用时返回的nextToken。 | | maxResults | Integer | 否 | 每页条目数，默认值50，最大值50。 | | order | String | 否 | 排序规则，目前仅支持按修改时间排序。 - **ASC**（默认）：升序 - **DESC**：降序 - 如果是升序排序，分页拉取过程中，如果文件发生变化，可能拉取到重复数据。 - 如果是降序排序，分页拉取过程中，如果文件发生变化， 可能会丢失数据。 | | withThumbnail | Boolean | 否 | 是否获取文件缩略图的链接。 - **true**：是 - **false**（默认）：否 按需获取，获取时会增加接口耗时。 | ### 请求示例 HTTP ```http theme={"theme":{"light":"github-light","dark":"github-dark"}} POST /v1.0/storage/spaces/897xxxxx/dentries/listAll?unionId=chyxxxxx HTTP/1.1 Host:api.dingtalk.io x-acs-dingtalk-access-token:xxxxx Content-Type:application/json { "option" : { "nextToken" : "3678056xxxxx", "maxResults" : 30, "order" : "DESC", "withThumbnail" : true } } ``` Java ```java theme={"theme":{"light":"github-light","dark":"github-dark"}} // This file is auto-generated, don't edit it. Thanks. package com.aliyun.sample; import com.aliyun.tea.*; public class Sample { /** * 使用 Token 初始化账号Client * @return Client * @throws Exception */ public static com.aliyun.dingtalkstorage_1_0.Client createClient() throws Exception { com.aliyun.teaopenapi.models.Config config = new com.aliyun.teaopenapi.models.Config(); config.protocol = "https"; config.regionId = "central"; return new com.aliyun.dingtalkstorage_1_0.Client(config); } public static void main(String[] args_) throws Exception { java.util.List args = java.util.Arrays.asList(args_); com.aliyun.dingtalkstorage_1_0.Client client = Sample.createClient(); com.aliyun.dingtalkstorage_1_0.models.ListAllDentriesHeaders listAllDentriesHeaders = new com.aliyun.dingtalkstorage_1_0.models.ListAllDentriesHeaders(); listAllDentriesHeaders.xAcsDingtalkAccessToken = ""; com.aliyun.dingtalkstorage_1_0.models.ListAllDentriesRequest.ListAllDentriesRequestOption option = new com.aliyun.dingtalkstorage_1_0.models.ListAllDentriesRequest.ListAllDentriesRequestOption() .setNextToken("3678056xxxxx") .setMaxResults(30) .setOrder("DESC") .setWithThumbnail(true); com.aliyun.dingtalkstorage_1_0.models.ListAllDentriesRequest listAllDentriesRequest = new com.aliyun.dingtalkstorage_1_0.models.ListAllDentriesRequest() .setUnionId("chyxxxxx") .setOption(option); try { client.listAllDentriesWithOptions("897xxxxx", listAllDentriesRequest, listAllDentriesHeaders, new com.aliyun.teautil.models.RuntimeOptions()); } catch (TeaException err) { if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) { // err 中含有 code 和 message 属性，可帮助开发定位问题 } } catch (Exception _err) { TeaException err = new TeaException(_err.getMessage(), _err); if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) { // err 中含有 code 和 message 属性，可帮助开发定位问题 } } } } ``` Python ```python theme={"theme":{"light":"github-light","dark":"github-dark"}} # -*- coding: utf-8 -*- # This file is auto-generated, don't edit it. Thanks. import sys from typing import List from alibabacloud_dingtalk.storage_1_0.client import Client as dingtalkstorage_1_0Client from alibabacloud_tea_openapi import models as open_api_models from alibabacloud_dingtalk.storage_1_0 import models as dingtalkstorage__1__0_models from alibabacloud_tea_util import models as util_models from alibabacloud_tea_util.client import Client as UtilClient class Sample: def __init__(self): pass @staticmethod def create_client() -> dingtalkstorage_1_0Client: """ 使用 Token 初始化账号Client @return: Client @throws Exception """ config = open_api_models.Config() config.protocol = 'https' config.region_id = 'central' return dingtalkstorage_1_0Client(config) @staticmethod def main( args: List[str], ) -> None: client = Sample.create_client() list_all_dentries_headers = dingtalkstorage__1__0_models.ListAllDentriesHeaders() list_all_dentries_headers.x_acs_dingtalk_access_token = '' option = dingtalkstorage__1__0_models.ListAllDentriesRequestOption( next_token='3678056xxxxx', max_results=30, order='DESC', with_thumbnail=True ) list_all_dentries_request = dingtalkstorage__1__0_models.ListAllDentriesRequest( union_id='chyxxxxx', option=option ) try: client.list_all_dentries_with_options('897xxxxx', list_all_dentries_request, list_all_dentries_headers, util_models.RuntimeOptions()) except Exception as err: if not UtilClient.empty(err.code) and not UtilClient.empty(err.message): # err 中含有 code 和 message 属性，可帮助开发定位问题 pass @staticmethod async def main_async( args: List[str], ) -> None: client = Sample.create_client() list_all_dentries_headers = dingtalkstorage__1__0_models.ListAllDentriesHeaders() list_all_dentries_headers.x_acs_dingtalk_access_token = '' option = dingtalkstorage__1__0_models.ListAllDentriesRequestOption( next_token='3678056xxxxx', max_results=30, order='DESC', with_thumbnail=True ) list_all_dentries_request = dingtalkstorage__1__0_models.ListAllDentriesRequest( union_id='chyxxxxx', option=option ) try: await client.list_all_dentries_with_options_async('897xxxxx', list_all_dentries_request, list_all_dentries_headers, util_models.RuntimeOptions()) except Exception as err: if not UtilClient.empty(err.code) and not UtilClient.empty(err.message): # err 中含有 code 和 message 属性，可帮助开发定位问题 pass if __name__ == '__main__': Sample.main(sys.argv[1:]) ``` PHP ```java theme={"theme":{"light":"github-light","dark":"github-dark"}} protocol = "https"; $config->regionId = "central"; return new Dingtalk($config); } /** * @param string[] $args * @return void */ public static function main($args){ $client = self::createClient(); $listAllDentriesHeaders = new ListAllDentriesHeaders([]); $listAllDentriesHeaders->xAcsDingtalkAccessToken = ""; $option = new option([ "nextToken" => "3678056xxxxx", "maxResults" => 30, "order" => "DESC", "withThumbnail" => true ]); $listAllDentriesRequest = new ListAllDentriesRequest([ "unionId" => "chyxxxxx", "option" => $option ]); try { $client->listAllDentriesWithOptions("897xxxxx", $listAllDentriesRequest, $listAllDentriesHeaders, new RuntimeOptions([])); } catch (Exception $err) { if (!($err instanceof TeaError)) { $err = new TeaError([], $err->getMessage(), $err->getCode(), $err); } if (!Utils::empty_($err->code) && !Utils::empty_($err->message)) { // err 中含有 code 和 message 属性，可帮助开发定位问题 } } } } $path = __DIR__ . \DIRECTORY_SEPARATOR . '..' . \DIRECTORY_SEPARATOR . 'vendor' . \DIRECTORY_SEPARATOR . 'autoload.php'; if (file_exists($path)) { require_once $path; } Sample::main(array_slice($argv, 1)); ``` Go ```go theme={"theme":{"light":"github-light","dark":"github-dark"}} // This file is auto-generated, don't edit it. Thanks. package main import ( "os" util "github.com/alibabacloud-go/tea-utils/v2/service" dingtalkstorage_1_0 "github.com/alibabacloud-go/dingtalk/storage_1_0" openapi "github.com/alibabacloud-go/darabonba-openapi/v2/client" "github.com/alibabacloud-go/tea/tea" ) /** * 使用 Token 初始化账号Client * @return Client * @throws Exception */ func CreateClient () (_result *dingtalkstorage_1_0.Client, _err error) { config := &openapi.Config{} config.Protocol = tea.String("https") config.RegionId = tea.String("central") _result = &dingtalkstorage_1_0.Client{} _result, _err = dingtalkstorage_1_0.NewClient(config) return _result, _err } func _main (args []*string) (_err error) { client, _err := CreateClient() if _err != nil { return _err } listAllDentriesHeaders := &dingtalkstorage_1_0.ListAllDentriesHeaders{} listAllDentriesHeaders.XAcsDingtalkAccessToken = tea.String("") option := &dingtalkstorage_1_0.ListAllDentriesRequestOption{ NextToken: tea.String("3678056xxxxx"), MaxResults: tea.Int32(30), Order: tea.String("DESC"), WithThumbnail: tea.Bool(true), } listAllDentriesRequest := &dingtalkstorage_1_0.ListAllDentriesRequest{ UnionId: tea.String("chyxxxxx"), Option: option, } tryErr := func()(_e error) { defer func() { if r := tea.Recover(recover()); r != nil { _e = r } }() _, _err = client.ListAllDentriesWithOptions(tea.String("897xxxxx"), listAllDentriesRequest, listAllDentriesHeaders, &util.RuntimeOptions{}) if _err != nil { return _err } return nil }() if tryErr != nil { var err = &tea.SDKError{} if _t, ok := tryErr.(*tea.SDKError); ok { err = _t } else { err.Message = tea.String(tryErr.Error()) } if !tea.BoolValue(util.Empty(err.Code)) && !tea.BoolValue(util.Empty(err.Message)) { // err 中含有 code 和 message 属性，可帮助开发定位问题 } } return _err } func main() { err := _main(tea.StringSlice(os.Args[1:])) if err != nil { panic(err) } } ``` Node.js ```python theme={"theme":{"light":"github-light","dark":"github-dark"}} // This file is auto-generated, don't edit it import Util, * as $Util from '@alicloud/tea-util'; import dingtalkstorage_1_0, * as $dingtalkstorage_1_0 from '@alicloud/dingtalk/storage_1_0'; import OpenApi, * as $OpenApi from '@alicloud/openapi-client'; import * as $tea from '@alicloud/tea-typescript'; export default class Client { /** * 使用 Token 初始化账号Client * @return Client * @throws Exception */ static createClient(): dingtalkstorage_1_0 { let config = new $OpenApi.Config({ }); config.protocol = "https"; config.regionId = "central"; return new dingtalkstorage_1_0(config); } static async main(args: string[]): Promise { let client = Client.createClient(); let listAllDentriesHeaders = new $dingtalkstorage_1_0.ListAllDentriesHeaders({ }); listAllDentriesHeaders.xAcsDingtalkAccessToken = ""; let option = new $dingtalkstorage_1_0.ListAllDentriesRequestOption({ nextToken: "3678056xxxxx", maxResults: 30, order: "DESC", withThumbnail: true, }); let listAllDentriesRequest = new $dingtalkstorage_1_0.ListAllDentriesRequest({ unionId: "chyxxxxx", option: option, }); try { await client.listAllDentriesWithOptions("897xxxxx", listAllDentriesRequest, listAllDentriesHeaders, new $Util.RuntimeOptions({ })); } catch (err) { if (!Util.empty(err.code) && !Util.empty(err.message)) { // err 中含有 code 和 message 属性，可帮助开发定位问题 } } } } Client.main(process.argv.slice(2)); ``` C# ```java theme={"theme":{"light":"github-light","dark":"github-dark"}} // This file is auto-generated, don't edit it. Thanks. using System; using System.Collections; using System.Collections.Generic; using System.IO; using System.Threading.Tasks; using Tea; using Tea.Utils; namespace AlibabaCloud.SDK.Sample { public class Sample { /** * 使用 Token 初始化账号Client * @return Client * @throws Exception */ public static AlibabaCloud.SDK.Dingtalkstorage_1_0.Client CreateClient() { AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config(); config.Protocol = "https"; config.RegionId = "central"; return new AlibabaCloud.SDK.Dingtalkstorage_1_0.Client(config); } public static void Main(string[] args) { AlibabaCloud.SDK.Dingtalkstorage_1_0.Client client = CreateClient(); AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.ListAllDentriesHeaders listAllDentriesHeaders = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.ListAllDentriesHeaders(); listAllDentriesHeaders.XAcsDingtalkAccessToken = ""; AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.ListAllDentriesRequest.ListAllDentriesRequestOption option = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.ListAllDentriesRequest.ListAllDentriesRequestOption { NextToken = "3678056xxxxx", MaxResults = 30, Order = "DESC", WithThumbnail = true, }; AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.ListAllDentriesRequest listAllDentriesRequest = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.ListAllDentriesRequest { UnionId = "chyxxxxx", Option = option, }; try { client.ListAllDentriesWithOptions("897xxxxx", listAllDentriesRequest, listAllDentriesHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions()); } catch (TeaException err) { if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message)) { // err 中含有 code 和 message 属性，可帮助开发定位问题 } } catch (Exception _err) { TeaException err = new TeaException(new Dictionary { { "message", _err.Message } }); if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message)) { // err 中含有 code 和 message 属性，可帮助开发定位问题 } } } } } ``` ## 响应 ### 响应体 | 名称 | 类型 | 描述 | | ------------- | -------------------- | -------------------------------------------------------------------------------------------- | | dentries | Array | 返回的文件或文件夹列表。 | | id | String | 文件或文件夹ID。 | | spaceId | String | 所在空间ID。 | | parentId | String | 父目录ID，根目录ID值为0。 | | type | String | 类型。 - **FILE**：文件 - **FOLDER**：文件夹 | | name | String | 文件或文件夹名称。 | | size | Long | 文件大小，单位Byte。 | | path | String | 文件或文件夹的路径。 | | version | Long | 文件的版本号。 | | status | String | 文件或文件夹的状态。 - **NORMAL**：正常 - **DELETED**：已删除 - **EXPIRED**：已过期 | | extension | String | 文件的后缀。 | | creatorId | String | 创建者unionId。 | | modifierId | String | 修改者unionId。 | | createTime | String | 创建时间，iso8601格式，例如：2022-07-29T14:55Z。 | | modifiedTime | String | 修改时间，iso8601格式，例如：2022-07-29T14:55Z。 | | properties | Object | 文件属性。 | | readOnly | Boolean | 文件是否只读。 - **true**：是 - **false**：否 | | appProperties | `Map` | 在特定应用上的属性。 | | | Array | 空间属性列表。 | | name | String | 属性名称。 | | value | String | 属性值。 | | visibility | String | 属性可见性。 - **PUBLIC**：所有应用都可见 - **PRIVATE**：仅限当前应用可见 | | uuid | String | 标识字段。 | | partitionType | String | 存储分区。 - **PUBLIC\_OSS\_PARTITION**：公有云OSS存储分区 - **MINI\_OSS\_PARTITION**：专属Mini OSS存储分区 | | storageDriver | String | 驱动类型。 - **DINGTALK**：钉钉统一存储驱动 - **ALIDOC**：钉钉文档存储驱动 - **SHANJI**：闪记存储驱动 - **UNKNOWN**：未知驱动 | | thumbnail | Object | 缩略图信息。 当withThumbnail参数值为true时才返回。 | | width | Integer | 缩略图宽度，单位px。 | | height | Integer | 缩略图高度，单位px。 | | url | String | 缩略图url。 | | nextToken | String | 分页游标。 如果该参数不为空，表示还有更多数据。 | ### 响应体示例 ```text theme={"theme":{"light":"github-light","dark":"github-dark"}} HTTP/1.1 200 OK Content-Type:application/json { "dentries" : [ { "id" : "677xxxxx", "spaceId" : "789xxxxx", "parentId" : "766xxxxx", "type" : "FILE", "name" : "测试文件夹", "size" : 512, "path" : "./测试文件夹", "version" : 1, "status" : "NORMAL", "extension" : "txt", "creatorId" : "chyxxxxx", "modifierId" : "chyxxxxx", "createTime" : "2022-01-01T10:00:00Z", "modifiedTime" : "2022-01-01T10:00:00Z", "properties" : { "readOnly" : true }, "appProperties" : [ { "name" : "属性1", "value" : "属性值1", "visibility" : "PRIVATE" } ], "uuid" : "123xxxxx", "partitionType" : "PUBLIC_OSS_PARTITION", "storageDriver" : "DINGTALK", "thumbnail" : { "width" : 64, "height" : 64, "url" : "url" } } ], "nextToken" : "8965000xxxxx" } ``` ### 错误码 若调用该接口报错，可根据错误信息在[全局错误码](/zh/open/development/server-api-error-codes-1)文档中查找解决方案。 | HttpCode | 错误码 | 错误信息 | 说明 | | -------- | ---------------- | ------------- | ------------- | | 400 | paramError | %s | 参数错误 | | 403 | permissionDenied | %s | 用户缺少获取文件列表的权限 | | 404 | spaceNotExist | %s | 空间不存在 | | 404 | dentryNotExist | %s | 文件不存在 | | 500 | systemError | %s | 系统错误 | | 500 | unknownError | Unknown Error | 未知错误 | | 503 | operationTimeout | %s | 请求超时 |