Request
Basic information
| Field | Value |
|---|---|
| HTTP URL | https://api.dingtalk.io/v1.0/storage/recycleBins/{recycleBinId}/recycleItems/batchRestore |
| HTTP Method | POST |
| Supported app types | appType-Internal app appType-Third-party enterprise app |
| Required permissions | permission-Storage.RecycleBin.Write-Write permission on files in the Drive app Recycle Bin |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
| x-acs-dingtalk-access-token | String | Yes | The access credential used to call 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 that has authorized the third-party app API. |
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
| recycleBinId | String | Yes | The Recycle Bin ID. Call the Obtain Recycle Bin information API to get it. |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
| unionId | String | Yes | The unionId of the operator. Call the Query user details API to get it. |
Request body
| Name | Type | Required | Description |
|---|---|---|---|
| recycleItemIds | Array of String | Yes | The list of recycle item IDs. Call the Get the list of recycle items API to get them. The maximum number is 30. |
| option | Object | No | Optional parameters. |
| conflictStrategy | String | No | The file name conflict strategy. A file with the same name may already exist in the original path when restoring. - 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. |
Request example
HTTPPOST /v1.0/storage/recycleBins/recyclebin_id/recycleItems/batchRestore?unionId=chyxxxxx HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:xxxxx
Content-Type:application/json
{
"recycleItemIds" : [ "123xxxxx" ],
"option" : {
"conflictStrategy" : "AUTO_RENAME"
}
}
// This file is auto-generated, don't edit it. Thanks.
package com.aliyun.sample;
import com.aliyun.tea.*;
public class Sample {
/**
* Initialize the account Client using a Token
* @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 {
java.util.List<String> args = java.util.Arrays.asList(args_);
com.aliyun.dingtalkstorage_1_0.Client client = Sample.createClient();
com.aliyun.dingtalkstorage_1_0.models.RestoreRecycleItemsHeaders restoreRecycleItemsHeaders = new com.aliyun.dingtalkstorage_1_0.models.RestoreRecycleItemsHeaders();
restoreRecycleItemsHeaders.xAcsDingtalkAccessToken = "<your access token>";
com.aliyun.dingtalkstorage_1_0.models.RestoreRecycleItemsRequest.RestoreRecycleItemsRequestOption option = new com.aliyun.dingtalkstorage_1_0.models.RestoreRecycleItemsRequest.RestoreRecycleItemsRequestOption()
.setConflictStrategy("AUTO_RENAME");
com.aliyun.dingtalkstorage_1_0.models.RestoreRecycleItemsRequest restoreRecycleItemsRequest = new com.aliyun.dingtalkstorage_1_0.models.RestoreRecycleItemsRequest()
.setUnionId("chyxxxxx")
.setRecycleItemIds(java.util.Arrays.asList(
"123xxxxx"
))
.setOption(option);
try {
client.restoreRecycleItemsWithOptions("recyclebin_id", restoreRecycleItemsRequest, restoreRecycleItemsHeaders, 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 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 the code and message attributes that help locate the issue
}
}
}
}
# -*- coding: utf-8 -*-
# This file is auto-generated, don't edit it. Thanks.
import sys
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 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()
restore_recycle_items_headers = dingtalkstorage__1__0_models.RestoreRecycleItemsHeaders()
restore_recycle_items_headers.x_acs_dingtalk_access_token = '<your access token>'
option = dingtalkstorage__1__0_models.RestoreRecycleItemsRequestOption(
conflict_strategy='AUTO_RENAME'
)
restore_recycle_items_request = dingtalkstorage__1__0_models.RestoreRecycleItemsRequest(
union_id='chyxxxxx',
recycle_item_ids=[
'123xxxxx'
],
option=option
)
try:
client.restore_recycle_items_with_options('recyclebin_id', restore_recycle_items_request, restore_recycle_items_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 that help locate the issue
pass
@staticmethod
async def main_async(
args: List[str],
) -> None:
client = Sample.create_client()
restore_recycle_items_headers = dingtalkstorage__1__0_models.RestoreRecycleItemsHeaders()
restore_recycle_items_headers.x_acs_dingtalk_access_token = '<your access token>'
option = dingtalkstorage__1__0_models.RestoreRecycleItemsRequestOption(
conflict_strategy='AUTO_RENAME'
)
restore_recycle_items_request = dingtalkstorage__1__0_models.RestoreRecycleItemsRequest(
union_id='chyxxxxx',
recycle_item_ids=[
'123xxxxx'
],
option=option
)
try:
await client.restore_recycle_items_with_options_async('recyclebin_id', restore_recycle_items_request, restore_recycle_items_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 that help locate the issue
pass
if __name__ == '__main__':
Sample.main(sys.argv[1:])
<?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\RestoreRecycleItemsHeaders;
use AlibabaCloud\SDK\Dingtalk\Vstorage_1_0\Models\RestoreRecycleItemsRequest\option;
use AlibabaCloud\SDK\Dingtalk\Vstorage_1_0\Models\RestoreRecycleItemsRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;
class Sample {
/**
* Initialize the account Client using 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();
$restoreRecycleItemsHeaders = new RestoreRecycleItemsHeaders([]);
$restoreRecycleItemsHeaders->xAcsDingtalkAccessToken = "<your access token>";
$option = new option([
"conflictStrategy" => "AUTO_RENAME"
]);
$restoreRecycleItemsRequest = new RestoreRecycleItemsRequest([
"unionId" => "chyxxxxx",
"recycleItemIds" => [
"123xxxxx"
],
"option" => $option
]);
try {
$client->restoreRecycleItemsWithOptions("recyclebin_id", $restoreRecycleItemsRequest, $restoreRecycleItemsHeaders, 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 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));
// This file is auto-generated, don't edit it. Thanks.
package main
import (
"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"
)
/**
* Initialize the account Client using 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
}
restoreRecycleItemsHeaders := &dingtalkstorage_1_0.RestoreRecycleItemsHeaders{}
restoreRecycleItemsHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
option := &dingtalkstorage_1_0.RestoreRecycleItemsRequestOption{
ConflictStrategy: tea.String("AUTO_RENAME"),
}
restoreRecycleItemsRequest := &dingtalkstorage_1_0.RestoreRecycleItemsRequest{
UnionId: tea.String("chyxxxxx"),
RecycleItemIds: []*string{tea.String("123xxxxx")},
Option: option,
}
tryErr := func()(_e error) {
defer func() {
if r := tea.Recover(recover()); r != nil {
_e = r
}
}()
_, _err = client.RestoreRecycleItemsWithOptions(tea.String("recyclebin_id"), restoreRecycleItemsRequest, restoreRecycleItemsHeaders, &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 that help locate the issue
}
}
return _err
}
func main() {
err := _main(tea.StringSlice(os.Args[1:]))
if err != nil {
panic(err)
}
}
// This file is auto-generated, don't edit it
import Util, * as $Util from '@alicloud/tea-util';
import dingtalkstorage_1_0, * as $dingtalkstorage_1_0 from '@alicloud/dingtalk/storage_1_0';
import OpenApi, * as $OpenApi from '@alicloud/openapi-client';
import * as $tea from '@alicloud/tea-typescript';
export default class Client {
/**
* Initialize the account Client using a Token
* @return Client
* @throws Exception
*/
static createClient(): dingtalkstorage_1_0 {
let config = new $OpenApi.Config({ });
config.protocol = "https";
config.regionId = "central";
return new dingtalkstorage_1_0(config);
}
static async main(args: string[]): Promise<void> {
let client = Client.createClient();
let restoreRecycleItemsHeaders = new $dingtalkstorage_1_0.RestoreRecycleItemsHeaders({ });
restoreRecycleItemsHeaders.xAcsDingtalkAccessToken = "<your access token>";
let option = new $dingtalkstorage_1_0.RestoreRecycleItemsRequestOption({
conflictStrategy: "AUTO_RENAME",
});
let restoreRecycleItemsRequest = new $dingtalkstorage_1_0.RestoreRecycleItemsRequest({
unionId: "chyxxxxx",
recycleItemIds: [
"123xxxxx"
],
option: option,
});
try {
await client.restoreRecycleItemsWithOptions("recyclebin_id", restoreRecycleItemsRequest, restoreRecycleItemsHeaders, new $Util.RuntimeOptions({ }));
} catch (err) {
if (!Util.empty(err.code) && !Util.empty(err.message)) {
// err contains the code and message attributes that help locate the issue
}
}
}
}
Client.main(process.argv.slice(2));
// This file is auto-generated, don't edit it. Thanks.
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
{
/**
* Initialize the account Client using a Token
* @return Client
* @throws 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.RestoreRecycleItemsHeaders restoreRecycleItemsHeaders = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.RestoreRecycleItemsHeaders();
restoreRecycleItemsHeaders.XAcsDingtalkAccessToken = "<your access token>";
AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.RestoreRecycleItemsRequest.RestoreRecycleItemsRequestOption option = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.RestoreRecycleItemsRequest.RestoreRecycleItemsRequestOption
{
ConflictStrategy = "AUTO_RENAME",
};
AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.RestoreRecycleItemsRequest restoreRecycleItemsRequest = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.RestoreRecycleItemsRequest
{
UnionId = "chyxxxxx",
RecycleItemIds = new List<string>
{
"123xxxxx"
},
Option = option,
};
try
{
client.RestoreRecycleItemsWithOptions("recyclebin_id", restoreRecycleItemsRequest, restoreRecycleItemsHeaders, 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 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 the code and message attributes that help locate the issue
}
}
}
}
}
Response
Response body
| Name | Type | Description |
|---|---|---|
| resultItems | Array | The result list of the batch restore of files or folders. |
| recycleBinId | String | The Recycle Bin ID. |
| recycleItemId | String | The recycle item ID. |
| async | Boolean | Indicates whether the task is asynchronous. - true: Yes. - false: No. If the target object has child nodes, the task is processed asynchronously. |
| success | Boolean | Indicates whether the operation succeeded. - true: Success. - false: Failed. This field is not returned for asynchronous tasks. |
| errorCode | String | The error reason. This field is not returned for asynchronous tasks. |
| taskId | String | The asynchronous task ID, which can be used to query the task execution status. - For an internal app, call the Get asynchronous task information in storage API to query the task execution status. - For a third-party enterprise app, call the Get asynchronous task information in storage API to query the task execution status. |
| spaceId | String | The ID of the space where the restored file or folder is located. Returned for both synchronous and asynchronous tasks when the operation does not fail. |
| dentryId | String | The ID of the restored file or folder. Returned for both synchronous and asynchronous tasks when the operation does not fail. |
Response body example
HTTP/1.1 200 OK
Content-Type:application/json
{
"resultItems" : [ {
"recycleBinId" : "778xxxxx",
"recycleItemId" : "768xxxxx",
"async" : true,
"success" : true,
"errorCode" : "permissionDenied",
"taskId" : "123xxxxx",
"spaceId" : "789xxxxx",
"dentryId" : "776xxxxx"
} ]
}
Error codes
If an error occurs when calling this API, refer to the Global error codes documentation based on the error message for a solution.| HttpCode | Error code | Error message | Description |
|---|---|---|---|
| 400 | paramError | %s | Parameter error. |
| 400 | paramError.recycleBinId | %s | Parameter error - recycleBinId. |
| 400 | paramError.recycleItemIds | %s | Parameter error - recycleItemIds. |
| 400 | paramError.conflictStrategy | %s | Parameter error - conflictStrategy. |
| 403 | permissionDenied | %s | The user lacks management permission on the original file (folder) of the recycle item. |
| 404 | recycleBinNotExist | %s | The Recycle Bin does not exist. |
| 404 | recycleItemNotExist | %s | The recycle item does not exist. |
| 500 | systemError | %s | System error. |
| 500 | unknownError | Unknown Error | Unknown error. |
| 503 | operationTimeout | %s | Request timed out. |