ファイルまたはフォルダーの一括コピー

本インターフェースを呼び出すことで、ファイルまたはフォルダーを他のスペースやディレクトリに一括コピーできます。

リクエスト

基本情報

フィールド	値
HTTP URL	`https://api.dingtalk.io/v1.0/storage/spaces/{spaceId}/dentries/batchCopy`
HTTP Method	POST
サポートするアプリタイプ	appType-社内アプリ　appType-サードパーティ社内アプリ
権限要件	permission-Storage.File.Write-企業ストレージファイル書き込み権限

リクエストヘッダー

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

パスパラメータ

名前	タイプ	必須	説明
spaceId	String	はい	コピー元ファイルまたはフォルダーが存在するスペース ID。スペース追加インターフェースを呼び出して id パラメータ値を取得できます。

クエリパラメータ

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

リクエストボディ

名前	タイプ	必須	説明
targetSpaceId	String	はい	コピー先ファイルまたはフォルダーが存在するスペース ID。スペース追加インターフェースを呼び出して id パラメータ値を取得できます。
targetFolderId	String	はい	コピー先フォルダー ID。ルートディレクトリの ID 値は 0 です。ファイルまたはフォルダーリストの取得インターフェースを通じて id パラメータ値を取得できます。
dentryIds	Array of String	はい	コピー元ファイルまたはフォルダーの ID リスト（最大 3 個）。ファイルまたはフォルダーリストの取得または dentryUuid に基づいて spaceId と dentryId を取得インターフェースを呼び出して id パラメータ値を取得できます。
option	Object	いいえ	オプションパラメータ。
conflictStrategy	String	いいえ	ファイルまたはフォルダーの名前競合戦略。 - AUTO_RENAME（デフォルト）：自動的に名前を変更 - OVERWRITE：上書き - RETURN_DENTRY_IF_EXISTS：既存のファイルを返す - RETURN_ERROR_IF_EXISTS：ファイルが既に存在する場合はエラーを返す

リクエスト例

HTTP

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

{
  "targetSpaceId" : "769xxxxx",
  "targetFolderId" : "665xxxxx",
  "dentryIds" : [ "123,987" ],
  "option" : {
    "conflictStrategy" : "AUTO_RENAME"
  }
}

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.CopyDentriesHeaders copyDentriesHeaders = new com.aliyun.dingtalkstorage_1_0.models.CopyDentriesHeaders();
        copyDentriesHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkstorage_1_0.models.CopyDentriesRequest.CopyDentriesRequestOption option = new com.aliyun.dingtalkstorage_1_0.models.CopyDentriesRequest.CopyDentriesRequestOption()
                .setConflictStrategy("AUTO_RENAME");
        com.aliyun.dingtalkstorage_1_0.models.CopyDentriesRequest copyDentriesRequest = new com.aliyun.dingtalkstorage_1_0.models.CopyDentriesRequest()
                .setUnionId("chyxxxxx")
                .setTargetSpaceId("769xxxxx")
                .setTargetFolderId("665xxxxx")
                .setDentryIds(java.util.Arrays.asList(
                    "123,987"
                ))
                .setOption(option);
        try {
            client.copyDentriesWithOptions("789xxxxx", copyDentriesRequest, copyDentriesHeaders, 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()
        copy_dentries_headers = dingtalkstorage__1__0_models.CopyDentriesHeaders()
        copy_dentries_headers.x_acs_dingtalk_access_token = '<your access token>'
        option = dingtalkstorage__1__0_models.CopyDentriesRequestOption(
            conflict_strategy='AUTO_RENAME'
        )
        copy_dentries_request = dingtalkstorage__1__0_models.CopyDentriesRequest(
            union_id='chyxxxxx',
            target_space_id='769xxxxx',
            target_folder_id='665xxxxx',
            dentry_ids=[
                '123,987'
            ],
            option=option
        )
        try:
            client.copy_dentries_with_options('789xxxxx', copy_dentries_request, copy_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()
        copy_dentries_headers = dingtalkstorage__1__0_models.CopyDentriesHeaders()
        copy_dentries_headers.x_acs_dingtalk_access_token = '<your access token>'
        option = dingtalkstorage__1__0_models.CopyDentriesRequestOption(
            conflict_strategy='AUTO_RENAME'
        )
        copy_dentries_request = dingtalkstorage__1__0_models.CopyDentriesRequest(
            union_id='chyxxxxx',
            target_space_id='769xxxxx',
            target_folder_id='665xxxxx',
            dentry_ids=[
                '123,987'
            ],
            option=option
        )
        try:
            await client.copy_dentries_with_options_async('789xxxxx', copy_dentries_request, copy_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\CopyDentriesHeaders;
use AlibabaCloud\SDK\Dingtalk\Vstorage_1_0\Models\CopyDentriesRequest\option;
use AlibabaCloud\SDK\Dingtalk\Vstorage_1_0\Models\CopyDentriesRequest;
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();
        $copyDentriesHeaders = new CopyDentriesHeaders([]);
        $copyDentriesHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $option = new option([
            "conflictStrategy" => "AUTO_RENAME"
        ]);
        $copyDentriesRequest = new CopyDentriesRequest([
            "unionId" => "chyxxxxx",
            "targetSpaceId" => "769xxxxx",
            "targetFolderId" => "665xxxxx",
            "dentryIds" => [
                "123,987"
            ],
            "option" => $option
        ]);
        try {
            $client->copyDentriesWithOptions("789xxxxx", $copyDentriesRequest, $copyDentriesHeaders, 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
  }

  copyDentriesHeaders := &dingtalkstorage_1_0.CopyDentriesHeaders{}
  copyDentriesHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  option := &dingtalkstorage_1_0.CopyDentriesRequestOption{
    ConflictStrategy: tea.String("AUTO_RENAME"),
  }
  copyDentriesRequest := &dingtalkstorage_1_0.CopyDentriesRequest{
    UnionId: tea.String("chyxxxxx"),
    TargetSpaceId: tea.String("769xxxxx"),
    TargetFolderId: tea.String("665xxxxx"),
    DentryIds: []*string{tea.String("123,987")},
    Option: option,
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.CopyDentriesWithOptions(tea.String("789xxxxx"), copyDentriesRequest, copyDentriesHeaders, &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 copyDentriesHeaders = new dingtalkstorage_1_0.CopyDentriesHeaders({ });
    copyDentriesHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let option = new dingtalkstorage_1_0.CopyDentriesRequestOption({
      conflictStrategy: 'AUTO_RENAME',
    });
    let copyDentriesRequest = new dingtalkstorage_1_0.CopyDentriesRequest({
      unionId: 'chyxxxxx',
      targetSpaceId: '769xxxxx',
      targetFolderId: '665xxxxx',
      dentryIds: [
        '123,987'
      ],
      option: option,
    });
    try {
      await client.copyDentriesWithOptions('789xxxxx', copyDentriesRequest, copyDentriesHeaders, 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.CopyDentriesHeaders copyDentriesHeaders = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.CopyDentriesHeaders();
            copyDentriesHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.CopyDentriesRequest.CopyDentriesRequestOption option = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.CopyDentriesRequest.CopyDentriesRequestOption
            {
                ConflictStrategy = "AUTO_RENAME",
            };
            AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.CopyDentriesRequest copyDentriesRequest = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.CopyDentriesRequest
            {
                UnionId = "chyxxxxx",
                TargetSpaceId = "769xxxxx",
                TargetFolderId = "665xxxxx",
                DentryIds = new List<string>
                {
                    "123,987"
                },
                Option = option,
            };
            try
            {
                client.CopyDentriesWithOptions("789xxxxx", copyDentriesRequest, copyDentriesHeaders, 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。
async	Boolean	非同期タスクかどうか。 - true：はい - false：いいえ操作対象フォルダーに子ノードがある場合は、非同期で処理されます。
success	Boolean	成功かどうか。 - true：成功 - false：失敗非同期タスクの場合、本フィールドは返されません。
errorCode	String	エラー原因。非同期タスクの場合、本フィールドは返されません。
taskId	String	非同期タスク ID。タスクの実行状態のクエリに使用できます。
targetSpaceId	String	コピー先スペース ID。失敗時を除き、同期・非同期いずれの場合も返されます。
targetDentryId	String	コピー後のファイルまたはフォルダー ID。失敗時を除き、同期・非同期いずれの場合も返されます。

レスポンスボディ例

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

{
  "resultItems" : [ {
    "spaceId" : "658xxxxx",
    "dentryId" : "124xxxxx",
    "async" : true,
    "success" : true,
    "errorCode" : "permissionDenied",
    "taskId" : "123xxxxx",
    "targetSpaceId" : "638xxxxx",
    "targetDentryId" : "568xxxxx"
  } ]
}

エラーコード

本インターフェースの呼び出しでエラーが発生した場合、エラーメッセージをもとにグローバルエラーコードドキュメントで解決策を検索できます。

HttpCode	エラーコード	エラーメッセージ	説明
400	operationConcurrentControl	%s	同時実行制御
400	paramError	%s	パラメータエラー
400	paramError.spaceId	%s	パラメータエラー-spaceId
400	paramError.dentryIds	%s	パラメータエラー-dentryIds
400	paramError.targetSpaceId	%s	パラメータエラー-targetSpaceId
400	paramError.targetFolderId	%s	パラメータエラー-targetFolderId
400	paramError.conflictStrategy	%s	パラメータエラー-conflictStrategy
400	spaceQuotaInsufficient	%s	スペース容量不足
400	sceneQuotaInsufficient	%s	シーン容量不足
400	appQuotaInsufficient	%s	アプリ容量不足
400	orgQuotaInsufficient	%s	企業容量不足
400	dentryAlreadyExist	%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

ファイルまたはフォルダーの一括コピー

リクエスト

基本情報

リクエストヘッダー

パスパラメータ

クエリパラメータ

リクエストボディ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディ例

エラーコード

​リクエスト

​基本情報

​リクエストヘッダー

​パスパラメータ

​クエリパラメータ

​リクエストボディ

​リクエスト例

​レスポンス

​レスポンスボディ

​レスポンスボディ例

​エラーコード

リクエスト

基本情報

リクエストヘッダー

パスパラメータ

クエリパラメータ

リクエストボディ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディ例

エラーコード