API 呼び出し説明
ストレージスペースの紹介
- ストレージスペースは企業クラウドドライブの一部ですが、本 API で追加したスペースはクライアントサイドのクラウドドライブからは表示されません。
- ストレージスペースは企業クラウドドライブの容量を消費します。
ストレージスペースの分類
- ユーザースペース、つまり USER スペース。このスペース内のファイルには永続的な権限のみ付与でき、権限付与者が管理権限を持っている必要があります。
- アプリスペース、つまり APP スペース。このスペース内のファイルには一時的な権限のみ付与でき、権限付与者に管理権限は不要です。
リクエスト
基本情報
| フィールド | 値 |
|---|---|
| HTTP URL | https://api.dingtalk.io/v1.0/storage/spaces |
| HTTP Method | POST |
| サポートされるアプリタイプ | appType-社内アプリ appType-サードパーティ社内アプリ |
| 必要な権限 | permission-Storage.Space.Write-企業ストレージスペース書き込み権限 |
リクエストヘッダー
| 名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
| x-acs-dingtalk-access-token | String | はい | 本 API を呼び出すためのアクセス認証情報。以下の方法で取得します。 - 社内アプリの場合、社内アプリの accessToken を取得 API を呼び出して取得します。 - サードパーティ社内アプリの場合、サードパーティアプリで権限付与された企業の accessToken を取得 API を呼び出して取得します。 |
クエリパラメータ
| 名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
| unionId | String | はい | 操作者の unionId。ユーザー詳細の照会 API を呼び出して取得します。 |
リクエストボディ
| 名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
| option | Object | いいえ | オプションパラメータ。 |
| name | String | いいえ | スペース名。デフォルトではスペース名なし。 |
| quota | Long | いいえ | スペースが使用できる最大容量。単位は Byte。 このパラメータを指定しない場合、スペース容量に具体的な制限はありませんが、企業クラウドドライブの総容量を超えることはできません。 |
| capabilities | Object | いいえ | スペースの機能項目。デフォルトでは拡張機能項目を設定しません。 |
| canSearch | Boolean | いいえ | 検索をサポートするかどうか。 - true:サポートする - false:サポートしない、デフォルト値。 |
| canRename | Boolean | いいえ | スペース名の名前を変更をサポートするかどうか。 - true:サポートする - false:サポートしない、デフォルト値。 |
| canRecordRecentFile | Boolean | いいえ | 最近使用したものリストへの登録をサポートするかどうか。 - true:サポートする - false:サポートしない、デフォルト値。 |
| scene | String | いいえ | スペースシーン。このパラメータは開発者がカスタムで指定します。 - このパラメータを指定しない場合、デフォルト値は default です。 - このパラメータ値 + sceneId が既に存在する場合、本 API は作成済みのスペースを返し、新しいスペースは作成しません。 |
| sceneId | String | いいえ | スペースシーン ID。このパラメータ値は開発者がカスタムで指定します。 - このパラメータを指定しない場合、デフォルト値は 0 です。 - パラメータ sceneId + このパラメータ値が既に存在する場合、本 API は作成済みのスペースを返し、新しいスペースは作成しません。 |
| ownerType | String | いいえ | owner タイプ。 - USER:ユーザータイプ、デフォルト値 - APP:App タイプ |
リクエスト例
HTTPPOST /v1.0/storage/spaces?unionId=cHtUYxxxxx HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:xxxxx
Content-Type:application/json
{
"option" : {
"name" : "テストスペース",
"quota" : 1024,
"capabilities" : {
"canSearch" : true,
"canRename" : true,
"canRecordRecentFile" : true
},
"scene" : "scene",
"sceneId" : "123",
"ownerType" : "USER"
}
}
// This file is auto-generated, don't edit it. Thanks.
package com.aliyun.sample;
import com.aliyun.tea.*;
import com.aliyun.teautil.*;
import com.aliyun.teautil.models.*;
import com.aliyun.dingtalkstorage_1_0.*;
import com.aliyun.dingtalkstorage_1_0.models.*;
import com.aliyun.teaopenapi.*;
import com.aliyun.teaopenapi.models.*;
public class Sample {
/**
* トークンを使用してアカウント Client を初期化
* @return Client
* @throws Exception
*/
public static com.aliyun.dingtalkstorage_1_0.Client createClient() throws Exception {
Config config = new 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();
AddSpaceHeaders addSpaceHeaders = new AddSpaceHeaders();
addSpaceHeaders.xAcsDingtalkAccessToken = "<your access token>";
AddSpaceRequest.AddSpaceRequestOptionCapabilities optionCapabilities = new AddSpaceRequest.AddSpaceRequestOptionCapabilities()
.setCanSearch(true)
.setCanRename(true)
.setCanRecordRecentFile(true);
AddSpaceRequest.AddSpaceRequestOption option = new AddSpaceRequest.AddSpaceRequestOption()
.setName("テストスペース")
.setQuota(1024L)
.setCapabilities(optionCapabilities)
.setScene("scene")
.setSceneId("123")
.setOwnerType("USER");
AddSpaceRequest addSpaceRequest = new AddSpaceRequest()
.setUnionId("cHtUYxxxxx")
.setOption(option);
try {
client.addSpaceWithOptions(addSpaceRequest, addSpaceHeaders, new 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()
add_space_headers = dingtalkstorage__1__0_models.AddSpaceHeaders()
add_space_headers.x_acs_dingtalk_access_token = '<your access token>'
option_capabilities = dingtalkstorage__1__0_models.AddSpaceRequestOptionCapabilities(
can_search=True,
can_rename=True,
can_record_recent_file=True
)
option = dingtalkstorage__1__0_models.AddSpaceRequestOption(
name='テストスペース',
quota=1024,
capabilities=option_capabilities,
scene='scene',
scene_id='123',
owner_type='USER'
)
add_space_request = dingtalkstorage__1__0_models.AddSpaceRequest(
union_id='cHtUYxxxxx',
option=option
)
try:
client.add_space_with_options(add_space_request, add_space_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()
add_space_headers = dingtalkstorage__1__0_models.AddSpaceHeaders()
add_space_headers.x_acs_dingtalk_access_token = '<your access token>'
option_capabilities = dingtalkstorage__1__0_models.AddSpaceRequestOptionCapabilities(
can_search=True,
can_rename=True,
can_record_recent_file=True
)
option = dingtalkstorage__1__0_models.AddSpaceRequestOption(
name='テストスペース',
quota=1024,
capabilities=option_capabilities,
scene='scene',
scene_id='123',
owner_type='USER'
)
add_space_request = dingtalkstorage__1__0_models.AddSpaceRequest(
union_id='cHtUYxxxxx',
option=option
)
try:
await client.add_space_with_options_async(add_space_request, add_space_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\AddSpaceHeaders;
use AlibabaCloud\SDK\Dingtalk\Vstorage_1_0\Models\AddSpaceRequest\option\capabilities;
use AlibabaCloud\SDK\Dingtalk\Vstorage_1_0\Models\AddSpaceRequest\option;
use AlibabaCloud\SDK\Dingtalk\Vstorage_1_0\Models\AddSpaceRequest;
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();
$addSpaceHeaders = new AddSpaceHeaders([]);
$addSpaceHeaders->xAcsDingtalkAccessToken = "<your access token>";
$optionCapabilities = new capabilities([
"canSearch" => true,
"canRename" => true,
"canRecordRecentFile" => true
]);
$option = new option([
"name" => "テストスペース",
"quota" => 1024,
"capabilities" => $optionCapabilities,
"scene" => "scene",
"sceneId" => "123",
"ownerType" => "USER"
]);
$addSpaceRequest = new AddSpaceRequest([
"unionId" => "cHtUYxxxxx",
"option" => $option
]);
try {
$client->addSpaceWithOptions($addSpaceRequest, $addSpaceHeaders, 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/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"
)
/**
* トークンを使用してアカウント 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
}
addSpaceHeaders := &dingtalkstorage_1_0.AddSpaceHeaders{}
addSpaceHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
optionCapabilities := &dingtalkstorage_1_0.AddSpaceRequestOptionCapabilities{
CanSearch: tea.Bool(true),
CanRename: tea.Bool(true),
CanRecordRecentFile: tea.Bool(true),
}
option := &dingtalkstorage_1_0.AddSpaceRequestOption{
Name: tea.String("テストスペース"),
Quota: tea.Int64(1024),
Capabilities: optionCapabilities,
Scene: tea.String("scene"),
SceneId: tea.String("123"),
OwnerType: tea.String("USER"),
}
addSpaceRequest := &dingtalkstorage_1_0.AddSpaceRequest{
UnionId: tea.String("cHtUYxxxxx"),
Option: option,
}
tryErr := func()(_e error) {
defer func() {
if r := tea.Recover(recover()); r != nil {
_e = r
}
}()
_, _err = client.AddSpaceWithOptions(addSpaceRequest, addSpaceHeaders, &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 addSpaceHeaders = new $dingtalkstorage_1_0.AddSpaceHeaders({ });
addSpaceHeaders.xAcsDingtalkAccessToken = "<your access token>";
let optionCapabilities = new $dingtalkstorage_1_0.AddSpaceRequestOptionCapabilities({
canSearch: true,
canRename: true,
canRecordRecentFile: true,
});
let option = new $dingtalkstorage_1_0.AddSpaceRequestOption({
name: "テストスペース",
quota: 1024,
capabilities: optionCapabilities,
scene: "scene",
sceneId: "123",
ownerType: "USER",
});
let addSpaceRequest = new $dingtalkstorage_1_0.AddSpaceRequest({
unionId: "cHtUYxxxxx",
option: option,
});
try {
await client.addSpaceWithOptions(addSpaceRequest, addSpaceHeaders, 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.AddSpaceHeaders addSpaceHeaders = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.AddSpaceHeaders();
addSpaceHeaders.XAcsDingtalkAccessToken = "<your access token>";
AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.AddSpaceRequest.AddSpaceRequestOption.AddSpaceRequestOptionCapabilities optionCapabilities = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.AddSpaceRequest.AddSpaceRequestOption.AddSpaceRequestOptionCapabilities
{
CanSearch = true,
CanRename = true,
CanRecordRecentFile = true,
};
AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.AddSpaceRequest.AddSpaceRequestOption option = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.AddSpaceRequest.AddSpaceRequestOption
{
Name = "テストスペース",
Quota = 1024,
Capabilities = optionCapabilities,
Scene = "scene",
SceneId = "123",
OwnerType = "USER",
};
AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.AddSpaceRequest addSpaceRequest = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.AddSpaceRequest
{
UnionId = "cHtUYxxxxx",
Option = option,
};
try
{
client.AddSpaceWithOptions(addSpaceRequest, addSpaceHeaders, 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 属性が含まれており、開発時の問題特定に役立ちます
}
}
}
}
}
レスポンス
レスポンスボディ
| 名前 | タイプ | 説明 |
|---|---|---|
| space | Object | スペース情報。 |
| id | String | スペース id。 |
| corpId | String | スペースが属する企業の組織 ID。 |
| creatorId | String | 作成者の unionId。 |
| ownerType | String | owner タイプ。 - USER:ユーザータイプ、デフォルト値 - APP:App タイプ |
| ownerId | String | 所有者識別子。 |
| modifierId | String | 編集者の unionId。 |
| usedQuota | Long | 使用済み容量。単位は Byte。 |
| quota | Long | 総容量。単位は Byte。 |
| status | String | スペースの状態。 - NORMAL:正常 - DELETE:ゴミ箱 |
| createTime | String | 作成時間。iso8601 形式、例:2022-07-29T14:55Z。 |
| modifiedTime | String | 編集時間。iso8601 形式、例:2022-07-29T14:55Z。 |
| appId | String | オープンプラットフォームアプリの appId |
| scene | String | 業務シーン。 |
| sceneId | String | スペースシーン ID。 |
| capabilities | Object | スペースの機能項目。 |
| canSearch | Boolean | 検索をサポートするかどうか。 - true:サポートする - false:サポートしない、デフォルト値。 |
| canRename | Boolean | スペース名の名前を変更をサポートするかどうか。 - true:サポートする - false:サポートしない、デフォルト値。 |
| canRecordRecentFile | Boolean | 最近使用したものリストへの登録をサポートするかどうか。 - true:サポートする - false:サポートしない、デフォルト値。 |
| name | String | スペース名。 |
| partitions | Array | パーティション容量情報。最大値は 2。 |
| partitionType | String | パーティションタイプ。 - PUBLIC_OSS_PARTITION:パブリッククラウド OSS ストレージパーティション - MINI_OSS_PARTITION:専有 Mini OSS ストレージパーティション |
| quota | Object | 容量情報。 |
| used | Long | 実際の使用済み容量。単位は Byte、最小値は 0。 該当アプリ配下の全ファイルが占有する容量の合計を表します。ファイルのアップロード、コピー、削除などの操作により used の値が変更されます。 |
| max | Long | 最大容量。単位は Byte。 - 現在のアプリ容量が max に設定されている場合、現在のアプリ容量に上限が設定されていることを表し、used パラメータ値は max パラメータ値を超えることができません。 - 現在のアプリ容量が max に設定されていない場合は空を返します。この場合、アプリは該当企業の残り使用可能容量を共有します。 |
| reserved | Long | 事前割り当ての残り容量。単位は Byte。 管理バックエンドではアプリまたはスペースに容量を事前に割り当てることができます。このフィールドは事前割り当ての残り容量、つまり事前割り当て容量のうち未使用部分を表します。事前割り当て容量が設定されていない場合、このフィールドは空です。 |
| type | String | 容量タイプ。 - SHARE: 共有容量。このモードでは Quota.max が空となり、企業容量を共有することを表します。 - PRIVATE: 事前割り当て容量(専用容量)。このモードでは Quota.max に値を設定すると、容量を独占することを表します。 単一のアプリの使用可能容量が他のアプリの影響を受けないようにする必要がある場合、事前割り当て容量(専用容量)を使用できます。 |
レスポンスボディ例
HTTP/1.1 200 OK
Content-Type:application/json
{
"space" : {
"id" : "833xxxxx",
"corpId" : "ding027xxxxx",
"creatorId" : "cHtUYxxxxx",
"ownerType" : "USER",
"ownerId" : "xxxxx",
"modifierId" : "cHtUYxxxxx",
"usedQuota" : 1024,
"quota" : 1048576,
"status" : "NORMAL",
"createTime" : "2022-01-01T10:00:00Z",
"modifiedTime" : "2022-01-01T10:00:00Z",
"scene" : "scene",
"sceneId" : "123",
"capabilities" : {
"canSearch" : true,
"canRename" : true,
"canRecordRecentFile" : true
},
"name" : "テストスペース"
}
}
エラーコード
本 API の呼び出しでエラーが発生した場合は、エラーメッセージをもとにグローバルエラーコードドキュメントから解決方法を検索してください。| HttpCode | エラーコード | エラーメッセージ | 説明 |
|---|---|---|---|
| 400 | paramError | %s | パラメータエラー |
| 400 | paramError.name | %s | パラメータエラー-name |
| 400 | paramError.scene | %s | パラメータエラー-scene |
| 400 | paramError.sceneId | %s | パラメータエラー-sceneId |
| 403 | permissionDenied | %s | ユーザーにスペース作成権限がありません |
| 500 | systemError | %s | システムエラー |
| 500 | unknownError | Unknown Error | 不明なエラー |
| 503 | operationTimeout | %s | リクエストタイムアウト |