リクエスト
基本情報
| フィールド | 値 |
|---|---|
| HTTP URL | https://api.dingtalk.io/v1.0/storage/recycleBins/{recycleBinId}/recycleItems/batchRestore |
| HTTP Method | POST |
| サポートするアプリタイプ | appType-社内アプリ appType-サードパーティ社内アプリ |
| 権限要件 | permission-Storage.RecycleBin.Write-ドライブアプリゴミ箱ファイル書き込み権限 |
リクエストヘッダー
| 名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
| x-acs-dingtalk-access-token | String | 必須 | 本インターフェースを呼び出すためのアクセス認証情報。以下の方法で取得します。 - 社内アプリは、社内アプリの access_token を取得インターフェースを呼び出して取得します。 - サードパーティ社内アプリは、サードパーティアプリで権限付与された企業の access_token を取得インターフェースを呼び出して取得します。 |
パスパラメータ
| 名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
| recycleBinId | String | 必須 | ゴミ箱 ID。ゴミ箱情報を取得インターフェースを呼び出して取得できます。 |
クエリパラメータ
| 名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
| unionId | String | 必須 | 操作者の unionId。ユーザー詳細を照会インターフェースを呼び出して取得できます。 |
リクエストボディ
| 名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
| recycleItemIds | Array of String | 必須 | ゴミ箱項目 ID リスト。ゴミ箱項目リストを取得インターフェースを呼び出して取得します。最大値は 30 です。 |
| option | Object | 任意 | オプションパラメータ。 |
| conflictStrategy | String | 任意 | ファイル名の競合戦略。復元時に元のパスに同名のファイルが既に存在する可能性があります。 - AUTO_RENAME:自動的に名前を変更(デフォルト) - OVERWRITE:上書き - RETURN_DENTRY_IF_EXISTS:既存ファイルを返す - RETURN_ERROR_IF_EXISTS:ファイルが既に存在する場合はエラーを返す |
リクエスト例
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 {
/**
* トークンを使用してアカウント Client を初期化
* @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 には code と message 属性が含まれており、開発者の問題特定に役立ちます
}
} 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 には code と message 属性が含まれており、開発者の問題特定に役立ちます
}
}
}
}
# -*- 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:
"""
トークンを使用してアカウント Client を初期化
@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 には code と message 属性が含まれており、開発者の問題特定に役立ちます
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 には code と message 属性が含まれており、開発者の問題特定に役立ちます
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 {
/**
* トークンを使用してアカウント Client を初期化
* @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 には code と message 属性が含まれており、開発者の問題特定に役立ちます
}
}
}
}
$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"
)
/**
* トークンを使用してアカウント Client を初期化
* @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 には code と message 属性が含まれており、開発者の問題特定に役立ちます
}
}
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 {
/**
* トークンを使用してアカウント Client を初期化
* @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 には code と message 属性が含まれており、開発者の問題特定に役立ちます
}
}
}
}
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
{
/**
* トークンを使用してアカウント Client を初期化
* @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 には code と message 属性が含まれており、開発者の問題特定に役立ちます
}
}
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 には code と message 属性が含まれており、開発者の問題特定に役立ちます
}
}
}
}
}
レスポンス
レスポンスボディ
| 名前 | タイプ | 説明 |
|---|---|---|
| resultItems | Array | ファイルまたはフォルダーの一括復元結果リスト。 |
| recycleBinId | String | ゴミ箱 ID。 |
| recycleItemId | String | ゴミ箱項目 ID。 |
| async | Boolean | 非同期タスクであるかどうか。 - true:はい - false:いいえ 操作対象に子ノードがある場合は、非同期で処理されます。 |
| success | Boolean | 成功したかどうか。 - true:成功 - false:失敗 非同期タスクの場合、本フィールドは返されません。 |
| errorCode | String | エラー原因。 非同期タスクの場合、本フィールドは返されません。 |
| taskId | String | 非同期タスク ID。タスクの実行状態の照会に使用できます。 - 社内アプリは、ストレージ内の非同期タスク情報を取得インターフェースを呼び出してタスクの実行状態を照会できます。 - サードパーティ社内アプリは、ストレージ内の非同期タスク情報を取得インターフェースを呼び出してタスクの実行状態を照会できます。 |
| spaceId | String | 復元後のファイルまたはフォルダーが所属するスペース ID。 失敗以外の場合は、同期・非同期を問わず返されます。 |
| dentryId | String | 復元後のファイルまたはフォルダーの ID。 失敗以外の場合は、同期・非同期を問わず返されます。 |
レスポンスボディの例
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"
} ]
}
エラーコード
本インターフェースの呼び出しでエラーが発生した場合、エラーメッセージをもとに グローバルエラーコード ドキュメントで解決策を検索できます。| HttpCode | エラーコード | エラーメッセージ | 説明 |
|---|---|---|---|
| 400 | paramError | %s | パラメータエラー |
| 400 | paramError.recycleBinId | %s | パラメータエラー-recycleBinId |
| 400 | paramError.recycleItemIds | %s | パラメータエラー-recycleItemIds |
| 400 | paramError.conflictStrategy | %s | パラメータエラー-conflictStrategy |
| 403 | permissionDenied | %s | ユーザーがゴミ箱項目の元ファイル(フォルダー)に対する管理権限を持っていません |
| 404 | recycleBinNotExist | %s | ゴミ箱が存在しません |
| 404 | recycleItemNotExist | %s | ゴミ箱項目が存在しません |
| 500 | systemError | %s | システムエラー |
| 500 | unknownError | Unknown Error | 不明なエラー |
| 503 | operationTimeout | %s | リクエストタイムアウト |