ファイルまたはフォルダーの名前を変更

本インターフェースを呼び出すことで、ファイルまたはフォルダーの名前を変更できます。ただし、ストレージスペース内のルートディレクトリは名前変更に対応していません。

リクエスト

基本情報

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

リクエストヘッダー

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

パスパラメータ

名前	タイプ	必須	説明
spaceId	String	はい	スペースID。スペースの追加インターフェースを呼び出してidパラメータの値を取得できます。
dentryId	String	はい	ファイルまたはフォルダーのID。ファイルまたはフォルダーリストの取得またはdentryUuidに基づいてspaceIdとdentryIdを取得インターフェースを呼び出してidパラメータの値を取得できます。ストレージスペースのルートディレクトリは名前変更に対応していないため、本パラメータに0を渡すことはできません。

クエリパラメータ

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

リクエストボディ

名前	タイプ	必須	説明
newName	String	はい	ファイルまたはフォルダーの新しい名称。命名規則は以下のとおりです：- 先頭と末尾にスペースを含めることはできません。含まれる場合は自動的に削除されます - 特殊文字（タブ、`*`、`"`、`<`、`>`、`	`）を含めることはできません -` .` で終わることはできません

リクエスト例

HTTP

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

{
  "newName" : "テスト"
}

Java

package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * <b>description</b> :
     * <p>Token を使用してアカウント 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.RenameDentryHeaders renameDentryHeaders = new com.aliyun.dingtalkstorage_1_0.models.RenameDentryHeaders();
        renameDentryHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkstorage_1_0.models.RenameDentryRequest renameDentryRequest = new com.aliyun.dingtalkstorage_1_0.models.RenameDentryRequest()
                .setUnionId("cHtUYxxxxx")
                .setNewName("テスト");
        try {
            client.renameDentryWithOptions("854xxxxx", "645xxxxx", renameDentryRequest, renameDentryHeaders, 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:
        """
        Token を使用してアカウント 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()
        rename_dentry_headers = dingtalkstorage__1__0_models.RenameDentryHeaders()
        rename_dentry_headers.x_acs_dingtalk_access_token = '<your access token>'
        rename_dentry_request = dingtalkstorage__1__0_models.RenameDentryRequest(
            union_id='cHtUYxxxxx',
            new_name='テスト'
        )
        try:
            client.rename_dentry_with_options('854xxxxx', '645xxxxx', rename_dentry_request, rename_dentry_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()
        rename_dentry_headers = dingtalkstorage__1__0_models.RenameDentryHeaders()
        rename_dentry_headers.x_acs_dingtalk_access_token = '<your access token>'
        rename_dentry_request = dingtalkstorage__1__0_models.RenameDentryRequest(
            union_id='cHtUYxxxxx',
            new_name='テスト'
        )
        try:
            await client.rename_dentry_with_options_async('854xxxxx', '645xxxxx', rename_dentry_request, rename_dentry_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\RenameDentryHeaders;
use AlibabaCloud\SDK\Dingtalk\Vstorage_1_0\Models\RenameDentryRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * Token を使用してアカウント 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();
        $renameDentryHeaders = new RenameDentryHeaders([]);
        $renameDentryHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $renameDentryRequest = new RenameDentryRequest([
            "unionId" => "cHtUYxxxxx",
            "newName" => "テスト"
        ]);
        try {
            $client->renameDentryWithOptions("854xxxxx", "645xxxxx", $renameDentryRequest, $renameDentryHeaders, 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:
// 
// Token を使用してアカウント 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
  }

  renameDentryHeaders := &dingtalkstorage_1_0.RenameDentryHeaders{}
  renameDentryHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  renameDentryRequest := &dingtalkstorage_1_0.RenameDentryRequest{
    UnionId: tea.String("cHtUYxxxxx"),
    NewName: tea.String("テスト"),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.RenameDentryWithOptions(tea.String("854xxxxx"), tea.String("645xxxxx"), renameDentryRequest, renameDentryHeaders, &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 {

  /**
   * Token を使用してアカウント 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 renameDentryHeaders = new dingtalkstorage_1_0.RenameDentryHeaders({ });
    renameDentryHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let renameDentryRequest = new dingtalkstorage_1_0.RenameDentryRequest({
      unionId: 'cHtUYxxxxx',
      newName: 'テスト',
    });
    try {
      await client.renameDentryWithOptions('854xxxxx', '645xxxxx', renameDentryRequest, renameDentryHeaders, 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>Token を使用してアカウント 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.RenameDentryHeaders renameDentryHeaders = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.RenameDentryHeaders();
            renameDentryHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.RenameDentryRequest renameDentryRequest = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.RenameDentryRequest
            {
                UnionId = "cHtUYxxxxx",
                NewName = "テスト",
            };
            try
            {
                client.RenameDentryWithOptions("854xxxxx", "645xxxxx", renameDentryRequest, renameDentryHeaders, 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 プロパティが含まれ、開発者の問題特定に役立ちます
                }
            }
        }

    }
}

レスポンス

レスポンスボディ

名前	タイプ	説明
dentry	Object	ファイルまたはフォルダー情報のリスト。
id	String	ファイルまたはフォルダーのID。
spaceId	String	ファイルまたはフォルダーが所在するスペースのID。
parentId	String	親ディレクトリのID。ルートディレクトリの場合、本パラメータは0です。
type	String	タイプ： - FILE：ファイル - FOLDER：フォルダー
name	String	変更後の名称。
size	Long	ファイルサイズ。単位はByte。フォルダーの場合、本フィールドは返されません。
path	String	ファイルまたはフォルダーのパス。
version	Long	バージョン。
status	String	ステータス： - NORMAL：正常 - DELETED：ゴミ箱 - EXPIRED：期限切れ
extension	String	ファイル拡張子。フォルダーの場合、本フィールドは返されません。
creatorId	String	作成者のunionId。
modifierId	String	編集者のunionId。
createTime	String	作成時間。iso8601形式。例：2022-07-29T14:55Z。
modifiedTime	String	編集時間。iso8601形式。例：2022-07-29T14:55Z。
properties	Object	属性。
readOnly	Boolean	ファイルまたはフォルダーが閲覧のみかどうか： - true：はい - false：いいえ
appProperties	`Map<String, Array>`	特定のアプリ上の属性。
	Array	属性リスト。
name	String	属性名。
value	String	属性値。
visibility	String	属性の可視性： - PUBLIC：すべてのスペースで表示 - PTIVATE：現在のスペースのみで表示
uuid	String	識別フィールド。
partitionType	String	ストレージパーティション： - PUBLIC_OSS_PARTITION：パブリッククラウドOSSストレージパーティション - MINI_OSS_PARTITION：専用MiniOSSストレージパーティション
storageDriver	String	ドライバータイプ： - DINGTALK：DingTalk統合ストレージドライバー - ALIDOC：DingTalkドキュメントストレージドライバー - UNKNOWN：不明なドライバー

レスポンスボディ例

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

{
  "dentry" : {
    "id" : "645xxxxx",
    "spaceId" : "854xxxxx",
    "parentId" : "0",
    "type" : "FILE",
    "name" : "テスト",
    "size" : 512,
    "path" : "/テストフォルダー",
    "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" : "属性1",
      "value" : "属性値1",
      "visibility" : "PRIVATE"
    } ],
    "uuid" : "uuid",
    "partitionType" : "PUBLIC_OSS_PARTITION",
    "storageDriver" : "DINGTALK"
  }
}

エラーコード

本インターフェースの呼び出しでエラーが発生した場合、エラーメッセージをもとにグローバルエラーコードドキュメントから解決策を検索できます。

HttpCode	エラーコード	エラーメッセージ	説明
400	operationConcurrentControl	%s	同時実行制御
400	paramError	%s	パラメータエラー
400	paramError.spaceId	%s	パラメータエラー-spaceId
400	paramError.dentryId	%s	パラメータエラー-dentryId
400	paramError.name	%s	パラメータエラー-name
400	dentryAlreadyExist	%s	同名のファイルが既に存在
403	permissionDenied	%s	ユーザーにファイル（フォルダー）の名前を変更する権限がありません
404	spaceNotExist	%s	スペースが存在しません
404	dentryNotExist	%s	ファイルが存在しません
500	systemError	%s	システムエラー
500	unknownError	Unknown Error	不明なエラー
503	operationTimeout	%s	リクエストタイムアウト

API 呼び出しガイド

認証と認可

連絡先

カレンダー

会議

AI Table

Docs とファイル

IM

ファイルまたはフォルダーの名前を変更

リクエスト

基本情報

リクエストヘッダー

パスパラメータ

クエリパラメータ

リクエストボディ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディ例

エラーコード

​リクエスト

​基本情報

​リクエストヘッダー

​パスパラメータ

​クエリパラメータ

​リクエストボディ

​リクエスト例

​レスポンス

​レスポンスボディ

​レスポンスボディ例

​エラーコード

リクエスト

基本情報

リクエストヘッダー

パスパラメータ

クエリパラメータ

リクエストボディ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディ例

エラーコード