Deskripsi panggilan API
Setelah menambahkan ruang penyimpanan, panggil API ini untuk menambahkan folder di dalam ruang tersebut.- Ketika tipe ruang penyimpanan adalah USER, semua pengguna yang memiliki izin pada ruang tersebut memiliki izin operasi. Karyawan lain harus memanggil API Tambah izin untuk memberikan otorisasi.
- Ketika tipe ruang penyimpanan adalah APP, siapa pun yang melakukan operasi harus memanggil API Tambah izin untuk memberikan otorisasi.
Permintaan
Informasi dasar
| Bidang | Nilai |
|---|---|
| URL HTTP | https://api.dingtalk.io/v1.0/storage/spaces/{spaceId}/dentries/{parentId}/folders |
| 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 untuk memanggil API ini. Dapatkan dengan cara berikut: - Untuk aplikasi internal, panggil API Dapatkan access token aplikasi internal untuk memperolehnya. - Untuk aplikasi perusahaan pihak ketiga, panggil API Dapatkan access token perusahaan yang diberi otorisasi ke aplikasi pihak ketiga untuk memperolehnya. |
Parameter jalur
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| spaceId | String | Ya | ID ruang. Panggil API Tambah ruang untuk memperoleh nilai parameter id. |
| parentId | String | Ya | ID direktori induk. Panggil API Dapatkan daftar file atau folder untuk memperolehnya. Untuk direktori root, atur parameter ini ke 0. |
Parameter kueri
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| unionId | String | Ya | unionId operator. Panggil API Kueri detail pengguna untuk memperolehnya. |
Isi permintaan
| Nama | Tipe | Wajib | Deskripsi | |
|---|---|---|---|---|
| name | String | Ya | Nama folder. Persyaratan penamaan:- Tidak boleh ada spasi di awal atau akhir. Jika ada, spasi tersebut akan dihapus secara otomatis. - Tidak boleh mengandung karakter khusus, termasuk: tab, *, ", <, >, ` | . - Tidak boleh diakhiri dengan .`. |
| option | Object | Tidak | Parameter opsional. | |
| conflictStrategy | String | Tidak | Strategi konflik untuk nama folder. - AUTO_RENAME: Ganti nama secara otomatis. Nilai default. - OVERWRITE: Timpa. - RETURN_DENTRY_IF_EXISTS: Kembalikan folder yang sudah ada. - RETURN_ERROR_IF_EXISTS: Kembalikan error jika folder sudah ada. | |
| appProperties | Array | Tidak | Daftar properti aplikasi untuk folder saat ini. Nilai maksimum: 3. | |
| name | String | Ya | Nama properti. | |
| value | String | Ya | Nilai properti. | |
| visibility | String | Ya | Visibilitas properti. - PUBLIC: Terlihat oleh semua aplikasi. - PRIVATE: Hanya terlihat oleh aplikasi saat ini. |
Contoh permintaan
HTTPPOST /v1.0/storage/spaces/833xxxxx/dentries/0/folders?unionId=cHtUxxxxx HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:xxxxx
Content-Type:application/json
{
"name" : "Folder uji",
"option" : {
"conflictStrategy" : "AUTO_RENAME",
"appProperties" : [ {
"name" : "Atribut1",
"value" : "NilaiAtribut1",
"visibility" : "PUBLIC"
} ]
}
}
// 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 with the 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.AddFolderHeaders addFolderHeaders = new com.aliyun.dingtalkstorage_1_0.models.AddFolderHeaders();
addFolderHeaders.xAcsDingtalkAccessToken = "<your access token>";
com.aliyun.dingtalkstorage_1_0.models.AddFolderRequest.AddFolderRequestOptionAppProperties optionAppProperties0 = new com.aliyun.dingtalkstorage_1_0.models.AddFolderRequest.AddFolderRequestOptionAppProperties()
.setName("Atribut1")
.setValue("NilaiAtribut1")
.setVisibility("PUBLIC");
com.aliyun.dingtalkstorage_1_0.models.AddFolderRequest.AddFolderRequestOption option = new com.aliyun.dingtalkstorage_1_0.models.AddFolderRequest.AddFolderRequestOption()
.setConflictStrategy("AUTO_RENAME")
.setAppProperties(java.util.Arrays.asList(
optionAppProperties0
));
com.aliyun.dingtalkstorage_1_0.models.AddFolderRequest addFolderRequest = new com.aliyun.dingtalkstorage_1_0.models.AddFolderRequest()
.setUnionId("cHtUxxxxx")
.setName("Folder uji")
.setOption(option);
try {
client.addFolderWithOptions("833xxxxx", "0", addFolderRequest, addFolderHeaders, 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 properti code dan message untuk membantu Anda memecahkan masalah
}
} 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 properti code dan message untuk membantu Anda memecahkan masalah
}
}
}
}
# -*- 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 with 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()
add_folder_headers = dingtalkstorage__1__0_models.AddFolderHeaders()
add_folder_headers.x_acs_dingtalk_access_token = '<your access token>'
option_app_properties_0 = dingtalkstorage__1__0_models.AddFolderRequestOptionAppProperties(
name='Atribut1',
value='NilaiAtribut1',
visibility='PUBLIC'
)
option = dingtalkstorage__1__0_models.AddFolderRequestOption(
conflict_strategy='AUTO_RENAME',
app_properties=[
option_app_properties_0
]
)
add_folder_request = dingtalkstorage__1__0_models.AddFolderRequest(
union_id='cHtUxxxxx',
name='Folder uji',
option=option
)
try:
client.add_folder_with_options('833xxxxx', '0', add_folder_request, add_folder_headers, util_models.RuntimeOptions())
except Exception as err:
if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
# err berisi properti code dan message untuk membantu Anda memecahkan masalah
pass
@staticmethod
async def main_async(
args: List[str],
) -> None:
client = Sample.create_client()
add_folder_headers = dingtalkstorage__1__0_models.AddFolderHeaders()
add_folder_headers.x_acs_dingtalk_access_token = '<your access token>'
option_app_properties_0 = dingtalkstorage__1__0_models.AddFolderRequestOptionAppProperties(
name='Atribut1',
value='NilaiAtribut1',
visibility='PUBLIC'
)
option = dingtalkstorage__1__0_models.AddFolderRequestOption(
conflict_strategy='AUTO_RENAME',
app_properties=[
option_app_properties_0
]
)
add_folder_request = dingtalkstorage__1__0_models.AddFolderRequest(
union_id='cHtUxxxxx',
name='Folder uji',
option=option
)
try:
await client.add_folder_with_options_async('833xxxxx', '0', add_folder_request, add_folder_headers, util_models.RuntimeOptions())
except Exception as err:
if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
# err berisi properti code dan message untuk membantu Anda memecahkan masalah
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\AddFolderHeaders;
use AlibabaCloud\SDK\Dingtalk\Vstorage_1_0\Models\AddFolderRequest\option\appProperties;
use AlibabaCloud\SDK\Dingtalk\Vstorage_1_0\Models\AddFolderRequest\option;
use AlibabaCloud\SDK\Dingtalk\Vstorage_1_0\Models\AddFolderRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;
class Sample {
/**
* Initialize the account Client with 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();
$addFolderHeaders = new AddFolderHeaders([]);
$addFolderHeaders->xAcsDingtalkAccessToken = "<your access token>";
$optionAppProperties0 = new appProperties([
"name" => "Atribut1",
"value" => "NilaiAtribut1",
"visibility" => "PUBLIC"
]);
$option = new option([
"conflictStrategy" => "AUTO_RENAME",
"appProperties" => [
$optionAppProperties0
]
]);
$addFolderRequest = new AddFolderRequest([
"unionId" => "cHtUxxxxx",
"name" => "Folder uji",
"option" => $option
]);
try {
$client->addFolderWithOptions("833xxxxx", "0", $addFolderRequest, $addFolderHeaders, 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 properti code dan message untuk membantu Anda memecahkan masalah
}
}
}
}
$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/service"
dingtalkstorage_1_0 "github.com/alibabacloud-go/dingtalk/storage_1_0"
openapi "github.com/alibabacloud-go/darabonba-openapi/client"
"github.com/alibabacloud-go/tea/tea"
)
/**
* Initialize the account Client with 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
}
addFolderHeaders := &dingtalkstorage_1_0.AddFolderHeaders{}
addFolderHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
optionAppProperties0 := &dingtalkstorage_1_0.AddFolderRequestOptionAppProperties{
Name: tea.String("Atribut1"),
Value: tea.String("NilaiAtribut1"),
Visibility: tea.String("PUBLIC"),
}
option := &dingtalkstorage_1_0.AddFolderRequestOption{
ConflictStrategy: tea.String("AUTO_RENAME"),
AppProperties: []*dingtalkstorage_1_0.AddFolderRequestOptionAppProperties{optionAppProperties0},
}
addFolderRequest := &dingtalkstorage_1_0.AddFolderRequest{
UnionId: tea.String("cHtUxxxxx"),
Name: tea.String("Folder uji"),
Option: option,
}
tryErr := func()(_e error) {
defer func() {
if r := tea.Recover(recover()); r != nil {
_e = r
}
}()
_, _err = client.AddFolderWithOptions(tea.String("833xxxxx"), tea.String("0"), addFolderRequest, addFolderHeaders, &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 properti code dan message untuk membantu Anda memecahkan masalah
}
}
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 with the 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 addFolderHeaders = new $dingtalkstorage_1_0.AddFolderHeaders({ });
addFolderHeaders.xAcsDingtalkAccessToken = "<your access token>";
let optionAppProperties0 = new $dingtalkstorage_1_0.AddFolderRequestOptionAppProperties({
name: "Atribut1",
value: "NilaiAtribut1",
visibility: "PUBLIC",
});
let option = new $dingtalkstorage_1_0.AddFolderRequestOption({
conflictStrategy: "AUTO_RENAME",
appProperties: [
optionAppProperties0
],
});
let addFolderRequest = new $dingtalkstorage_1_0.AddFolderRequest({
unionId: "cHtUxxxxx",
name: "Folder uji",
option: option,
});
try {
await client.addFolderWithOptions("833xxxxx", "0", addFolderRequest, addFolderHeaders, new $Util.RuntimeOptions({ }));
} catch (err) {
if (!Util.empty(err.code) && !Util.empty(err.message)) {
// err berisi properti code dan message untuk membantu Anda memecahkan masalah
}
}
}
}
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 with the 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.AddFolderHeaders addFolderHeaders = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.AddFolderHeaders();
addFolderHeaders.XAcsDingtalkAccessToken = "<your access token>";
AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.AddFolderRequest.AddFolderRequestOption.AddFolderRequestOptionAppProperties optionAppProperties0 = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.AddFolderRequest.AddFolderRequestOption.AddFolderRequestOptionAppProperties
{
Name = "Atribut1",
Value = "NilaiAtribut1",
Visibility = "PUBLIC",
};
AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.AddFolderRequest.AddFolderRequestOption option = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.AddFolderRequest.AddFolderRequestOption
{
ConflictStrategy = "AUTO_RENAME",
AppProperties = new List<AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.AddFolderRequest.AddFolderRequestOption.AddFolderRequestOptionAppProperties>
{
optionAppProperties0
},
};
AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.AddFolderRequest addFolderRequest = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.AddFolderRequest
{
UnionId = "cHtUxxxxx",
Name = "Folder uji",
Option = option,
};
try
{
client.AddFolderWithOptions("833xxxxx", "0", addFolderRequest, addFolderHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
}
catch (TeaException err)
{
if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
{
// err berisi properti code dan message untuk membantu Anda memecahkan masalah
}
}
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 properti code dan message untuk membantu Anda memecahkan masalah
}
}
}
}
}
Respons
Isi respons
| Nama | Tipe | Deskripsi |
|---|---|---|
| dentry | Object | Informasi folder. |
| id | String | ID folder. |
| spaceId | String | ID ruang tempat folder berada. |
| parentId | String | ID direktori induk. Nilai 0 menunjukkan direktori root. |
| type | String | Tipe. API ini mengembalikan nilai tetap. - FOLDER: Folder. |
| name | String | Nama folder. |
| size | Long | Ukuran, dalam byte. API ini tidak mengembalikan bidang ini saat menambahkan folder. |
| path | String | Jalur folder di dalam ruang. |
| version | Long | Versi. API ini tidak mengembalikan bidang ini saat menambahkan folder. |
| status | String | Status. - NORMAL: Normal. - DELETED: Dihapus. |
| extension | String | Ekstensi. API ini tidak mengembalikan bidang ini saat menambahkan 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 | Properti folder. |
| readOnly | Boolean | Apakah folder hanya baca. - true: Ya. - false: Tidak. |
| appProperties | Map<String, Array> | Properti pada aplikasi tertentu. Key adalah ownerId ruang, dan value adalah daftar properti. |
| Array | Daftar properti. | |
| name | String | Nama properti. |
| value | String | Nilai properti. |
| visibility | String | Visibilitas properti. - PUBLIC: Terlihat oleh semua aplikasi. - PRIVATE: Hanya terlihat oleh aplikasi saat ini. |
| uuid | String | Bidang identifier. |
| partitionType | String | Partisi penyimpanan. - PUBLIC_OSS_PARTITION: Partisi penyimpanan Public Cloud OSS. - 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" : "123",
"spaceId" : "854xxxxx",
"parentId" : "0",
"type" : "FOLDER",
"name" : "Folder uji",
"size" : 512,
"path" : "/Folder uji",
"version" : 1,
"status" : "NORMAL",
"extension" : "txt",
"creatorId" : "cHtUxxxxx",
"modifierId" : "modifier_id",
"createTime" : "2022-01-01T10:00:00Z",
"modifiedTime" : "2022-01-01T10:00:00Z",
"properties" : {
"readOnly" : true
},
"appProperties" : [ {
"name" : "property_name",
"value" : "property_value",
"visibility" : "PRIVATE"
} ],
"uuid" : "uuid",
"partitionType" : "PUBLIC_OSS_PARTITION",
"storageDriver" : "DINGTALK"
}
}
Kode error
Jika error dikembalikan saat memanggil API ini, lihat dokumen Kode error global untuk menemukan solusi berdasarkan pesan error.| HttpCode | Kode error | Pesan error | Deskripsi |
|---|---|---|---|
| 400 | operationConcurrentControl | %s | Kontrol konkurensi. |
| 400 | paramError | %s | Error parameter. |
| 400 | paramError.conflictStrategy | %s | Error parameter - conflictStrategy. |
| 400 | dentryNameIllegal | %s | Nama file tidak valid. |
| 400 | dentryAlreadyExist | %s | File sudah ada. |
| 403 | permissionDenied | %s | Pengguna tidak memiliki izin untuk menambahkan folder. |
| 404 | dentryNotExist | %s | Direktori induk tidak ada. |
| 500 | systemError | %s | Error sistem. |
| 500 | unknownError | Unknown Error | Error tidak dikenal. |
| 503 | operationTimeout | %s | Permintaan kehabisan waktu. |