Skip to main content
Call this API to retrieve a flat list of all files and folders in a space.

Request

Basic information

FieldValue
HTTP URLhttps://api.dingtalk.io/v1.0/storage/spaces/{spaceId}/dentries/listAll
HTTP MethodPOST
Supported app typesappType-Internal app appType-Third-party enterprise app
Permissions requiredpermission-Storage.File.Read-Read permission for organization storage files

Request header

NameTypeRequiredDescription
x-acs-dingtalk-access-tokenStringYesThe access credential for calling this API. Obtain it as follows: - For an internal app, call the Obtain the access token of an internal app API. - For a third-party enterprise app, call the Obtain the access token of an authorized organization for a third-party app API.

Path parameter

NameTypeRequiredDescription
spaceIdStringYesThe space ID. Call the Add a space API and use the value of the returned id parameter.

Query parameter

NameTypeRequiredDescription
unionIdStringYesThe unionId of the operator. Call the Query user details API to obtain it.

Request body

NameTypeRequiredDescription
optionObjectNoOptional parameters.
nextTokenStringNoThe pagination cursor. - For the first call, do not pass this parameter. - For subsequent calls, pass the nextToken returned in the previous call.
maxResultsIntegerNoThe number of entries per page. Default: 50. Maximum: 50.
orderStringNoSorting rules. Currently, only sorting by modified time is supported. - ASC (default): ascending order - DESC: descending order - When sorting in ascending order, if files change during pagination, duplicate data may be retrieved. - When sorting in descending order, if files change during pagination, data may be lost.
withThumbnailBooleanNoWhether to retrieve thumbnail links of files. - true: Yes - false (default): No Retrieve on demand. Retrieving thumbnails increases API response time.

Request example

HTTP
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
// This file is auto-generated, don't edit it. Thanks.
package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * Initialize the account Client using a Token
     * @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<String> 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 = "<your access token>";
        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 contains code and message properties to help locate issues
            }

        } 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 contains code and message properties to help locate issues
            }

        }        
    }
}
Python
# -*- 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:
        """
        Initialize the account Client using a Token
        @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 = '<your 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 contains code and message properties to help locate issues
                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 = '<your 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 contains code and message properties to help locate issues
                pass

if __name__ == '__main__':
    Sample.main(sys.argv[1:])
PHP
<?php

// This file is auto-generated, don't edit it. Thanks.
namespace AlibabaCloud\SDK\Sample;

use AlibabaCloud\SDK\Dingtalk\Vstorage_1_0\Dingtalk;
use \Exception;
use AlibabaCloud\Tea\Exception\TeaError;
use AlibabaCloud\Tea\Utils\Utils;

use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\SDK\Dingtalk\Vstorage_1_0\Models\ListAllDentriesHeaders;
use AlibabaCloud\SDK\Dingtalk\Vstorage_1_0\Models\ListAllDentriesRequest\option;
use AlibabaCloud\SDK\Dingtalk\Vstorage_1_0\Models\ListAllDentriesRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * Initialize the account Client using a Token
     * @return Dingtalk Client
     */
    public static function createClient(){
        $config = new Config([]);
        $config->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 = "<your access token>";
        $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 contains code and message properties to help locate issues
            }
        }
    }
}
$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
// 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"
)

/**
 * Initialize the account Client using a Token
 * @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("<your access token>")
  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 contains code and message properties to help locate issues
    }

  }
  return _err
}

func main() {
  err := _main(tea.StringSlice(os.Args[1:]))
  if err != nil {
    panic(err)
  }
}
Node.js
// 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 {

  /**
   * Initialize the account Client using a Token
   * @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<void> {
    let client = Client.createClient();
    let listAllDentriesHeaders = new $dingtalkstorage_1_0.ListAllDentriesHeaders({ });
    listAllDentriesHeaders.xAcsDingtalkAccessToken = "<your access token>";
    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 contains code and message properties to help locate issues
      }

    }    
  }

}

Client.main(process.argv.slice(2));
C#
// 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 
    {

        /**
         * Initialize the account Client using a Token
         * @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 = "<your access token>";
            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 contains code and message properties to help locate issues
                }
            }
            catch (Exception _err)
            {
                TeaException err = new TeaException(new Dictionary<string, object>
                {
                    { "message", _err.Message }
                });
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // err contains code and message properties to help locate issues
                }
            }
        }

    }
}

Response

Response body

NameTypeDescription
dentriesArrayThe returned list of files or folders.
idStringThe file or folder ID.
spaceIdStringThe ID of the space the file or folder belongs to.
parentIdStringThe parent folder ID. The root folder ID is 0.
typeStringThe type. - FILE: file - FOLDER: folder
nameStringThe file or folder name.
sizeLongThe file size, in bytes.
pathStringThe file or folder path.
versionLongThe file version.
statusStringThe status of the file or folder. - NORMAL: normal - DELETED: deleted - EXPIRED: expired
extensionStringThe file extension.
creatorIdStringThe unionId of the creator.
modifierIdStringThe unionId of the modifier.
createTimeStringThe created time, in ISO 8601 format. Example: 2022-07-29T14:55Z.
modifiedTimeStringThe modified time, in ISO 8601 format. Example: 2022-07-29T14:55Z.
propertiesObjectThe file attributes.
readOnlyBooleanWhether the file is read-only. - true: Yes - false: No
appPropertiesMap<String, Array>Attributes for a specific app.
ArrayThe list of space attributes.
nameStringThe attribute name.
valueStringThe attribute value.
visibilityStringThe attribute visibility. - PUBLIC: visible to all apps - PRIVATE: visible only to the current app
uuidStringThe identifier field.
partitionTypeStringThe storage partition. - PUBLIC_OSS_PARTITION: public cloud OSS storage partition - MINI_OSS_PARTITION: dedicated Mini OSS storage partition
storageDriverStringThe driver type. - DINGTALK: DingTalk unified storage driver - ALIDOC: DingTalk Docs storage driver - SHANJI: Flash Note storage driver - UNKNOWN: unknown driver
thumbnailObjectThe thumbnail information. Returned only when the withThumbnail parameter is set to true.
widthIntegerThe thumbnail width, in px.
heightIntegerThe thumbnail height, in px.
urlStringThe thumbnail URL.
nextTokenStringThe pagination cursor. If this parameter is not empty, more data is available.

Response body example

HTTP/1.1 200 OK
Content-Type:application/json

{
  "dentries" : [ {
    "id" : "677xxxxx",
    "spaceId" : "789xxxxx",
    "parentId" : "766xxxxx",
    "type" : "FILE",
    "name" : "Test folder",
    "size" : 512,
    "path" : "./Test folder",
    "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" : "Attribute 1",
      "value" : "Value 1",
      "visibility" : "PRIVATE"
    } ],
    "uuid" : "123xxxxx",
    "partitionType" : "PUBLIC_OSS_PARTITION",
    "storageDriver" : "DINGTALK",
    "thumbnail" : {
      "width" : 64,
      "height" : 64,
      "url" : "url"
    }
  } ],
  "nextToken" : "8965000xxxxx"
}

Error codes

If an error occurs when you call this API, refer to the Global error codes document for solutions based on the error message.
HttpCodeError codeError messageDescription
400paramError%sParameter error
403permissionDenied%sThe user lacks permission to retrieve the file list
404spaceNotExist%sThe space does not exist
404dentryNotExist%sThe file does not exist
500systemError%sSystem error
500unknownErrorUnknown ErrorUnknown error
503operationTimeout%sRequest timeout