Skip to main content
Call this API to copy a file or folder to another space or folder.

Request

Basic information

FieldValue
HTTP URLhttps://api.dingtalk.io/v1.0/storage/spaces/{spaceId}/dentries/{dentryId}/copy
HTTP MethodPOST
Supported app typesappType-Internal app appType-Third-party enterprise app
Permissionspermission-Storage.File.Write-Organization 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 Get the access token of an internal app API. - For a third-party enterprise app, call the Get the access token of an authorized organization for a third-party app API.

Path parameters

NameTypeRequiredDescription
spaceIdStringYesThe ID of the source space where the file or folder is located. Call the Add a space API to obtain the value of the id parameter.
dentryIdStringYesThe ID of the file or folder to be copied. 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. Call the Add a space API to obtain the value of the id parameter.
targetFolderIdStringYesThe ID of the parent folder at the target location. Call the Get a list of files or folders API to obtain the value of the id parameter.
optionObjectNoOptional parameters.
conflictStrategyStringNoThe naming 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.

Request example

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

{
  "targetSpaceId" : "622xxxxx",
  "targetFolderId" : "532xxxxx",
  "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.CopyDentryHeaders copyDentryHeaders = new com.aliyun.dingtalkstorage_1_0.models.CopyDentryHeaders();
        copyDentryHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkstorage_1_0.models.CopyDentryRequest.CopyDentryRequestOption option = new com.aliyun.dingtalkstorage_1_0.models.CopyDentryRequest.CopyDentryRequestOption()
                .setConflictStrategy("AUTO_RENAME");
        com.aliyun.dingtalkstorage_1_0.models.CopyDentryRequest copyDentryRequest = new com.aliyun.dingtalkstorage_1_0.models.CopyDentryRequest()
                .setUnionId("cHtUYxxxxx")
                .setTargetSpaceId("622xxxxx")
                .setTargetFolderId("532xxxxx")
                .setOption(option);
        try {
            client.copyDentryWithOptions("space_id", "dentry_id", copyDentryRequest, copyDentryHeaders, 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 with troubleshooting
            }

        } 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 with troubleshooting
            }

        }        
    }
}
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_dentry_headers = dingtalkstorage__1__0_models.CopyDentryHeaders()
        copy_dentry_headers.x_acs_dingtalk_access_token = '<your access token>'
        option = dingtalkstorage__1__0_models.CopyDentryRequestOption(
            conflict_strategy='AUTO_RENAME'
        )
        copy_dentry_request = dingtalkstorage__1__0_models.CopyDentryRequest(
            union_id='cHtUYxxxxx',
            target_space_id='622xxxxx',
            target_folder_id='532xxxxx',
            option=option
        )
        try:
            client.copy_dentry_with_options('space_id', 'dentry_id', copy_dentry_request, copy_dentry_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 with troubleshooting
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        copy_dentry_headers = dingtalkstorage__1__0_models.CopyDentryHeaders()
        copy_dentry_headers.x_acs_dingtalk_access_token = '<your access token>'
        option = dingtalkstorage__1__0_models.CopyDentryRequestOption(
            conflict_strategy='AUTO_RENAME'
        )
        copy_dentry_request = dingtalkstorage__1__0_models.CopyDentryRequest(
            union_id='cHtUYxxxxx',
            target_space_id='622xxxxx',
            target_folder_id='532xxxxx',
            option=option
        )
        try:
            await client.copy_dentry_with_options_async('space_id', 'dentry_id', copy_dentry_request, copy_dentry_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 with troubleshooting
                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\CopyDentryHeaders;
use AlibabaCloud\SDK\Dingtalk\Vstorage_1_0\Models\CopyDentryRequest\option;
use AlibabaCloud\SDK\Dingtalk\Vstorage_1_0\Models\CopyDentryRequest;
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();
        $copyDentryHeaders = new CopyDentryHeaders([]);
        $copyDentryHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $option = new option([
            "conflictStrategy" => "AUTO_RENAME"
        ]);
        $copyDentryRequest = new CopyDentryRequest([
            "unionId" => "cHtUYxxxxx",
            "targetSpaceId" => "622xxxxx",
            "targetFolderId" => "532xxxxx",
            "option" => $option
        ]);
        try {
            $client->copyDentryWithOptions("space_id", "dentry_id", $copyDentryRequest, $copyDentryHeaders, 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 with troubleshooting
            }
        }
    }
}
$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
  }

  copyDentryHeaders := &dingtalkstorage_1_0.CopyDentryHeaders{}
  copyDentryHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  option := &dingtalkstorage_1_0.CopyDentryRequestOption{
    ConflictStrategy: tea.String("AUTO_RENAME"),
  }
  copyDentryRequest := &dingtalkstorage_1_0.CopyDentryRequest{
    UnionId: tea.String("cHtUYxxxxx"),
    TargetSpaceId: tea.String("622xxxxx"),
    TargetFolderId: tea.String("532xxxxx"),
    Option: option,
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.CopyDentryWithOptions(tea.String("space_id"), tea.String("dentry_id"), copyDentryRequest, copyDentryHeaders, &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 with troubleshooting
    }

  }
  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 copyDentryHeaders = new dingtalkstorage_1_0.CopyDentryHeaders({ });
    copyDentryHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let option = new dingtalkstorage_1_0.CopyDentryRequestOption({
      conflictStrategy: 'AUTO_RENAME',
    });
    let copyDentryRequest = new dingtalkstorage_1_0.CopyDentryRequest({
      unionId: 'cHtUYxxxxx',
      targetSpaceId: '622xxxxx',
      targetFolderId: '532xxxxx',
      option: option,
    });
    try {
      await client.copyDentryWithOptions('space_id', 'dentry_id', copyDentryRequest, copyDentryHeaders, 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 with troubleshooting
      }

    }    
  }

}

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.CopyDentryHeaders copyDentryHeaders = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.CopyDentryHeaders();
            copyDentryHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.CopyDentryRequest.CopyDentryRequestOption option = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.CopyDentryRequest.CopyDentryRequestOption
            {
                ConflictStrategy = "AUTO_RENAME",
            };
            AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.CopyDentryRequest copyDentryRequest = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.CopyDentryRequest
            {
                UnionId = "cHtUYxxxxx",
                TargetSpaceId = "622xxxxx",
                TargetFolderId = "532xxxxx",
                Option = option,
            };
            try
            {
                client.CopyDentryWithOptions("space_id", "dentry_id", copyDentryRequest, copyDentryHeaders, 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 with troubleshooting
                }
            }
            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 with troubleshooting
                }
            }
        }

    }
}

Response

Response body

NameTypeDescription
dentryObjectThe list of file or folder information.
idStringThe file or folder ID.
spaceIdStringThe ID of the space where the file or folder is located.
parentIdStringThe parent folder ID.
typeStringThe type: - FILE: File. - FOLDER: Folder.
nameStringThe file or folder name.
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. Example: 2022-07-29T14:55Z.
modifiedTimeStringThe modified time, in ISO 8601 format. Example: 2022-07-29T14:55Z.
propertiesObjectThe attributes.
readOnlyBooleanWhether the file or folder is read-only: - true: Yes. - false: No.
appPropertiesMap<String, Array>The attributes for specific apps.
ArrayThe attribute list.
nameStringThe attribute name.
valueStringThe attribute value.
visibilityStringThe attribute visibility: - PUBLIC: Publicly visible. - PRIVATE: Visible only to 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.
asyncBooleanWhether this is an asynchronous task: - 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" : "675xxxxx",
    "spaceId" : "883xxxxx",
    "parentId" : "654xxxxx",
    "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" : "AttributeName1",
      "value" : "AttributeValue1",
      "visibility" : "PRIVATE"
    } ],
    "uuid" : "uuid",
    "partitionType" : "PUBLIC_OSS_PARTITION",
    "storageDriver" : "DINGTALK"
  },
  "async" : true,
  "taskId" : "1234xxxxx"
}

Error codes

If an error occurs when calling this API, 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.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 scenario capacity
400appQuotaInsufficient%sInsufficient app capacity
400orgQuotaInsufficient%sInsufficient organization capacity
400dentryAlreadyExist%sA file with the same name already exists
403permissionDenied%sThe user lacks permission to copy the file or folder
404spaceNotExist%sThe space where the source file/folder or target folder is located does not exist
404dentryNotExist%sThe source file/folder or target folder does not exist
500systemError%sSystem error
500unknownErrorUnknown ErrorUnknown error
503operationTimeout%sRequest timeout