ファイルまたはフォルダーの一括削除

本インターフェースを呼び出して、ファイルまたはフォルダーを一括削除できます。

リクエスト

基本情報

フィールド	値
HTTP URL	`https://api.dingtalk.io/v1.0/storage/spaces/{spaceId}/dentries/batchRemove`
HTTP Method	POST
対応アプリタイプ	appType-社内アプリ　appType-サードパーティ社内アプリ
権限要件	permission-Storage.File.Write-企業ストレージファイル書き込み権限

リクエストヘッダー

名前	タイプ	必須	説明
x-acs-dingtalk-access-token	String	はい	本インターフェース呼び出し時のアクセス認証情報。以下の方法で取得します。 - 社内アプリの場合、社内アプリの access_token を取得するインターフェースを呼び出して取得します。 - サードパーティ社内アプリの場合、サードパーティアプリが権限付与された企業の access_token を取得するインターフェースを呼び出して取得します。

パスパラメータ

名前	タイプ	必須	説明
spaceId	String	はい	スペース ID。スペース追加インターフェースを呼び出して id パラメータ値を取得できます。

クエリパラメータ

名前	タイプ	必須	説明
unionId	String	はい	操作者の unionId。ユーザー詳細の照会インターフェースを呼び出して unionid パラメータ値を取得できます。

リクエストボディ

名前	タイプ	必須	説明
dentryIds	Array of String	はい	ファイルまたはフォルダー ID のリスト。最大 50 件。ファイルまたはフォルダーリストの取得または dentryUuid を使用して spaceId と dentryId を取得インターフェースを呼び出して id パラメータ値を取得できます。
option	Object	いいえ	任意パラメータ。
toRecycleBin	Boolean	いいえ	ゴミ箱に削除するかどうか。 - true：ゴミ箱に移動 - false（デフォルト）：ゴミ箱に移動せず、直接削除

リクエスト例

HTTP

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

{
  "dentryIds" : [ "658xxxxx" ],
  "option" : {
    "toRecycleBin" : true
  }
}

Java

package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * <b>description</b> :
     * <p>トークンを使用してアカウント Client を初期化</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.DeleteDentriesHeaders deleteDentriesHeaders = new com.aliyun.dingtalkstorage_1_0.models.DeleteDentriesHeaders();
        deleteDentriesHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkstorage_1_0.models.DeleteDentriesRequest.DeleteDentriesRequestOption option = new com.aliyun.dingtalkstorage_1_0.models.DeleteDentriesRequest.DeleteDentriesRequestOption()
                .setToRecycleBin(true);
        com.aliyun.dingtalkstorage_1_0.models.DeleteDentriesRequest deleteDentriesRequest = new com.aliyun.dingtalkstorage_1_0.models.DeleteDentriesRequest()
                .setUnionId("CHYxxxxx")
                .setDentryIds(java.util.Arrays.asList(
                    "658xxxxx"
                ))
                .setOption(option);
        try {
            client.deleteDentriesWithOptions("457xxxxx", deleteDentriesRequest, deleteDentriesHeaders, 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 属性が含まれており、問題の特定に役立ちます
            }

        }        
    }
}

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:
        """
        トークンを使用してアカウント 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()
        delete_dentries_headers = dingtalkstorage__1__0_models.DeleteDentriesHeaders()
        delete_dentries_headers.x_acs_dingtalk_access_token = '<your access token>'
        option = dingtalkstorage__1__0_models.DeleteDentriesRequestOption(
            to_recycle_bin=True
        )
        delete_dentries_request = dingtalkstorage__1__0_models.DeleteDentriesRequest(
            union_id='CHYxxxxx',
            dentry_ids=[
                '658xxxxx'
            ],
            option=option
        )
        try:
            client.delete_dentries_with_options('457xxxxx', delete_dentries_request, delete_dentries_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()
        delete_dentries_headers = dingtalkstorage__1__0_models.DeleteDentriesHeaders()
        delete_dentries_headers.x_acs_dingtalk_access_token = '<your access token>'
        option = dingtalkstorage__1__0_models.DeleteDentriesRequestOption(
            to_recycle_bin=True
        )
        delete_dentries_request = dingtalkstorage__1__0_models.DeleteDentriesRequest(
            union_id='CHYxxxxx',
            dentry_ids=[
                '658xxxxx'
            ],
            option=option
        )
        try:
            await client.delete_dentries_with_options_async('457xxxxx', delete_dentries_request, delete_dentries_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

<?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\DeleteDentriesHeaders;
use AlibabaCloud\SDK\Dingtalk\Vstorage_1_0\Models\DeleteDentriesRequest\option;
use AlibabaCloud\SDK\Dingtalk\Vstorage_1_0\Models\DeleteDentriesRequest;
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();
        $deleteDentriesHeaders = new DeleteDentriesHeaders([]);
        $deleteDentriesHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $option = new option([
            "toRecycleBin" => true
        ]);
        $deleteDentriesRequest = new DeleteDentriesRequest([
            "unionId" => "CHYxxxxx",
            "dentryIds" => [
                "658xxxxx"
            ],
            "option" => $option
        ]);
        try {
            $client->deleteDentriesWithOptions("457xxxxx", $deleteDentriesRequest, $deleteDentriesHeaders, 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));

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:
// 
// トークンを使用してアカウント 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
  }

  deleteDentriesHeaders := &dingtalkstorage_1_0.DeleteDentriesHeaders{}
  deleteDentriesHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  option := &dingtalkstorage_1_0.DeleteDentriesRequestOption{
    ToRecycleBin: tea.Bool(true),
  }
  deleteDentriesRequest := &dingtalkstorage_1_0.DeleteDentriesRequest{
    UnionId: tea.String("CHYxxxxx"),
    DentryIds: []*string{tea.String("658xxxxx")},
    Option: option,
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.DeleteDentriesWithOptions(tea.String("457xxxxx"), deleteDentriesRequest, deleteDentriesHeaders, &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)
  }
}

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 {

  /**
   * トークンを使用してアカウント Client を初期化
   * @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 deleteDentriesHeaders = new dingtalkstorage_1_0.DeleteDentriesHeaders({ });
    deleteDentriesHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let option = new dingtalkstorage_1_0.DeleteDentriesRequestOption({
      toRecycleBin: true,
    });
    let deleteDentriesRequest = new dingtalkstorage_1_0.DeleteDentriesRequest({
      unionId: 'CHYxxxxx',
      dentryIds: [
        '658xxxxx'
      ],
      option: option,
    });
    try {
      await client.deleteDentriesWithOptions('457xxxxx', deleteDentriesRequest, deleteDentriesHeaders, new Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.default.empty(err.code) && !Util.default.empty(err.message)) {
        // err には code と message 属性が含まれており、問題の特定に役立ちます
      }

    }    
  }

}

exports.Client = Client;
Client.main(process.argv.slice(2));

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>トークンを使用してアカウント Client を初期化</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.DeleteDentriesHeaders deleteDentriesHeaders = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.DeleteDentriesHeaders();
            deleteDentriesHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.DeleteDentriesRequest.DeleteDentriesRequestOption option = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.DeleteDentriesRequest.DeleteDentriesRequestOption
            {
                ToRecycleBin = true,
            };
            AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.DeleteDentriesRequest deleteDentriesRequest = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.DeleteDentriesRequest
            {
                UnionId = "CHYxxxxx",
                DentryIds = new List<string>
                {
                    "658xxxxx"
                },
                Option = option,
            };
            try
            {
                client.DeleteDentriesWithOptions("457xxxxx", deleteDentriesRequest, deleteDentriesHeaders, 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	ファイル一括削除結果リスト。
spaceId	String	元ファイルまたはフォルダーのスペース ID。
dentryId	String	元ファイルまたはフォルダーの ID。
async	Boolean	非同期タスクかどうか。 - true：はい - false：いいえ操作対象に子ノードがある場合は、非同期で処理されます。
success	Boolean	成功したかどうか。 - true：成功 - false：失敗非同期タスクの場合、このフィールドは空となります。
errorCode	String	エラー原因。非同期タスクの場合、このフィールドは空となります。
taskId	String	非同期タスク ID。タスクの実行状態の照会に使用できます。

レスポンスボディ例

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

{
  "resultItems" : [ {
    "spaceId" : "654xxxxx",
    "dentryId" : "655xxxxx",
    "async" : true,
    "success" : true,
    "errorCode" : "permissionDenied",
    "taskId" : "123xxxx"
  } ]
}

エラーコード

本インターフェース呼び出し時にエラーが発生した場合は、エラーメッセージをもとにグローバルエラーコードドキュメントから解決策を検索してください。

HttpCode	エラーコード	エラーメッセージ	説明
400	paramError	%s	パラメータエラー
400	operationConcurrentControl	%s	同時実行制御
400	paramError.spaceId	%s	パラメータエラー-spaceId
400	paramError.dentryIds	%s	パラメータエラー-dentryIds
400	recycleBinNotSupportForSpace	%s	スペースがゴミ箱に対応していません
403	permissionDenied	%s	ユーザーにファイル(フォルダー)削除権限がありません
403	operationNotSupported	%s	ゴミ箱への削除に対応していません
404	spaceNotExist	%s	スペースが存在しません
404	dentryNotExist	%s	ファイルが存在しません
500	systemError	%s	システムエラー
500	unknownError	Unknown Error	不明なエラー
503	operationTimeout	%s	リクエストタイムアウト

API 呼び出しガイド

認証と認可

連絡先

カレンダー

会議

AI Table

Docs とファイル

IM

ファイルまたはフォルダーの一括削除

リクエスト

基本情報

リクエストヘッダー

パスパラメータ

クエリパラメータ

リクエストボディ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディ例

エラーコード

​リクエスト

​基本情報

​リクエストヘッダー

​パスパラメータ

​クエリパラメータ

​リクエストボディ

​リクエスト例

​レスポンス

​レスポンスボディ

​レスポンスボディ例

​エラーコード

リクエスト

基本情報

リクエストヘッダー

パスパラメータ

クエリパラメータ

リクエストボディ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディ例

エラーコード