Skip to main content
Call this API to batch move files or folders to any other location.

Request

Basic information

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

Request header

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

Path parameter

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

Query parameter

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 target space. Call the Add space API to obtain the value of the id parameter.
targetFolderIdStringYesThe ID of the target folder. The ID of the root directory is 0. Call the Get a list of files or folders API to obtain the value.
dentryIdsArray of StringYesThe list of IDs of the source files or folders. Up to 30 items are supported. Call the Get a list of files or folders or Get spaceId and dentryId by dentryUuid API to obtain the value of the id parameter.
optionObjectNoOptional parameters.
conflictStrategyStringNoThe name conflict strategy for files or folders. - AUTO_RENAME: automatically rename. Default value. - OVERWRITE: overwrite. - RETURN_DENTRY_IF_EXISTS: return the existing file. - RETURN_ERROR_IF_EXISTS: return an error if the file already exists.
preservePermissionsBooleanNoWhether to preserve permissions after the move. - true: preserve. - false (default): do not preserve.

Request example

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

{
  "targetSpaceId" : "890xxxxx",
  "targetFolderId" : "899xxxxx",
  "dentryIds" : [ "456xxxxx" ],
  "option" : {
    "conflictStrategy" : "AUTO_RENAME",
    "preservePermissions" : true
  }
}
Java
package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * <b>description</b> :
     * <p>Initialize the account client using 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.MoveDentriesHeaders moveDentriesHeaders = new com.aliyun.dingtalkstorage_1_0.models.MoveDentriesHeaders();
        moveDentriesHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkstorage_1_0.models.MoveDentriesRequest.MoveDentriesRequestOption option = new com.aliyun.dingtalkstorage_1_0.models.MoveDentriesRequest.MoveDentriesRequestOption()
                .setConflictStrategy("AUTO_RENAME")
                .setPreservePermissions(true);
        com.aliyun.dingtalkstorage_1_0.models.MoveDentriesRequest moveDentriesRequest = new com.aliyun.dingtalkstorage_1_0.models.MoveDentriesRequest()
                .setUnionId("chyxxxxx")
                .setTargetSpaceId("890xxxxx")
                .setTargetFolderId("899xxxxx")
                .setDentryIds(java.util.Arrays.asList(
                    "456xxxxx"
                ))
                .setOption(option);
        try {
            client.moveDentriesWithOptions("576xxxxx", moveDentriesRequest, moveDentriesHeaders, 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 code and message attributes that 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 code and message attributes that 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 using 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()
        move_dentries_headers = dingtalkstorage__1__0_models.MoveDentriesHeaders()
        move_dentries_headers.x_acs_dingtalk_access_token = '<your access token>'
        option = dingtalkstorage__1__0_models.MoveDentriesRequestOption(
            conflict_strategy='AUTO_RENAME',
            preserve_permissions=True
        )
        move_dentries_request = dingtalkstorage__1__0_models.MoveDentriesRequest(
            union_id='chyxxxxx',
            target_space_id='890xxxxx',
            target_folder_id='899xxxxx',
            dentry_ids=[
                '456xxxxx'
            ],
            option=option
        )
        try:
            client.move_dentries_with_options('576xxxxx', move_dentries_request, move_dentries_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err contains code and message attributes that help locate the issue
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        move_dentries_headers = dingtalkstorage__1__0_models.MoveDentriesHeaders()
        move_dentries_headers.x_acs_dingtalk_access_token = '<your access token>'
        option = dingtalkstorage__1__0_models.MoveDentriesRequestOption(
            conflict_strategy='AUTO_RENAME',
            preserve_permissions=True
        )
        move_dentries_request = dingtalkstorage__1__0_models.MoveDentriesRequest(
            union_id='chyxxxxx',
            target_space_id='890xxxxx',
            target_folder_id='899xxxxx',
            dentry_ids=[
                '456xxxxx'
            ],
            option=option
        )
        try:
            await client.move_dentries_with_options_async('576xxxxx', move_dentries_request, move_dentries_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err contains code and message attributes that 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\MoveDentriesHeaders;
use AlibabaCloud\SDK\Dingtalk\Vstorage_1_0\Models\MoveDentriesRequest\option;
use AlibabaCloud\SDK\Dingtalk\Vstorage_1_0\Models\MoveDentriesRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * Initialize the account client using 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();
        $moveDentriesHeaders = new MoveDentriesHeaders([]);
        $moveDentriesHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $option = new option([
            "conflictStrategy" => "AUTO_RENAME",
            "preservePermissions" => true
        ]);
        $moveDentriesRequest = new MoveDentriesRequest([
            "unionId" => "chyxxxxx",
            "targetSpaceId" => "890xxxxx",
            "targetFolderId" => "899xxxxx",
            "dentryIds" => [
                "456xxxxx"
            ],
            "option" => $option
        ]);
        try {
            $client->moveDentriesWithOptions("576xxxxx", $moveDentriesRequest, $moveDentriesHeaders, 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 code and message attributes that 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 using 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
  }

  moveDentriesHeaders := &dingtalkstorage_1_0.MoveDentriesHeaders{}
  moveDentriesHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  option := &dingtalkstorage_1_0.MoveDentriesRequestOption{
    ConflictStrategy: tea.String("AUTO_RENAME"),
    PreservePermissions: tea.Bool(true),
  }
  moveDentriesRequest := &dingtalkstorage_1_0.MoveDentriesRequest{
    UnionId: tea.String("chyxxxxx"),
    TargetSpaceId: tea.String("890xxxxx"),
    TargetFolderId: tea.String("899xxxxx"),
    DentryIds: []*string{tea.String("456xxxxx")},
    Option: option,
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.MoveDentriesWithOptions(tea.String("576xxxxx"), moveDentriesRequest, moveDentriesHeaders, &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 code and message attributes that 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 using 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 moveDentriesHeaders = new dingtalkstorage_1_0.MoveDentriesHeaders({ });
    moveDentriesHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let option = new dingtalkstorage_1_0.MoveDentriesRequestOption({
      conflictStrategy: 'AUTO_RENAME',
      preservePermissions: true,
    });
    let moveDentriesRequest = new dingtalkstorage_1_0.MoveDentriesRequest({
      unionId: 'chyxxxxx',
      targetSpaceId: '890xxxxx',
      targetFolderId: '899xxxxx',
      dentryIds: [
        '456xxxxx'
      ],
      option: option,
    });
    try {
      await client.moveDentriesWithOptions('576xxxxx', moveDentriesRequest, moveDentriesHeaders, new Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.default.empty(err.code) && !Util.default.empty(err.message)) {
        // err contains code and message attributes that 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 using 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.MoveDentriesHeaders moveDentriesHeaders = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.MoveDentriesHeaders();
            moveDentriesHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.MoveDentriesRequest.MoveDentriesRequestOption option = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.MoveDentriesRequest.MoveDentriesRequestOption
            {
                ConflictStrategy = "AUTO_RENAME",
                PreservePermissions = true,
            };
            AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.MoveDentriesRequest moveDentriesRequest = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.MoveDentriesRequest
            {
                UnionId = "chyxxxxx",
                TargetSpaceId = "890xxxxx",
                TargetFolderId = "899xxxxx",
                DentryIds = new List<string>
                {
                    "456xxxxx"
                },
                Option = option,
            };
            try
            {
                client.MoveDentriesWithOptions("576xxxxx", moveDentriesRequest, moveDentriesHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
            }
            catch (TeaException err)
            {
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // err contains code and message attributes that 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 code and message attributes that help locate the issue
                }
            }
        }

    }
}

Response

Response body

NameTypeDescription
resultItemsArrayThe result list of the batch move of files or folders.
spaceIdStringThe ID of the space where the source files or folders reside.
dentryIdStringThe ID of the source file or folder.
asyncBooleanWhether the task is asynchronous. - true: yes. - false: no. If the operated object has child nodes, the task is processed asynchronously.
successBooleanWhether 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 ID of the asynchronous task. Use it to query the task execution status.
targetSpaceIdStringThe ID of the space the item belongs to after the move. Returned for both synchronous and asynchronous tasks, except when the operation fails.
targetDentryIdStringThe ID of the file or folder after the move. Returned for both synchronous and asynchronous tasks, except when the operation fails.

Response body example

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

{
  "resultItems" : [ {
    "spaceId" : "123xxxxx",
    "dentryId" : "367xxxxx",
    "async" : true,
    "success" : true,
    "errorCode" : "permissionDenied",
    "taskId" : "123xxxxx",
    "targetSpaceId" : "798xxxxx",
    "targetDentryId" : "534xxxxx"
  } ]
}

Error codes

If an error is returned when this API is called, refer to the Global error codes document to find a solution 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 lacks permission to move the file (or folder).
404spaceNotExist%sThe space where the source file (or folder) or target directory resides does not exist.
404dentryNotExist%sThe source file (or folder) or target directory does not exist.
500systemError%sSystem error.
500unknownErrorUnknown ErrorUnknown error.
503operationTimeout%sRequest timed out.