Skip to main content
Call this API to move a file or folder to any other location.

Request

Basic information

FieldValue
HTTP URLhttps://api.dingtalk.io/v1.0/storage/spaces/{spaceId}/dentries/{dentryId}/move
HTTP MethodPOST
Supported app typesappType-Internal app appType-Third-party enterprise app
Required permissionspermission-Storage.File.Write-Enterprise 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 an organization authorized to use a third-party app API.

Path parameters

NameTypeRequiredDescription
spaceIdStringYesThe ID of the source space where the file or folder resides. Call the Add a space API to obtain the value of the id parameter.
dentryIdStringYesThe ID of the file or folder to move. Call the Get a list of files or folders API or the Get spaceId and dentryId by dentryUuid 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 target space where the file or folder will be stored. Call the Add a space API to obtain the value of the id parameter.
targetFolderIdStringYesThe ID of the parent folder where the file or folder will be stored. Call the Get a list of files or folders API to obtain the value of the id parameter. For the root directory, set this parameter to 0.
optionObjectNoOptional parameters.
conflictStrategyStringNoThe name conflict strategy for files and folders. - 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.
presevePermissionsBooleanNoSpecifies whether to retain permissions after the move. - true: Yes. - false: No. This is the default value.

Request example

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

{
  "targetSpaceId" : "633xxxxx",
  "targetFolderId" : "632xxxxx",
  "option" : {
    "conflictStrategy" : "AUTO_RENAME",
    "presevePermissions" : true
  }
}
Java
package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * <b>description</b> :
     * <p>Initialize the account Client using the 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.MoveDentryHeaders moveDentryHeaders = new com.aliyun.dingtalkstorage_1_0.models.MoveDentryHeaders();
        moveDentryHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkstorage_1_0.models.MoveDentryRequest.MoveDentryRequestOption option = new com.aliyun.dingtalkstorage_1_0.models.MoveDentryRequest.MoveDentryRequestOption()
                .setConflictStrategy("AUTO_RENAME")
                .setPresevePermissions(true);
        com.aliyun.dingtalkstorage_1_0.models.MoveDentryRequest moveDentryRequest = new com.aliyun.dingtalkstorage_1_0.models.MoveDentryRequest()
                .setUnionId("chxyxxxxx")
                .setTargetSpaceId("633xxxxx")
                .setTargetFolderId("632xxxxx")
                .setOption(option);
        try {
            client.moveDentryWithOptions("854xxxxx", "654xxxxx", moveDentryRequest, moveDentryHeaders, 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 issues
            }

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

        }        
    }
}
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 the 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_dentry_headers = dingtalkstorage__1__0_models.MoveDentryHeaders()
        move_dentry_headers.x_acs_dingtalk_access_token = '<your access token>'
        option = dingtalkstorage__1__0_models.MoveDentryRequestOption(
            conflict_strategy='AUTO_RENAME',
            preseve_permissions=True
        )
        move_dentry_request = dingtalkstorage__1__0_models.MoveDentryRequest(
            union_id='chxyxxxxx',
            target_space_id='633xxxxx',
            target_folder_id='632xxxxx',
            option=option
        )
        try:
            client.move_dentry_with_options('854xxxxx', '654xxxxx', move_dentry_request, move_dentry_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 issues
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        move_dentry_headers = dingtalkstorage__1__0_models.MoveDentryHeaders()
        move_dentry_headers.x_acs_dingtalk_access_token = '<your access token>'
        option = dingtalkstorage__1__0_models.MoveDentryRequestOption(
            conflict_strategy='AUTO_RENAME',
            preseve_permissions=True
        )
        move_dentry_request = dingtalkstorage__1__0_models.MoveDentryRequest(
            union_id='chxyxxxxx',
            target_space_id='633xxxxx',
            target_folder_id='632xxxxx',
            option=option
        )
        try:
            await client.move_dentry_with_options_async('854xxxxx', '654xxxxx', move_dentry_request, move_dentry_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 issues
                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\MoveDentryHeaders;
use AlibabaCloud\SDK\Dingtalk\Vstorage_1_0\Models\MoveDentryRequest\option;
use AlibabaCloud\SDK\Dingtalk\Vstorage_1_0\Models\MoveDentryRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * Initialize the account Client using the 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();
        $moveDentryHeaders = new MoveDentryHeaders([]);
        $moveDentryHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $option = new option([
            "conflictStrategy" => "AUTO_RENAME",
            "presevePermissions" => true
        ]);
        $moveDentryRequest = new MoveDentryRequest([
            "unionId" => "chxyxxxxx",
            "targetSpaceId" => "633xxxxx",
            "targetFolderId" => "632xxxxx",
            "option" => $option
        ]);
        try {
            $client->moveDentryWithOptions("854xxxxx", "654xxxxx", $moveDentryRequest, $moveDentryHeaders, 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 issues
            }
        }
    }
}
$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 the 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
  }

  moveDentryHeaders := &dingtalkstorage_1_0.MoveDentryHeaders{}
  moveDentryHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  option := &dingtalkstorage_1_0.MoveDentryRequestOption{
    ConflictStrategy: tea.String("AUTO_RENAME"),
    PresevePermissions: tea.Bool(true),
  }
  moveDentryRequest := &dingtalkstorage_1_0.MoveDentryRequest{
    UnionId: tea.String("chxyxxxxx"),
    TargetSpaceId: tea.String("633xxxxx"),
    TargetFolderId: tea.String("632xxxxx"),
    Option: option,
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.MoveDentryWithOptions(tea.String("854xxxxx"), tea.String("654xxxxx"), moveDentryRequest, moveDentryHeaders, &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 issues
    }

  }
  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 the 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 moveDentryHeaders = new dingtalkstorage_1_0.MoveDentryHeaders({ });
    moveDentryHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let option = new dingtalkstorage_1_0.MoveDentryRequestOption({
      conflictStrategy: 'AUTO_RENAME',
      presevePermissions: true,
    });
    let moveDentryRequest = new dingtalkstorage_1_0.MoveDentryRequest({
      unionId: 'chxyxxxxx',
      targetSpaceId: '633xxxxx',
      targetFolderId: '632xxxxx',
      option: option,
    });
    try {
      await client.moveDentryWithOptions('854xxxxx', '654xxxxx', moveDentryRequest, moveDentryHeaders, 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 issues
      }

    }    
  }

}

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 the 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.MoveDentryHeaders moveDentryHeaders = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.MoveDentryHeaders();
            moveDentryHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.MoveDentryRequest.MoveDentryRequestOption option = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.MoveDentryRequest.MoveDentryRequestOption
            {
                ConflictStrategy = "AUTO_RENAME",
                PresevePermissions = true,
            };
            AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.MoveDentryRequest moveDentryRequest = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.MoveDentryRequest
            {
                UnionId = "chxyxxxxx",
                TargetSpaceId = "633xxxxx",
                TargetFolderId = "632xxxxx",
                Option = option,
            };
            try
            {
                client.MoveDentryWithOptions("854xxxxx", "654xxxxx", moveDentryRequest, moveDentryHeaders, 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 issues
                }
            }
            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 issues
                }
            }
        }

    }
}

Response

Response body

NameTypeDescription
dentryObjectThe list of file or folder information.
idStringThe ID of the file or folder.
spaceIdStringThe ID of the space where the file or folder resides.
parentIdStringThe ID of the parent folder. For the root directory, this parameter is 0.
typeStringThe type. - FILE: File. - FOLDER: Folder.
nameStringThe name of the file or folder.
sizeLongThe file size, in bytes. This field is not returned for folders.
pathStringThe path.
versionLongThe version.
statusStringThe status. - NORMAL: Normal. - DELETED: Deleted. - EXPIRED: Expired.
extensionStringThe file extension. This field is not returned for folders.
creatorIdStringThe unionId of the creator.
modifierIdStringThe unionId of the modifier.
createTimeStringThe created time in ISO 8601 format. For example: 2022-07-29T14:55Z.
modifiedTimeStringThe modified time in ISO 8601 format. For example: 2022-07-29T14:55Z.
propertiesObjectThe attributes.
readOnlyBooleanSpecifies whether the file or folder is read-only. - true: Yes. - false: No.
appPropertiesMap<String, Array>The attributes on a specific app.
ArrayThe list of attributes.
nameStringThe attribute name.
valueStringThe attribute value.
visibilityStringThe attribute visibility. - PUBLIC: Publicly visible. - PRIVATE: Visible only in the current space.
uuidStringThe identifier field.
partitionTypeStringThe storage partition. - PUBLIC_OSS_PARTITION: Public cloud OSS storage partition. - MINI_OSS_PARTITION: Dedicated MiniOSS storage partition.
storageDriverStringThe driver type. - DINGTALK: DingTalk unified storage driver. - ALIDOC: DingTalk Docs storage driver. - UNKNOWN: Unknown driver.
asyncBooleanSpecifies whether the task is asynchronous. - true: Yes. - false: No.
taskIdStringThe task ID, used to query the task execution status.

Response body example

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

{
  "dentry" : {
    "id" : "769xxxxx",
    "spaceId" : "897xxxxx",
    "parentId" : "0",
    "type" : "FILE",
    "name" : "Test",
    "size" : 512,
    "path" : "/Test folder",
    "version" : 1,
    "status" : "NORMAL",
    "extension" : "txt",
    "creatorId" : "cHtUYxxxxx",
    "modifierId" : "cHtUYxxxxx",
    "createTime" : "2022-01-01T10:00:00Z",
    "modifiedTime" : "2022-01-01T10:00:00Z",
    "properties" : {
      "readOnly" : true
    },
    "appProperties" : [ {
      "name" : "PropertyName1",
      "value" : "PropertyValue1",
      "visibility" : "PRIVATE"
    } ],
    "uuid" : "123xxxxx",
    "partitionType" : "PUBLIC_OSS_PARTITION",
    "storageDriver" : "DINGTALK"
  },
  "async" : true,
  "taskId" : "123xxx"
}

Error codes

If the API call returns an error, look up the solution in the Global error codes document based on the error message.
HttpCodeError codeError messageDescription
400operationConcurrentControl%sConcurrency control.
400paramError%sParameter error.
400paramError.spaceId%sParameter error - spaceId.
400paramError.dentryId%sParameter error - dentryId.
400paramError.targetSpaceId%sParameter error - targetSpaceId.
400paramError.targetFolderId%sParameter error - targetFolderId.
400paramError.conflictStrategy%sParameter error - conflictStrategy.
400spaceQuotaInsufficient%sInsufficient space capacity.
400sceneQuotaInsufficient%sInsufficient scene capacity.
400appQuotaInsufficient%sInsufficient app capacity.
400orgQuotaInsufficient%sInsufficient organization capacity.
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/folder or target directory resides does not exist.
404dentryNotExist%sThe source file/folder or target directory does not exist.
500systemError%sSystem error.
500unknownErrorUnknown ErrorUnknown error.
503operationTimeout%sRequest timed out.