Skip to main content
Call this API to get the list of files or folders in a space.

Request

Basic information

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

Request headers

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

Path parameters

NameTypeRequiredDescription
spaceIdStringYesThe space ID. Call the Add a space API to obtain the value of the id parameter.

Query parameters

NameTypeRequiredDescription
parentIdStringYesThe parent directory ID. For the root directory, set this parameter to 0. Call the Get the list of files or folders API to obtain the value of the parentId parameter.
nextTokenStringNoThe pagination cursor. - Leave this parameter empty for the first call. - For subsequent calls, pass the nextToken returned by the previous call.
maxResultsIntegerNoThe number of entries per page. The maximum value is 50.
orderByStringNoThe sorting field. - MODIFIED_TIME: last modified time. Default value. - CREATE_TIME: created time. - NAME: name. - SIZE: size.
orderStringNoThe sorting rule. - ASC: ascending order. - DESC: descending order. Default value.
withThumbnailBooleanNoWhether to get the temporary link of the file thumbnail. Get it as needed because it affects API response time. - true: get. - false: do not get. Default value.
unionIdStringYesThe unionId of the operator. Call the Query user details API to obtain it.

Request example

HTTP
GET /v1.0/storage/spaces/854xxxxx/dentries?parentId=0&nextToken=next_token&maxResults=30&orderBy=MODIFIED_TIME&order=DESC&withThumbnail=false&unionId=cHtUxxxxx HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:xxxxx
Content-Type:application/json
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 with 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.ListDentriesHeaders listDentriesHeaders = new com.aliyun.dingtalkstorage_1_0.models.ListDentriesHeaders();
        listDentriesHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkstorage_1_0.models.ListDentriesRequest listDentriesRequest = new com.aliyun.dingtalkstorage_1_0.models.ListDentriesRequest()
                .setParentId("0")
                .setNextToken("next_token")
                .setMaxResults(30)
                .setOrderBy("MODIFIED_TIME")
                .setOrder("DESC")
                .setWithThumbnail(false)
                .setUnionId("cHtUxxxxx");
        try {
            client.listDentriesWithOptions("854xxxxx", listDentriesRequest, listDentriesHeaders, new com.aliyun.teautil.models.RuntimeOptions());
        } catch (TeaException err) {
            if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) {
                // The err contains code and message attributes, which help diagnose the issue
            }

        } 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)) {
                // The err contains code and message attributes, which help diagnose the issue
            }

        }        
    }
}
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 with 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_dentries_headers = dingtalkstorage__1__0_models.ListDentriesHeaders()
        list_dentries_headers.x_acs_dingtalk_access_token = '<your access token>'
        list_dentries_request = dingtalkstorage__1__0_models.ListDentriesRequest(
            parent_id='0',
            next_token='next_token',
            max_results=30,
            order_by='MODIFIED_TIME',
            order='DESC',
            with_thumbnail=False,
            union_id='cHtUxxxxx'
        )
        try:
            client.list_dentries_with_options('854xxxxx', list_dentries_request, list_dentries_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # The err contains code and message attributes, which help diagnose the issue
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        list_dentries_headers = dingtalkstorage__1__0_models.ListDentriesHeaders()
        list_dentries_headers.x_acs_dingtalk_access_token = '<your access token>'
        list_dentries_request = dingtalkstorage__1__0_models.ListDentriesRequest(
            parent_id='0',
            next_token='next_token',
            max_results=30,
            order_by='MODIFIED_TIME',
            order='DESC',
            with_thumbnail=False,
            union_id='cHtUxxxxx'
        )
        try:
            await client.list_dentries_with_options_async('854xxxxx', list_dentries_request, list_dentries_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # The err contains code and message attributes, which help diagnose the issue
                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\ListDentriesHeaders;
use AlibabaCloud\SDK\Dingtalk\Vstorage_1_0\Models\ListDentriesRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * Initialize the account client with 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();
        $listDentriesHeaders = new ListDentriesHeaders([]);
        $listDentriesHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $listDentriesRequest = new ListDentriesRequest([
            "parentId" => "0",
            "nextToken" => "next_token",
            "maxResults" => 30,
            "orderBy" => "MODIFIED_TIME",
            "order" => "DESC",
            "withThumbnail" => false,
            "unionId" => "cHtUxxxxx"
        ]);
        try {
            $client->listDentriesWithOptions("854xxxxx", $listDentriesRequest, $listDentriesHeaders, 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)) {
                // The err contains code and message attributes, which help diagnose the issue
            }
        }
    }
}
$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 with 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
  }

  listDentriesHeaders := &dingtalkstorage_1_0.ListDentriesHeaders{}
  listDentriesHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  listDentriesRequest := &dingtalkstorage_1_0.ListDentriesRequest{
    ParentId: tea.String("0"),
    NextToken: tea.String("next_token"),
    MaxResults: tea.Int32(30),
    OrderBy: tea.String("MODIFIED_TIME"),
    Order: tea.String("DESC"),
    WithThumbnail: tea.Bool(false),
    UnionId: tea.String("cHtUxxxxx"),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.ListDentriesWithOptions(tea.String("854xxxxx"), listDentriesRequest, listDentriesHeaders, &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)) {
      // The err contains code and message attributes, which help diagnose the issue
    }

  }
  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 with 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 listDentriesHeaders = new $dingtalkstorage_1_0.ListDentriesHeaders({ });
    listDentriesHeaders.xAcsDingtalkAccessToken = "<your access token>";
    let listDentriesRequest = new $dingtalkstorage_1_0.ListDentriesRequest({
      parentId: "0",
      nextToken: "next_token",
      maxResults: 30,
      orderBy: "MODIFIED_TIME",
      order: "DESC",
      withThumbnail: false,
      unionId: "cHtUxxxxx",
    });
    try {
      await client.listDentriesWithOptions("854xxxxx", listDentriesRequest, listDentriesHeaders, new $Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.empty(err.code) && !Util.empty(err.message)) {
        // The err contains code and message attributes, which help diagnose the issue
      }

    }    
  }

}

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 with 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.ListDentriesHeaders listDentriesHeaders = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.ListDentriesHeaders();
            listDentriesHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.ListDentriesRequest listDentriesRequest = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.ListDentriesRequest
            {
                ParentId = "0",
                NextToken = "next_token",
                MaxResults = 30,
                OrderBy = "MODIFIED_TIME",
                Order = "DESC",
                WithThumbnail = false,
                UnionId = "cHtUxxxxx",
            };
            try
            {
                client.ListDentriesWithOptions("854xxxxx", listDentriesRequest, listDentriesHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
            }
            catch (TeaException err)
            {
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // The err contains code and message attributes, which help diagnose the issue
                }
            }
            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))
                {
                    // The err contains code and message attributes, which help diagnose the issue
                }
            }
        }

    }
}

Response

Response body

NameTypeDescription
dentriesArrayThe list of files or folders.
idStringThe ID of the file or folder.
spaceIdStringThe ID of the space where the file or folder is located.
parentIdStringThe parent directory ID. For the root directory, this parameter is 0.
typeStringThe type. - FILE: file. - FOLDER: folder.
nameStringThe name of the file or folder.
sizeLongThe file size, in bytes.
pathStringThe path of the file or folder.
versionLongThe version.
statusStringThe status. - 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. For example, 2022-07-29T14:55Z.
modifiedTimeStringThe modified time in ISO 8601 format. For example, 2022-07-29T14:55Z.
propertiesObjectThe property information.
readOnlyBooleanWhether the file or folder is read-only. - true: yes. - false: no.
appPropertiesMap<String, Array>The properties for a specific app.
ArrayThe list of space properties.
nameStringThe property name.
valueStringThe property value.
visibilityStringThe visibility. - PUBLIC: public. - PRIVATE: visible only to the current space.
uuidStringThe identifier field.
partitionTypeStringThe storage partition. - PUBLIC_OSS_PARTITION: public cloud OSS storage partition. - MINI_OSS_PARTITION: dedicated MiniOSS storage partition.
storageDriverStringThe driver type. - DINGTALK: DingTalk unified storage driver. - ALIDOC: DingTalk Docs storage driver. - UNKNOWN: unknown driver.
thumbnailObjectThe thumbnail information.
widthIntegerThe thumbnail width, in pixels.
heightIntegerThe thumbnail height, in pixels.
urlStringThe thumbnail URL.
nextTokenStringThe pagination cursor. A non-empty value indicates that more data is available.

Response body example

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

{
  "dentries" : [ {
    "id" : "657xxxxx",
    "spaceId" : "854xxxxx",
    "parentId" : "0",
    "type" : "FILE",
    "name" : "Test folder",
    "size" : 512,
    "path" : "./test.txt",
    "version" : 1,
    "status" : "NORMAL",
    "extension" : "txt",
    "creatorId" : "cHtUxxxxx",
    "modifierId" : "cHtUxxxxx",
    "createTime" : "2022-01-01T10:00:00Z",
    "modifiedTime" : "2022-01-01T10:00:00Z",
    "properties" : {
      "readOnly" : true
    },
    "appProperties" : [ {
      "name" : "Property 1",
      "value" : "Property value 1",
      "visibility" : "PRIVATE"
    } ],
    "uuid" : "123xxxxx",
    "partitionType" : "PUBLIC_OSS_PARTITION",
    "storageDriver" : "DINGTALK",
    "thumbnail" : {
      "width" : 64,
      "height" : 64,
      "url" : "url"
    }
  } ],
  "nextToken" : "next_token"
}

Error codes

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