ファイルまたはフォルダー情報の一括取得

ストレージスペース内に追加されたフォルダーやアップロードされたファイルについて、本 API を呼び出すことで関連情報を一括取得できます。

API 呼び出し説明

ファイルおよびフォルダー情報を取得する際、フォルダーの場合はファイルサイズおよびファイル拡張子フィールドを取得できません。

リクエスト

基本情報

フィールド	値
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	はい	この API を呼び出すためのアクセス認証情報。以下の方法で取得します： - 社内アプリの場合、社内アプリのaccessTokenを取得 APIを呼び出して取得します。 - サードパーティ社内アプリの場合、サードパーティアプリが権限付与された企業のaccessTokenを取得 APIを呼び出して取得します。

パスパラメータ

名前	タイプ	必須	説明
spaceId	String	はい	スペース ID。スペースを追加 API を呼び出して id パラメータ値を取得できます。

クエリパラメータ

名前	タイプ	必須	説明
unionId	String	はい	操作者の unionId。ユーザー詳細の照会 API を呼び出して unionid パラメータ値を取得できます。

リクエストボディ

名前	タイプ	必須	説明
dentryIds	Array of String	はい	ファイルまたはフォルダーの ID リスト。最大 30 個。ファイルまたはフォルダーのリストを取得または dentryUuid から spaceId と dentryId を取得 API を呼び出して id パラメータ値を取得できます。
option	Object	いいえ	オプションパラメータ。
appIdsForAppProperties	Array of String	いいえ	指定するアプリ ID リスト。最大 20 個。スペース情報の取得 API を介して ownerId パラメータ値を取得できます。 - このパラメータを渡すと、当該ファイルまたはフォルダーに対応するアプリの属性が返されます。 - このパラメータを渡さない場合、当該ファイルまたはフォルダーのすべてのアプリの属性が返されます。
withThumbnail	Boolean	いいえ	ファイルのサムネイル情報を取得するかどうか。 - true：はい - false：いいえ必要に応じて取得してください。取得時には API の処理時間が増加します。

リクエスト例

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>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

# -*- 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

<?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));

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

'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));

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：DingTalk 統合ストレージドライバー - ALIDOC：DingTalk ドキュメントストレージドライバー - SHANJI：閃記ストレージドライバー - UNKNOWN：不明なドライバー
thumbnail	Object	サムネイル情報。
width	Integer	サムネイルの幅。単位は px。
height	Integer	サムネイルの高さ。単位は px。
url	String	サムネイルの url。

レスポンスボディ例

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"
      }
    }
  } ]
}

エラーコード

この API の呼び出し時にエラーが発生した場合、エラーメッセージをもとにグローバルエラーコードドキュメントで解決方法を検索してください。

HttpCode	エラーコード	エラーメッセージ	説明
400	paramError	%s	パラメータエラー
403	permissionDenied	%s	ユーザーにファイル（フォルダー）情報を取得する権限がありません
404	spaceNotExist	%s	スペースが存在しません
500	systemError	%s	システムエラー
500	unknownError	Unknown Error	不明なエラー
503	operationTimeout	%s	リクエストタイムアウト

API 呼び出しガイド

認証と認可

連絡先

カレンダー

会議

AI Table

Docs とファイル

IM

ファイルまたはフォルダー情報の一括取得

API 呼び出し説明

リクエスト

基本情報

リクエストヘッダー

パスパラメータ

クエリパラメータ

リクエストボディ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディ例

エラーコード

​API 呼び出し説明

​リクエスト

​基本情報

​リクエストヘッダー

​パスパラメータ

​クエリパラメータ

​リクエストボディ

​リクエスト例

​レスポンス

​レスポンスボディ

​レスポンスボディ例

​エラーコード

API 呼び出し説明

リクエスト

基本情報

リクエストヘッダー

パスパラメータ

クエリパラメータ

リクエストボディ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディ例

エラーコード