Skip to main content
Call this API to batch copy files or folders to another space or folder.

Request

Basic information

FieldValue
HTTP URLhttps://api.dingtalk.io/v1.0/storage/spaces/{spaceId}/dentries/batchCopy
HTTP MethodPOST
Supported app typesappType-Internal app appType-Third-party enterprise app
Required permissionspermission-Storage.File.Write-Storage file write permission

Request headers

NameTypeRequiredDescription
x-acs-dingtalk-access-tokenStringYesThe access credential for calling this API. Obtain it as follows: - For an internal app, call the Obtain the access token of an internal app API. - For a third-party enterprise app, call the Obtain the access token of the authorized enterprise API.

Path parameters

NameTypeRequiredDescription
spaceIdStringYesThe ID of the space where the source files or folders are located. Call the Add space API to obtain the value of the id parameter.

Query parameters

NameTypeRequiredDescription
unionIdStringYesThe unionId of the operator. Call the Query user details API to obtain the value of the unionid parameter.

Request body

NameTypeRequiredDescription
targetSpaceIdStringYesThe ID of the space where the target files or folders are located. Call the Add space API to obtain the value of the id parameter.
targetFolderIdStringYesThe ID of the target folder. The root folder ID is 0. Call the Get a list of files or folders API to obtain the value of the id parameter.
dentryIdsArray of StringYesThe list of source file or folder IDs. Up to 3 IDs can be specified. Call the Get a list of files or folders or Get the spaceId and dentryId by dentryUuid API to obtain the value of the id parameter.
optionObjectNoOptional parameters.
conflictStrategyStringNoThe strategy for handling file or folder name conflicts. - AUTO_RENAME (default): Automatically rename. - OVERWRITE: Overwrite. - RETURN_DENTRY_IF_EXISTS: Return the existing file. - RETURN_ERROR_IF_EXISTS: Return an error if the file already exists.

Request example

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>Initialize the account Client with a Token</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 contains the code and message attributes, which help locate the issue
            }

        } 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 contains the code and message attributes, which help locate the issue
            }

        }        
    }
}
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:
        """
        Initialize the account Client with a Token
        @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 contains the code and message attributes, which help locate the issue
                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 contains the code and message attributes, which help locate the issue
                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 {

    /**
     * Initialize the account Client with a Token
     * @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 contains the code and message attributes, which help locate the issue
            }
        }
    }
}
$path = __DIR__ . \DIRECTORY_SEPARATOR . '..' . \DIRECTORY_SEPARATOR . 'vendor' . \DIRECTORY_SEPARATOR . 'autoload.php';
if (file_exists($path)) {
    require_once $path;
}
Sample::main(array_slice($argv, 1));
Go
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:
// 
// Initialize the account Client with a Token
// 
// @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 contains the code and message attributes, which help locate the issue
    }

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

  /**
   * Initialize the account Client with a Token
   * @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 contains the code and message attributes, which help locate the issue
      }

    }    
  }

}

exports.Client = Client;
Client.main(process.argv.slice(2));
C#
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>Initialize the account Client with a Token</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 contains the code and message attributes, which help locate the issue
                }
            }
            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 contains the code and message attributes, which help locate the issue
                }
            }
        }

    }
}

Response

Response body

NameTypeDescription
resultItemsArrayThe result list of the batch copy operation for files or folders.
spaceIdStringThe ID of the space where the source files or folders are located.
dentryIdStringThe ID of the source file or folder.
asyncBooleanIndicates whether the task is asynchronous. - true: Yes. - false: No. If the folder being operated on has child nodes, the operation is processed asynchronously.
successBooleanIndicates whether the operation succeeded. - true: Succeeded. - false: Failed. This field is not returned for asynchronous tasks.
errorCodeStringThe error reason. This field is not returned for asynchronous tasks.
taskIdStringThe asynchronous task ID, which can be used to query the task execution status.
targetSpaceIdStringThe target space ID. This field is returned for both synchronous and asynchronous operations, except in failure cases.
targetDentryIdStringThe ID of the file or folder after copying. This field is returned for both synchronous and asynchronous operations, except in failure cases.

Response body example

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

Error codes

If an error is returned when you call this API, refer to the Global error codes document for solutions based on the error message.
HttpCodeError codeError messageDescription
400operationConcurrentControl%sConcurrency control.
400paramError%sParameter error.
400paramError.spaceId%sParameter error - spaceId.
400paramError.dentryIds%sParameter error - dentryIds.
400paramError.targetSpaceId%sParameter error - targetSpaceId.
400paramError.targetFolderId%sParameter error - targetFolderId.
400paramError.conflictStrategy%sParameter error - conflictStrategy.
400spaceQuotaInsufficient%sInsufficient space quota.
400sceneQuotaInsufficient%sInsufficient scene quota.
400appQuotaInsufficient%sInsufficient app quota.
400orgQuotaInsufficient%sInsufficient organization quota.
400dentryAlreadyExist%sA file with the same name already exists.
403permissionDenied%sThe user does not have permission to copy the file or folder.
404spaceNotExist%sThe space containing the source file (or folder) or the target folder does not exist.
404dentryNotExist%sThe source file (or folder) or the target folder does not exist.
500systemError%sSystem error.
500unknownErrorUnknown ErrorUnknown error.
503operationTimeout%sRequest timed out.