Permintaan
Informasi dasar
| Bidang | Nilai |
|---|---|
| URL HTTP | https://api.dingtalk.io/v1.0/storage/spaces/{spaceId}/dentries/{dentryId}/rename |
| Metode HTTP | POST |
| Tipe aplikasi yang didukung | appType-Aplikasi internal appType-Aplikasi perusahaan pihak ketiga |
| Izin yang diperlukan | permission-Storage.File.Write-Izin tulis file penyimpanan organisasi |
Header permintaan
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| x-acs-dingtalk-access-token | String | Ya | Kredensial akses yang digunakan untuk memanggil API ini. Dapatkan dengan cara berikut: - Untuk aplikasi internal, panggil API Dapatkan access token aplikasi internal. - Untuk aplikasi perusahaan pihak ketiga, panggil API Dapatkan access token organisasi yang memberi otorisasi untuk aplikasi pihak ketiga. |
Parameter jalur
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| spaceId | String | Ya | ID ruang. Panggil API Tambah ruang untuk mendapatkan nilai parameter id. |
| dentryId | String | Ya | ID file atau folder. Panggil API Dapatkan daftar file atau folder atau Dapatkan spaceId dan dentryId berdasarkan dentryUuid untuk mendapatkan nilai parameter id. Direktori root ruang penyimpanan tidak dapat diganti namanya, jadi parameter ini tidak mendukung nilai 0. |
Parameter kueri
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| unionId | String | Ya | unionId operator. Panggil API Kueri detail pengguna untuk mendapatkan nilai parameter unionid. |
Isi permintaan
| Nama | Tipe | Wajib | Deskripsi | |
|---|---|---|---|---|
| newName | String | Ya | Nama baru file atau folder. Aturan penamaan:- Spasi di awal dan akhir dihapus secara otomatis. - Tidak boleh mengandung karakter khusus, termasuk: tab, *, ", <, >, ` | . - Tidak boleh diakhiri dengan .`. |
Contoh permintaan
HTTPPOST /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" : "Test"
}
package com.aliyun.sample;
import com.aliyun.tea.*;
public class Sample {
/**
* <b>description</b> :
* <p>Initialize the account Client using the 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.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("Test");
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 berisi atribut code dan message yang membantu menemukan 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 berisi atribut code dan message yang membantu menemukan issue
}
}
}
}
# -*- 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 using the 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()
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='Test'
)
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 berisi atribut code dan message yang membantu menemukan issue
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='Test'
)
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 berisi atribut code dan message yang membantu menemukan 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\RenameDentryHeaders;
use AlibabaCloud\SDK\Dingtalk\Vstorage_1_0\Models\RenameDentryRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;
class Sample {
/**
* Initialize the account Client using the 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();
$renameDentryHeaders = new RenameDentryHeaders([]);
$renameDentryHeaders->xAcsDingtalkAccessToken = "<your access token>";
$renameDentryRequest = new RenameDentryRequest([
"unionId" => "cHtUYxxxxx",
"newName" => "Test"
]);
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 berisi atribut code dan message yang membantu menemukan 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));
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 using the 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
}
renameDentryHeaders := &dingtalkstorage_1_0.RenameDentryHeaders{}
renameDentryHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
renameDentryRequest := &dingtalkstorage_1_0.RenameDentryRequest{
UnionId: tea.String("cHtUYxxxxx"),
NewName: tea.String("Test"),
}
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 berisi atribut code dan message yang membantu menemukan issue
}
}
return _err
}
func main() {
err := _main(tea.StringSlice(os.Args[1:]))
if err != nil {
panic(err)
}
}
'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 using the 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 renameDentryHeaders = new dingtalkstorage_1_0.RenameDentryHeaders({ });
renameDentryHeaders.xAcsDingtalkAccessToken = '<your access token>';
let renameDentryRequest = new dingtalkstorage_1_0.RenameDentryRequest({
unionId: 'cHtUYxxxxx',
newName: 'Test',
});
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 berisi atribut code dan message yang membantu menemukan issue
}
}
}
}
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>Initialize the account Client using the 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.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 = "Test",
};
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 berisi atribut code dan message yang membantu menemukan 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 berisi atribut code dan message yang membantu menemukan issue
}
}
}
}
}
Respons
Isi respons
| Nama | Tipe | Deskripsi |
|---|---|---|
| dentry | Object | Daftar informasi file atau folder. |
| id | String | ID file atau folder. |
| spaceId | String | ID ruang tempat file atau folder berada. |
| parentId | String | ID direktori induk. Untuk direktori root, parameter ini bernilai 0. |
| type | String | Tipe: - FILE: file - FOLDER: folder |
| name | String | Nama setelah diganti. |
| size | Long | Ukuran file, dalam byte. Bidang ini tidak dikembalikan untuk folder. |
| path | String | Jalur file atau folder. |
| version | Long | Versi. |
| status | String | Status: - NORMAL: normal - DELETED: dihapus - EXPIRED: kedaluwarsa |
| extension | String | Ekstensi file. Bidang ini tidak dikembalikan untuk folder. |
| creatorId | String | unionId pembuat. |
| modifierId | String | unionId pengubah. |
| createTime | String | Waktu pembuatan, dalam format ISO 8601. Contoh: 2022-07-29T14:55Z. |
| modifiedTime | String | Waktu modifikasi, dalam format ISO 8601. Contoh: 2022-07-29T14:55Z. |
| properties | Object | Atribut. |
| readOnly | Boolean | Apakah file atau folder hanya baca: - true: ya - false: tidak |
| appProperties | Map<String, Array> | Atribut khusus untuk sebuah aplikasi. |
| Array | Daftar atribut. | |
| name | String | Nama atribut. |
| value | String | Nilai atribut. |
| visibility | String | Visibilitas atribut: - PUBLIC: terlihat oleh semua ruang - PTIVATE: hanya terlihat oleh ruang saat ini |
| uuid | String | Bidang pengidentifikasi. |
| partitionType | String | Partisi penyimpanan: - PUBLIC_OSS_PARTITION: partisi penyimpanan OSS cloud publik - MINI_OSS_PARTITION: partisi penyimpanan MiniOSS khusus |
| storageDriver | String | Tipe driver: - DINGTALK: driver penyimpanan terpadu DingTalk - ALIDOC: driver penyimpanan DingTalk Docs - UNKNOWN: driver tidak dikenal |
Contoh isi respons
HTTP/1.1 200 OK
Content-Type:application/json
{
"dentry" : {
"id" : "645xxxxx",
"spaceId" : "854xxxxx",
"parentId" : "0",
"type" : "FILE",
"name" : "Test",
"size" : 512,
"path" : "/TestFolder",
"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" : "Attribute1",
"value" : "AttributeValue1",
"visibility" : "PRIVATE"
} ],
"uuid" : "uuid",
"partitionType" : "PUBLIC_OSS_PARTITION",
"storageDriver" : "DINGTALK"
}
}
Kode error
Jika panggilan API gagal, lihat pesan error dan cari solusinya di dokumen Kode error global.| HttpCode | Kode error | Pesan error | Deskripsi |
|---|---|---|---|
| 400 | operationConcurrentControl | %s | Kontrol konkurensi |
| 400 | paramError | %s | Error parameter |
| 400 | paramError.spaceId | %s | Error parameter - spaceId |
| 400 | paramError.dentryId | %s | Error parameter - dentryId |
| 400 | paramError.name | %s | Error parameter - name |
| 400 | dentryAlreadyExist | %s | File dengan nama yang sama sudah ada |
| 403 | permissionDenied | %s | Pengguna tidak memiliki izin untuk mengganti nama file atau folder |
| 404 | spaceNotExist | %s | Ruang tidak ada |
| 404 | dentryNotExist | %s | File tidak ada |
| 500 | systemError | %s | Error sistem |
| 500 | unknownError | Unknown Error | Error tidak dikenal |
| 503 | operationTimeout | %s | Permintaan kehabisan waktu |