Skip to main content
After files or folders are added or uploaded to a storage space, call this API to get their information in batches.

API call description

When retrieving information about files and folders, file size and file extension fields are not available for folders.

Request

Basic information

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

Request header

NameTypeRequiredDescription
x-acs-dingtalk-access-tokenStringYesThe access credential used to call 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 organization authorized to a third-party app API.

Path parameter

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

Query parameter

NameTypeRequiredDescription
unionIdStringYesThe unionId of the operator. Call the Query user details API to obtain the value of the unionid parameter.

Request body

NameTypeRequiredDescription
dentryIdsArray of StringYesThe list of file or folder IDs. Up to 30 IDs are supported. Call the Get a list of files or folders or Get spaceId and dentryId by dentryUuid API to obtain the value of the id parameter.
optionObjectNoOptional parameters.
appIdsForAppPropertiesArray of StringNoThe list of specified app IDs. Up to 20 IDs are supported. Call the Get space information API to obtain the value of the ownerId parameter. - If this parameter is specified, the properties of the file or folder for the specified app are returned. - If this parameter is not specified, the properties of the file or folder for all apps are returned.
withThumbnailBooleanNoWhether to retrieve thumbnail information of the file. - true: Yes - false: No Retrieve as needed. Retrieving thumbnails increases the API response time.

Request example

HTTP
POST /v1.0/storage/spaces/798xxxxx/dentries/query?unionId=chyxxxxx HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:xxxxx
Content-Type:application/json

{
  "dentryIds" : [ "478xxxxx" ],
  "option" : {
    "appIdsForAppProperties" : [ "chyxxxxx" ],
    "withThumbnail" : true
  }
}
Java
package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * <b>description</b> :
     * <p>Initialize the account Client using a Token</p>
     * @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 {
        
        com.aliyun.dingtalkstorage_1_0.Client client = Sample.createClient();
        com.aliyun.dingtalkstorage_1_0.models.GetDentriesHeaders getDentriesHeaders = new com.aliyun.dingtalkstorage_1_0.models.GetDentriesHeaders();
        getDentriesHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkstorage_1_0.models.GetDentriesRequest.GetDentriesRequestOption option = new com.aliyun.dingtalkstorage_1_0.models.GetDentriesRequest.GetDentriesRequestOption()
                .setAppIdsForAppProperties(java.util.Arrays.asList(
                    "chyxxxxx"
                ))
                .setWithThumbnail(true);
        com.aliyun.dingtalkstorage_1_0.models.GetDentriesRequest getDentriesRequest = new com.aliyun.dingtalkstorage_1_0.models.GetDentriesRequest()
                .setUnionId("chyxxxxx")
                .setDentryIds(java.util.Arrays.asList(
                    "478xxxxx"
                ))
                .setOption(option);
        try {
            client.getDentriesWithOptions("798xxxxx", getDentriesRequest, getDentriesHeaders, 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 the code and message attributes, which help you troubleshoot 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)) {
                // err contains the code and message attributes, which help you troubleshoot the issue
            }

        }        
    }
}
Python
# -*- coding: utf-8 -*-
# This file is auto-generated, don't edit it. Thanks.
import os
import sys
import json

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()
        get_dentries_headers = dingtalkstorage__1__0_models.GetDentriesHeaders()
        get_dentries_headers.x_acs_dingtalk_access_token = '<your access token>'
        option = dingtalkstorage__1__0_models.GetDentriesRequestOption(
            app_ids_for_app_properties=[
                'chyxxxxx'
            ],
            with_thumbnail=True
        )
        get_dentries_request = dingtalkstorage__1__0_models.GetDentriesRequest(
            union_id='chyxxxxx',
            dentry_ids=[
                '478xxxxx'
            ],
            option=option
        )
        try:
            client.get_dentries_with_options('798xxxxx', get_dentries_request, get_dentries_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err contains the code and message attributes, which help you troubleshoot the issue
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        get_dentries_headers = dingtalkstorage__1__0_models.GetDentriesHeaders()
        get_dentries_headers.x_acs_dingtalk_access_token = '<your access token>'
        option = dingtalkstorage__1__0_models.GetDentriesRequestOption(
            app_ids_for_app_properties=[
                'chyxxxxx'
            ],
            with_thumbnail=True
        )
        get_dentries_request = dingtalkstorage__1__0_models.GetDentriesRequest(
            union_id='chyxxxxx',
            dentry_ids=[
                '478xxxxx'
            ],
            option=option
        )
        try:
            await client.get_dentries_with_options_async('798xxxxx', get_dentries_request, get_dentries_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err contains the code and message attributes, which help you troubleshoot 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\GetDentriesHeaders;
use AlibabaCloud\SDK\Dingtalk\Vstorage_1_0\Models\GetDentriesRequest\option;
use AlibabaCloud\SDK\Dingtalk\Vstorage_1_0\Models\GetDentriesRequest;
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();
        $getDentriesHeaders = new GetDentriesHeaders([]);
        $getDentriesHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $option = new option([
            "appIdsForAppProperties" => [
                "chyxxxxx"
            ],
            "withThumbnail" => true
        ]);
        $getDentriesRequest = new GetDentriesRequest([
            "unionId" => "chyxxxxx",
            "dentryIds" => [
                "478xxxxx"
            ],
            "option" => $option
        ]);
        try {
            $client->getDentriesWithOptions("798xxxxx", $getDentriesRequest, $getDentriesHeaders, 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 the code and message attributes, which help you troubleshoot 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
package main

import (
  "encoding/json"
  "strings"
  "fmt"
  "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"
)

// Description:
// 
// 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
  }

  getDentriesHeaders := &dingtalkstorage_1_0.GetDentriesHeaders{}
  getDentriesHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  option := &dingtalkstorage_1_0.GetDentriesRequestOption{
    AppIdsForAppProperties: []*string{tea.String("chyxxxxx")},
    WithThumbnail: tea.Bool(true),
  }
  getDentriesRequest := &dingtalkstorage_1_0.GetDentriesRequest{
    UnionId: tea.String("chyxxxxx"),
    DentryIds: []*string{tea.String("478xxxxx")},
    Option: option,
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.GetDentriesWithOptions(tea.String("798xxxxx"), getDentriesRequest, getDentriesHeaders, &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 the code and message attributes, which help you troubleshoot the issue
    }

  }
  return _err
}

func main() {
  err := _main(tea.StringSlice(os.Args[1:]))
  if err != nil {
    panic(err)
  }
}
Node.js
'use strict';
// This file is auto-generated, don't edit it
const Util = require('@alicloud/tea-util');
const dingtalkstorage_1_0 = require('@alicloud/dingtalk/storage_1_0');
const OpenApi = require('@alicloud/openapi-client');
const Tea = require('@alicloud/tea-typescript');

class Client {

  /**
   * Initialize the account Client using a Token
   * @return Client
   * @throws Exception
   */
  static createClient() {
    let config = new OpenApi.Config({ });
    config.protocol = 'https';
    config.regionId = 'central';
    return new dingtalkstorage_1_0.default(config);
  }

  static async main(args) {
    let client = Client.createClient();
    let getDentriesHeaders = new dingtalkstorage_1_0.GetDentriesHeaders({ });
    getDentriesHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let option = new dingtalkstorage_1_0.GetDentriesRequestOption({
      appIdsForAppProperties: [
        'chyxxxxx'
      ],
      withThumbnail: true,
    });
    let getDentriesRequest = new dingtalkstorage_1_0.GetDentriesRequest({
      unionId: 'chyxxxxx',
      dentryIds: [
        '478xxxxx'
      ],
      option: option,
    });
    try {
      await client.getDentriesWithOptions('798xxxxx', getDentriesRequest, getDentriesHeaders, new Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.default.empty(err.code) && !Util.default.empty(err.message)) {
        // err contains the code and message attributes, which help you troubleshoot the issue
      }

    }    
  }

}

exports.Client = Client;
Client.main(process.argv.slice(2));
C#
using Newtonsoft.Json;
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 
    {

        /// <term><b>Description:</b></term>
        /// <description>
        /// <para>Initialize the account Client using a Token</para>
        /// </description>
        /// 
        /// <returns>
        /// Client
        /// </returns>
        /// 
        /// <term><b>Exception:</b></term>
        /// 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.GetDentriesHeaders getDentriesHeaders = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.GetDentriesHeaders();
            getDentriesHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.GetDentriesRequest.GetDentriesRequestOption option = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.GetDentriesRequest.GetDentriesRequestOption
            {
                AppIdsForAppProperties = new List<string>
                {
                    "chyxxxxx"
                },
                WithThumbnail = true,
            };
            AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.GetDentriesRequest getDentriesRequest = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.GetDentriesRequest
            {
                UnionId = "chyxxxxx",
                DentryIds = new List<string>
                {
                    "478xxxxx"
                },
                Option = option,
            };
            try
            {
                client.GetDentriesWithOptions("798xxxxx", getDentriesRequest, getDentriesHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
            }
            catch (TeaException err)
            {
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // err contains the code and message attributes, which help you troubleshoot 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))
                {
                    // err contains the code and message attributes, which help you troubleshoot the issue
                }
            }
        }

    }
}

Response

Response body

NameTypeDescription
resultItemsArrayThe list of file or folder information retrieved in batches.
spaceIdStringThe ID of the space where the file or folder resides.
dentryIdStringThe ID of the file or folder.
successBooleanWhether the file or folder was retrieved successfully. true indicates success.
errorCodeStringThe error reason.
dentryObjectThe information of the file or folder.
idStringThe ID of the file or folder.
spaceIdStringThe ID of the space where the file or folder resides.
parentIdStringThe parent directory ID of the file or folder. The ID of the root directory 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 number of the file or folder.
statusStringThe status. - NORMAL: Normal - DELETED: Trash - 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 property information of the file or folder.
readOnlyBooleanWhether the file or folder is read-only. - true: Yes - false: No
appPropertiesMap<String, Array>The properties for specific apps.
ArrayThe property list.
nameStringThe property name.
valueStringThe property value.
visibilityStringThe property 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: Shanji storage driver - UNKNOWN: Unknown driver
thumbnailObjectThe thumbnail information.
widthIntegerThe thumbnail width, in pixels.
heightIntegerThe thumbnail height, in pixels.
urlStringThe thumbnail URL.

Response body example

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

{
  "resultItems" : [ {
    "spaceId" : "798xxxxx",
    "dentryId" : "478xxxxx",
    "success" : true,
    "errorCode" : "permissionDenied",
    "dentry" : {
      "id" : "478xxxxx",
      "spaceId" : "798xxxxx",
      "parentId" : "367xxxxx",
      "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" : "Attribute1",
        "value" : "AttributeValue1",
        "visibility" : "PRIVATE"
      } ],
      "uuid" : "uuid",
      "partitionType" : "PUBLIC_OSS_PARTITION",
      "storageDriver" : "DINGTALK",
      "thumbnail" : {
        "width" : 64,
        "height" : 64,
        "url" : "url"
      }
    }
  } ]
}

Error codes

If the API call fails, locate 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 retrieve information about the file or folder.
404spaceNotExist%sThe space does not exist.
500systemError%sSystem error
500unknownErrorUnknown ErrorUnknown error
503operationTimeout%srequest timed out