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

このAPIを呼び出して、ストレージスペース内にフォルダーまたはファイルを追加した際の関連情報を取得します。

API 呼び出し説明

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

リクエスト

基本情報

フィールド	値
HTTP URL	`https://api.dingtalk.io/v1.0/storage/spaces/{spaceId}/dentries/{dentryId}/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パラメータ値を取得できます。
dentryId	String	必須	ファイルまたはフォルダーIDです。ファイルまたはフォルダーリストの取得またはdentryUuidに基づいてspaceIdとdentryIdを取得APIを呼び出してidパラメータ値を取得できます。

クエリパラメータ

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

リクエストボディ

名前	タイプ	必須	説明
option	Object	任意	オプションパラメータです。
appIdsForAppProperties	Array of String	任意	指定したスペースownerIdリストに基づき、対応する可視属性を返します。最大20個まで。 - ownerTypeがAPPの場合、ownerIdはアプリ識別子です。 - ownerTypeがUSERの場合、ownerIdは作成者のunionIdです。
withThumbnail	Boolean	任意	ファイルサムネイルの一時リンクを取得するかどうか。必要に応じて取得してください。API呼び出しの所要時間に影響します。 - true：取得する - false（デフォルト）：取得しない

リクエスト例

HTTP

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

{
  "option" : {
    "appIdsForAppProperties" : [ "123" ],
    "withThumbnail" : false
  }
}

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.GetDentryHeaders getDentryHeaders = new com.aliyun.dingtalkstorage_1_0.models.GetDentryHeaders();
        getDentryHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkstorage_1_0.models.GetDentryRequest.GetDentryRequestOption option = new com.aliyun.dingtalkstorage_1_0.models.GetDentryRequest.GetDentryRequestOption()
                .setAppIdsForAppProperties(java.util.Arrays.asList(
                    "123"
                ))
                .setWithThumbnail(false);
        com.aliyun.dingtalkstorage_1_0.models.GetDentryRequest getDentryRequest = new com.aliyun.dingtalkstorage_1_0.models.GetDentryRequest()
                .setUnionId("cHtUYxxxxx")
                .setOption(option);
        try {
            client.getDentryWithOptions("854xxxxx", "653xxxxx", getDentryRequest, getDentryHeaders, 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_dentry_headers = dingtalkstorage__1__0_models.GetDentryHeaders()
        get_dentry_headers.x_acs_dingtalk_access_token = '<your access token>'
        option = dingtalkstorage__1__0_models.GetDentryRequestOption(
            app_ids_for_app_properties=[
                '123'
            ],
            with_thumbnail=False
        )
        get_dentry_request = dingtalkstorage__1__0_models.GetDentryRequest(
            union_id='cHtUYxxxxx',
            option=option
        )
        try:
            client.get_dentry_with_options('854xxxxx', '653xxxxx', get_dentry_request, get_dentry_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_dentry_headers = dingtalkstorage__1__0_models.GetDentryHeaders()
        get_dentry_headers.x_acs_dingtalk_access_token = '<your access token>'
        option = dingtalkstorage__1__0_models.GetDentryRequestOption(
            app_ids_for_app_properties=[
                '123'
            ],
            with_thumbnail=False
        )
        get_dentry_request = dingtalkstorage__1__0_models.GetDentryRequest(
            union_id='cHtUYxxxxx',
            option=option
        )
        try:
            await client.get_dentry_with_options_async('854xxxxx', '653xxxxx', get_dentry_request, get_dentry_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\GetDentryHeaders;
use AlibabaCloud\SDK\Dingtalk\Vstorage_1_0\Models\GetDentryRequest\option;
use AlibabaCloud\SDK\Dingtalk\Vstorage_1_0\Models\GetDentryRequest;
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();
        $getDentryHeaders = new GetDentryHeaders([]);
        $getDentryHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $option = new option([
            "appIdsForAppProperties" => [
                "123"
            ],
            "withThumbnail" => false
        ]);
        $getDentryRequest = new GetDentryRequest([
            "unionId" => "cHtUYxxxxx",
            "option" => $option
        ]);
        try {
            $client->getDentryWithOptions("854xxxxx", "653xxxxx", $getDentryRequest, $getDentryHeaders, 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
  }

  getDentryHeaders := &dingtalkstorage_1_0.GetDentryHeaders{}
  getDentryHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  option := &dingtalkstorage_1_0.GetDentryRequestOption{
    AppIdsForAppProperties: []*string{tea.String("123")},
    WithThumbnail: tea.Bool(false),
  }
  getDentryRequest := &dingtalkstorage_1_0.GetDentryRequest{
    UnionId: tea.String("cHtUYxxxxx"),
    Option: option,
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.GetDentryWithOptions(tea.String("854xxxxx"), tea.String("653xxxxx"), getDentryRequest, getDentryHeaders, &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 getDentryHeaders = new dingtalkstorage_1_0.GetDentryHeaders({ });
    getDentryHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let option = new dingtalkstorage_1_0.GetDentryRequestOption({
      appIdsForAppProperties: [
        '123'
      ],
      withThumbnail: false,
    });
    let getDentryRequest = new dingtalkstorage_1_0.GetDentryRequest({
      unionId: 'cHtUYxxxxx',
      option: option,
    });
    try {
      await client.getDentryWithOptions('854xxxxx', '653xxxxx', getDentryRequest, getDentryHeaders, 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.GetDentryHeaders getDentryHeaders = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.GetDentryHeaders();
            getDentryHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.GetDentryRequest.GetDentryRequestOption option = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.GetDentryRequest.GetDentryRequestOption
            {
                AppIdsForAppProperties = new List<string>
                {
                    "123"
                },
                WithThumbnail = false,
            };
            AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.GetDentryRequest getDentryRequest = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.GetDentryRequest
            {
                UnionId = "cHtUYxxxxx",
                Option = option,
            };
            try
            {
                client.GetDentryWithOptions("854xxxxx", "653xxxxx", getDentryRequest, getDentryHeaders, 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 属性が含まれ、開発者が問題を特定するのに役立ちます
                }
            }
        }

    }
}

レスポンス

レスポンスボディ

名前	タイプ	説明
dentry	Object	ファイルまたはフォルダー情報。
id	String	ファイルまたはフォルダーのid。
spaceId	String	所属するスペースID。
parentId	String	親ディレクトリ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>`	特定アプリ上の属性。keyはスペースの識別子、valueは属性リストです。
	Array	属性リスト。
name	String	属性名。
value	String	属性値。
visibility	String	属性の可視性： - PUBLIC：すべてのアプリで可視 - PRIVATE：現在のアプリのみで可視
uuid	String	ビジネス識別子。
partitionType	String	ストレージパーティション： - PUBLIC_OSS_PARTITION：パブリッククラウドOSSストレージパーティション - MINI_OSS_PARTITION：専有MiniOSSストレージパーティション
storageDriver	String	ドライバータイプ： - DINGTALK：DingTalk統一ストレージドライバー - ALIDOC：DingTalkドキュメントストレージドライバー - UNKNOWN：不明なドライバー
thumbnail	Object	サムネイル情報。
width	Integer	サムネイル幅（単位：px）。
height	Integer	サムネイル高さ（単位：px）。
url	String	サムネイルurl。

レスポンスボディ例

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

{
  "dentry" : {
    "id" : "653xxxxx",
    "spaceId" : "854xxxxx",
    "parentId" : "parent_id",
    "type" : "FILE",
    "name" : "テストファイル.xsl",
    "size" : 512,
    "path" : "/テストファイル.xsl",
    "version" : 1,
    "status" : "NORMAL",
    "extension" : "xsl",
    "creatorId" : "cHtUYxxxxx",
    "modifierId" : "cHtUYxxxxx",
    "createTime" : "2022-01-01T10:00:00Z",
    "modifiedTime" : "2022-01-01T10:00:00Z",
    "properties" : {
      "readOnly" : true
    },
    "appProperties" : [ {
      "name" : "property_name",
      "value" : "property_value",
      "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	スペースが存在しません
404	dentryNotExist	%s	ファイルが存在しません
500	systemError	%s	システムエラー
500	unknownError	Unknown Error	不明なエラー
503	operationTimeout	%s	リクエストタイムアウト

API 呼び出しガイド

認証と認可

連絡先

カレンダー

会議

AI Table

Docs とファイル

IM

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

API 呼び出し説明

リクエスト

基本情報

リクエストヘッダー

パスパラメータ

クエリパラメータ

リクエストボディ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディ例

エラーコード

​API 呼び出し説明

​リクエスト

​基本情報

​リクエストヘッダー

​パスパラメータ

​クエリパラメータ

​リクエストボディ

​リクエスト例

​レスポンス

​レスポンスボディ

​レスポンスボディ例

​エラーコード

API 呼び出し説明

リクエスト

基本情報

リクエストヘッダー

パスパラメータ

クエリパラメータ

リクエストボディ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディ例

エラーコード