ファイルのサムネイルを一括取得

本インターフェースを呼び出して、ファイルのサムネイル情報を一括取得します。

インターフェース機能の紹介

ストレージスペースにアップロードされた画像、WPS 形式のドキュメント（Word、Excel、PowerPoint）、PDF 形式ファイルおよび txt 形式ファイルは、非同期で自動的にサムネイルが生成されます。本インターフェースを呼び出すことで、ストレージファイルのサムネイル情報を一括取得できます。

権限

この API を呼び出すには、以下のいずれかの権限が必要です。

アプリタイプ	対応可否	権限	API Explorer デバッグ
社内アプリ	対応	企業ストレージファイル読み取り権限	API Explorer
サードパーティ社内アプリ	対応	企業ストレージファイル読み取り権限	API Explorer
サードパーティ個人アプリ	未対応	企業ストレージファイル読み取り権限	未対応

HTTP メソッド

POST /v1.0/storage/spaces/{spaceId}/thumbnails/query?unionId=String HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:String
Content-Type:application/json

{
  "dentryIds" : [ "String" ]
}

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

Path パラメータ

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

Query パラメータ

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

Body パラメータ

名前	タイプ	必須	説明
dentryIds	Array of String	はい	ファイル ID。最大値は 30。ファイルまたはフォルダーリスト取得インターフェースを呼び出して id パラメータの値を取得します。

レスポンスパラメータ

名前	タイプ	説明
resultItems	Array	サムネイル取得結果リスト。
spaceId	String	ファイルが所在するスペース ID。
dentryId	String	ファイル ID。
success	Boolean	サムネイル情報の取得に成功したかどうか。true は成功を示します。
errorCode	String	エラー原因。
thumbnail	Object	サムネイル情報。
width	Integer	サムネイルの幅、単位は px。
height	Integer	サムネイルの高さ、単位は px。
url	String	サムネイルの URL。

サンプル

リクエスト例

HTTP

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

{
  "dentryIds" : [ "790xxxxx" ]
}

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.GetDentryThumbnailsHeaders getDentryThumbnailsHeaders = new com.aliyun.dingtalkstorage_1_0.models.GetDentryThumbnailsHeaders();
        getDentryThumbnailsHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkstorage_1_0.models.GetDentryThumbnailsRequest getDentryThumbnailsRequest = new com.aliyun.dingtalkstorage_1_0.models.GetDentryThumbnailsRequest()
                .setUnionId("chyxxxxx")
                .setDentryIds(java.util.Arrays.asList(
                    "790xxxxx"
                ));
        try {
            client.getDentryThumbnailsWithOptions("785xxxxx", getDentryThumbnailsRequest, getDentryThumbnailsHeaders, 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()
        get_dentry_thumbnails_headers = dingtalkstorage__1__0_models.GetDentryThumbnailsHeaders()
        get_dentry_thumbnails_headers.x_acs_dingtalk_access_token = '<your access token>'
        get_dentry_thumbnails_request = dingtalkstorage__1__0_models.GetDentryThumbnailsRequest(
            union_id='chyxxxxx',
            dentry_ids=[
                '790xxxxx'
            ]
        )
        try:
            client.get_dentry_thumbnails_with_options('785xxxxx', get_dentry_thumbnails_request, get_dentry_thumbnails_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_thumbnails_headers = dingtalkstorage__1__0_models.GetDentryThumbnailsHeaders()
        get_dentry_thumbnails_headers.x_acs_dingtalk_access_token = '<your access token>'
        get_dentry_thumbnails_request = dingtalkstorage__1__0_models.GetDentryThumbnailsRequest(
            union_id='chyxxxxx',
            dentry_ids=[
                '790xxxxx'
            ]
        )
        try:
            await client.get_dentry_thumbnails_with_options_async('785xxxxx', get_dentry_thumbnails_request, get_dentry_thumbnails_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\GetDentryThumbnailsHeaders;
use AlibabaCloud\SDK\Dingtalk\Vstorage_1_0\Models\GetDentryThumbnailsRequest;
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();
        $getDentryThumbnailsHeaders = new GetDentryThumbnailsHeaders([]);
        $getDentryThumbnailsHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $getDentryThumbnailsRequest = new GetDentryThumbnailsRequest([
            "unionId" => "chyxxxxx",
            "dentryIds" => [
                "790xxxxx"
            ]
        ]);
        try {
            $client->getDentryThumbnailsWithOptions("785xxxxx", $getDentryThumbnailsRequest, $getDentryThumbnailsHeaders, 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
  }

  getDentryThumbnailsHeaders := &dingtalkstorage_1_0.GetDentryThumbnailsHeaders{}
  getDentryThumbnailsHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  getDentryThumbnailsRequest := &dingtalkstorage_1_0.GetDentryThumbnailsRequest{
    UnionId: tea.String("chyxxxxx"),
    DentryIds: []*string{tea.String("790xxxxx")},
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.GetDentryThumbnailsWithOptions(tea.String("785xxxxx"), getDentryThumbnailsRequest, getDentryThumbnailsHeaders, &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 getDentryThumbnailsHeaders = new $dingtalkstorage_1_0.GetDentryThumbnailsHeaders({ });
    getDentryThumbnailsHeaders.xAcsDingtalkAccessToken = "<your access token>";
    let getDentryThumbnailsRequest = new $dingtalkstorage_1_0.GetDentryThumbnailsRequest({
      unionId: "chyxxxxx",
      dentryIds: [
        "790xxxxx"
      ],
    });
    try {
      await client.getDentryThumbnailsWithOptions("785xxxxx", getDentryThumbnailsRequest, getDentryThumbnailsHeaders, 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.GetDentryThumbnailsHeaders getDentryThumbnailsHeaders = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.GetDentryThumbnailsHeaders();
            getDentryThumbnailsHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.GetDentryThumbnailsRequest getDentryThumbnailsRequest = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.GetDentryThumbnailsRequest
            {
                UnionId = "chyxxxxx",
                DentryIds = new List<string>
                {
                    "790xxxxx"
                },
            };
            try
            {
                client.GetDentryThumbnailsWithOptions("785xxxxx", getDentryThumbnailsRequest, getDentryThumbnailsHeaders, 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 属性が含まれており、開発者の問題特定に役立ちます
                }
            }
        }

    }
}

レスポンス例

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

{
  "resultItems" : [ {
    "spaceId" : "785xxxxx",
    "dentryId" : "790xxxxx",
    "success" : true,
    "errorCode" : "permissionDenied",
    "thumbnail" : {
      "width" : 64,
      "height" : 64,
      "url" : "url"
    }
  } ]
}

エラーコード

HttpCode	エラーコード	エラーメッセージ	説明
400	paramError	%s	パラメータエラー
400	paramError.spaceId	%s	パラメータエラー - spaceId
400	paramError.dentryIds	%s	パラメータエラー - dentryIds
400	permissionDenied	%s	サムネイルを取得する権限がありません
400	dentryNotExist	%s	ファイルが存在しません
400	dentryFormatNotSupport	%s	この形式はサムネイル取得をサポートしていません
400	fileViral	%s	ウイルスファイル
400	fileMalicious	%s	悪意のあるファイル
403	thumbnailNotExist	%s	サムネイルが存在しません
500	systemError	%s	システムエラー
500	unknownError	Unknown Error	不明なエラー

API 呼び出しガイド

認証と認可

連絡先

カレンダー

会議

AI Table

Docs とファイル

IM

ファイルのサムネイルを一括取得

インターフェース機能の紹介

権限

HTTP メソッド

Header パラメータ

Path パラメータ

Query パラメータ

Body パラメータ

レスポンスパラメータ

サンプル

リクエスト例

レスポンス例

エラーコード

​インターフェース機能の紹介

​権限

​HTTP メソッド

​Header パラメータ

​Path パラメータ

​Query パラメータ

​Body パラメータ

​レスポンスパラメータ

​サンプル

​リクエスト例

​レスポンス例

​エラーコード

インターフェース機能の紹介

権限

HTTP メソッド

Header パラメータ

Path パラメータ

Query パラメータ

Body パラメータ

レスポンスパラメータ

サンプル

リクエスト例

レスポンス例

エラーコード