スペース配下のすべてのファイルまたはフォルダー一覧を取得

本インターフェースを呼び出して、スペース配下のすべてのファイルまたはフォルダー一覧をフラットに取得します。

リクエスト

基本情報

フィールド	値
HTTP URL	`https://api.dingtalk.io/v1.0/storage/spaces/{spaceId}/dentries/listAll`
HTTP Method	POST
対応アプリタイプ	appType-社内アプリ　appType-サードパーティ社内アプリ
必要な権限	permission-Storage.File.Read-企業ストレージファイル読み取り権限

リクエストヘッダー

名前	タイプ	必須	説明
x-acs-dingtalk-access-token	String	はい	本インターフェースを呼び出すためのアクセス認証情報。以下の方法で取得します： - 社内アプリの場合は、社内アプリのaccessTokenを取得インターフェースを呼び出して取得します。 - サードパーティ社内アプリの場合は、サードパーティアプリ認可企業のaccessTokenを取得インターフェースを呼び出して取得します。

パスパラメータ

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

クエリパラメータ

名前	タイプ	必須	説明
unionId	String	はい	操作ユーザーのunionId。ユーザー詳細照会インターフェースを呼び出して取得できます。

リクエストボディ

名前	タイプ	必須	説明
option	Object	いいえ	オプションパラメータ。
nextToken	String	いいえ	ページングカーソル。 - 初回呼び出しの場合は、このパラメータを渡しません。 - 2回目以降の呼び出しの場合は、前回の呼び出しで返されたnextTokenを渡します。
maxResults	Integer	いいえ	1ページあたりのエントリ数。デフォルトは50、最大は50です。
order	String	いいえ	並べ替えルール。現時点では編集時間による並び替えのみサポートします。 - ASC（デフォルト）：昇順 - DESC：降順 - 昇順の場合、ページング取得中にファイルが変更されると、データが重複して取得される可能性があります。 - 降順の場合、ページング取得中にファイルが変更されると、データが欠落する可能性があります。
withThumbnail	Boolean	いいえ	ファイルサムネイルのリンクを取得するかどうか。 - true：はい - false（デフォルト）：いいえ必要に応じて取得してください。取得するとインターフェースの処理時間が増加します。

リクエスト例

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 {

    /**
     * トークンを使用してアカウントClientを初期化
     * @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 には 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 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:
        """
        トークンを使用してアカウント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()
        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 には code と message プロパティが含まれており、開発者の問題特定に役立ちます
                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 には 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\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 {

    /**
     * トークンを使用してアカウント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();
        $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 には 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));

// 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"
)

/**
 * トークンを使用してアカウント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
  }

  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 には code と message プロパティが含まれており、開発者の問題特定に役立ちます
    }

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

  /**
   * トークンを使用してアカウントClientを初期化
   * @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 には code と message プロパティが含まれており、開発者の問題特定に役立ちます
      }

    }    
  }

}

Client.main(process.argv.slice(2));

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

        /**
         * トークンを使用してアカウントClientを初期化
         * @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 には 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 プロパティが含まれており、開発者の問題特定に役立ちます
                }
            }
        }

    }
}

レスポンス

レスポンスボディ

名前	タイプ	説明
dentries	Array	返却されるファイルまたはフォルダー一覧。
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	サムネイル情報。 withThumbnailパラメータの値がtrueの場合のみ返却されます。
width	Integer	サムネイルの幅。単位はpx。
height	Integer	サムネイルの高さ。単位はpx。
url	String	サムネイルのurl。
nextToken	String	ページングカーソル。このパラメータが空でない場合、まだデータがあることを示します。

レスポンスボディ例

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

{
  "dentries" : [ {
    "id" : "677xxxxx",
    "spaceId" : "789xxxxx",
    "parentId" : "766xxxxx",
    "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" : "123xxxxx",
    "partitionType" : "PUBLIC_OSS_PARTITION",
    "storageDriver" : "DINGTALK",
    "thumbnail" : {
      "width" : 64,
      "height" : 64,
      "url" : "url"
    }
  } ],
  "nextToken" : "8965000xxxxx"
}

エラーコード

本インターフェースの呼び出しでエラーが発生した場合は、エラーメッセージをもとにグローバルエラーコードドキュメントから解決策をご確認ください。

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

API 呼び出しガイド

認証と認可

連絡先

カレンダー

会議

AI Table

Docs とファイル

IM

スペース配下のすべてのファイルまたはフォルダー一覧を取得

リクエスト

基本情報

リクエストヘッダー

パスパラメータ

クエリパラメータ

リクエストボディ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディ例

エラーコード

​リクエスト

​基本情報

​リクエストヘッダー

​パスパラメータ

​クエリパラメータ

​リクエストボディ

​リクエスト例

​レスポンス

​レスポンスボディ

​レスポンスボディ例

​エラーコード

リクエスト

基本情報

リクエストヘッダー

パスパラメータ

クエリパラメータ

リクエストボディ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディ例

エラーコード