> ## 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/query` |
| 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)接口获取unionid参数值。 |

### 请求体

| 名称                     | 类型              | 是否必填 | 描述                                                                                                                                                                            |
| ---------------------- | --------------- | ---- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| dentryIds              | Array of String | 是    | 文件或文件夹的ID列表，最多30个，可调用[获取文件或文件夹列表](/zh/open/development/get-a-list-of-files-or-folders)或[根据dentryUuid获取spaceId和dentryId](/zh/open/development/api-getdentryidbyuuid)接口获取id参数值。 |
| option                 | Object          | 否    | 可选参数。                                                                                                                                                                         |
| appIdsForAppProperties | Array of String | 否    | 指定应用ID列表，最多20个，可通过[获取空间信息](/zh/open/development/get-space-information)接口获取ownerId参数值。       - 如果传该参数，会返回该文件或文件夹对应应用的属性。 - 如果不传该参数，会返回该文件或文件夹的所有应用的属性。                         |
| withThumbnail          | Boolean         | 否    | 是否获取文件缩略图信息。   - **true**：是 - **false**：否       按需获取，获取时会增加接口耗时。                                                                                                              |

### 请求示例

HTTP

```http theme={"theme":{"light":"github-light","dark":"github-dark"}}
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

```java theme={"theme":{"light":"github-light","dark":"github-dark"}}
package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * <b>description</b> :
     * <p>使用 Token 初始化账号Client</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 中含有 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 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:
        """
        使用 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()
        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 中含有 code 和 message 属性，可帮助开发定位问题
                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 中含有 code 和 message 属性，可帮助开发定位问题
                pass

if __name__ == '__main__':
    Sample.main(sys.argv[1:])
```

PHP

```java theme={"theme":{"light":"github-light","dark":"github-dark"}}
<?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 {

    /**
     * 使用 Token 初始化账号Client
     * @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 中含有 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"}}
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:
// 
// 使用 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
  }

  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 中含有 code 和 message 属性，可帮助开发定位问题
    }

  }
  return _err
}

func main() {
  err := _main(tea.StringSlice(os.Args[1:]))
  if err != nil {
    panic(err)
  }
}
```

Node.js

```text theme={"theme":{"light":"github-light","dark":"github-dark"}}
'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 {

  /**
   * 使用 Token 初始化账号Client
   * @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 中含有 code 和 message 属性，可帮助开发定位问题
      }

    }    
  }

}

exports.Client = Client;
Client.main(process.argv.slice(2));
```

C#

```java theme={"theme":{"light":"github-light","dark":"github-dark"}}
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>使用 Token 初始化账号Client</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 中含有 code 和 message 属性，可帮助开发定位问题
                }
            }
            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 中含有 code 和 message 属性，可帮助开发定位问题
                }
            }
        }

    }
}
```

## 响应

### 响应体

| 名称            | 类型                   | 描述                                                                                           |
| ------------- | -------------------- | -------------------------------------------------------------------------------------------- |
| resultItems   | Array                | 批量获取的文件或文件夹信息列表。                                                                             |
| spaceId       | String               | 文件或文件夹所在空间ID。                                                                                |
| dentryId      | String               | 文件或文件夹的ID。                                                                                   |
| success       | Boolean              | 文件或文件夹获取是否成功，true表示成功。                                                                       |
| errorCode     | String               | 错误原因。                                                                                        |
| dentry        | Object               | 文件或文件夹的信息。                                                                                   |
| 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<String, Array>` | 在特定应用上的属性。                                                                                   |
|               | 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               | 缩略图信息。                                                                                       |
| width         | Integer              | 缩略图宽度，单位px。                                                                                  |
| height        | Integer              | 缩略图高度，单位px。                                                                                  |
| url           | String               | 缩略图url。                                                                                      |

### 响应体示例

```text theme={"theme":{"light":"github-light","dark":"github-dark"}}
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" : "测试文件夹",
      "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" : "uuid",
      "partitionType" : "PUBLIC_OSS_PARTITION",
      "storageDriver" : "DINGTALK",
      "thumbnail" : {
        "width" : 64,
        "height" : 64,
        "url" : "url"
      }
    }
  } ]
}
```

### 错误码

若调用该接口报错，可根据错误信息在[全局错误码](/zh/open/development/server-api-error-codes-1)文档中查找解决方案。

| HttpCode | 错误码              | 错误信息          | 说明               |
| -------- | ---------------- | ------------- | ---------------- |
| 400      | paramError       | %s            | 参数错误             |
| 403      | permissionDenied | %s            | 用户缺少获取文件(夹)信息的权限 |
| 404      | spaceNotExist    | %s            | 空间不存在            |
| 500      | systemError      | %s            | 系统错误             |
| 500      | unknownError     | Unknown Error | 未知错误             |
| 503      | operationTimeout | %s            | 请求超时             |