Get space information - DingTalk Help Center

Call this API to get the information of a storage space.

API call description

Call this API to get the details of a space, including the space name, used quota, owner type, and more.

When the storage space type is USER, all users with permissions on the space have operation permissions. Other employees must call the Add permissions API to be granted authorization.
When the storage space type is APP, anyone who performs operations must call the Add permissions API to be granted authorization.

Request

Basic information

Field	Value
HTTP URL	`https://api.dingtalk.io/v1.0/storage/spaces/{spaceId}`
HTTP Method	GET
Supported app types	appType-Internal app　appType-Third-party enterprise app
Permission requirements	permission-Storage.Space.Read-Read permission on the organization storage space

Request headers

Name	Type	Required	Description
x-acs-dingtalk-access-token	String	Yes	The access credential for calling this API. Obtain it as follows: - For an internal app, call the Get the access token of an internal app API. - For a third-party enterprise app, call the Get the access token of an authorized organization for a third-party app API.

Path parameters

Name	Type	Required	Description
spaceId	String	Yes	The space ID. Call the Add space API to get the value of the id parameter.

Query parameters

Name	Type	Required	Description
unionId	String	Yes	The unionId of the operator. Call the Query user details API to obtain it.

Request example

HTTP

GET /v1.0/storage/spaces/854xxxxx?unionId=cxUXxxxxxx HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:xxxxx
Content-Type:application/json

Java

// 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 a 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.GetSpaceHeaders getSpaceHeaders = new com.aliyun.dingtalkstorage_1_0.models.GetSpaceHeaders();
        getSpaceHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkstorage_1_0.models.GetSpaceRequest getSpaceRequest = new com.aliyun.dingtalkstorage_1_0.models.GetSpaceRequest()
                .setUnionId("cxUXxxxxxx");
        try {
            client.getSpaceWithOptions("854xxxxx", getSpaceRequest, getSpaceHeaders, 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 contains code and message attributes to help locate the 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 contains code and message attributes to help locate the issue
            }

        }        
    }
}

Python

# -*- 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 a 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()
        get_space_headers = dingtalkstorage__1__0_models.GetSpaceHeaders()
        get_space_headers.x_acs_dingtalk_access_token = '<your access token>'
        get_space_request = dingtalkstorage__1__0_models.GetSpaceRequest(
            union_id='cxUXxxxxxx'
        )
        try:
            client.get_space_with_options('854xxxxx', get_space_request, get_space_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err contains code and message attributes to help locate the issue
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        get_space_headers = dingtalkstorage__1__0_models.GetSpaceHeaders()
        get_space_headers.x_acs_dingtalk_access_token = '<your access token>'
        get_space_request = dingtalkstorage__1__0_models.GetSpaceRequest(
            union_id='cxUXxxxxxx'
        )
        try:
            await client.get_space_with_options_async('854xxxxx', get_space_request, get_space_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err contains code and message attributes to help locate the issue
                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\GetSpaceHeaders;
use AlibabaCloud\SDK\Dingtalk\Vstorage_1_0\Models\GetSpaceRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * Initialize the account Client with a 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();
        $getSpaceHeaders = new GetSpaceHeaders([]);
        $getSpaceHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $getSpaceRequest = new GetSpaceRequest([
            "unionId" => "cxUXxxxxxx"
        ]);
        try {
            $client->getSpaceWithOptions("854xxxxx", $getSpaceRequest, $getSpaceHeaders, 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 contains code and message attributes to help locate the 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));

// This file is auto-generated, don't edit it. Thanks.
package main

import (
  "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"
)

/**
 * Initialize the account Client with a 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
  }

  getSpaceHeaders := &dingtalkstorage_1_0.GetSpaceHeaders{}
  getSpaceHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  getSpaceRequest := &dingtalkstorage_1_0.GetSpaceRequest{
    UnionId: tea.String("cxUXxxxxxx"),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.GetSpaceWithOptions(tea.String("854xxxxx"), getSpaceRequest, getSpaceHeaders, &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 contains code and message attributes to help locate the issue
    }

  }
  return _err
}

func main() {
  err := _main(tea.StringSlice(os.Args[1:]))
  if err != nil {
    panic(err)
  }
}

Node.js

// 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 a 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 getSpaceHeaders = new $dingtalkstorage_1_0.GetSpaceHeaders({ });
    getSpaceHeaders.xAcsDingtalkAccessToken = "<your access token>";
    let getSpaceRequest = new $dingtalkstorage_1_0.GetSpaceRequest({
      unionId: "cxUXxxxxxx",
    });
    try {
      await client.getSpaceWithOptions("854xxxxx", getSpaceRequest, getSpaceHeaders, new $Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.empty(err.code) && !Util.empty(err.message)) {
        // err contains code and message attributes to help locate the issue
      }

    }    
  }

}

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 a 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.GetSpaceHeaders getSpaceHeaders = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.GetSpaceHeaders();
            getSpaceHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.GetSpaceRequest getSpaceRequest = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.GetSpaceRequest
            {
                UnionId = "cxUXxxxxxx",
            };
            try
            {
                client.GetSpaceWithOptions("854xxxxx", getSpaceRequest, getSpaceHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
            }
            catch (TeaException err)
            {
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // err contains code and message attributes to help locate the 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 contains code and message attributes to help locate the issue
                }
            }
        }

    }
}

python2

# -*- coding: utf-8 -*-
# This file is auto-generated, don't edit it. Thanks.
from __future__ import unicode_literals

import sys

from alibabacloud_dingtalkstorage_1_0.client import Client as dingtalkstorage_1_0Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_dingtalkstorage_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(object):
    def __init__(self):
        pass

    @staticmethod
    def create_client():
        """
        Initialize the account Client with a 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):
        client = Sample.create_client()
        get_space_headers = dingtalkstorage__1__0_models.GetSpaceHeaders()
        get_space_headers.x_acs_dingtalk_access_token = '<your access token>'
        get_space_request = dingtalkstorage__1__0_models.GetSpaceRequest(
            union_id='cxUXxxxxxx'
        )
        try:
            client.get_space_with_options('854xxxxx', get_space_request, get_space_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err contains code and message attributes to help locate the issue
                pass

if __name__ == '__main__':
    Sample.main(sys.argv[1:])

Swift

#!/usr/bin/env xcrun swift

import Cocoa
import Foundation
import Tea
import TeaUtils
import AlibabacloudDingtalkstorage10
import AlibabacloudOpenApi

open class Client {
    public static func createClient() throws -> AlibabacloudDingtalkstorage10.Client {
        var config: AlibabacloudOpenApi.Config = AlibabacloudOpenApi.Config([:])
        config.protocol_ = "https"
        config.regionId = "central"
        return AlibabacloudDingtalkstorage10.Client(config)
    }

    @available(macOS 10.15, iOS 13, tvOS 13, watchOS 6, *)
    public static func main(_ args: [String]?) async throws -> Void {
        var client: AlibabacloudDingtalkstorage10.Client = try Client.createClient()
        var getSpaceHeaders: AlibabacloudDingtalkstorage10.GetSpaceHeaders = AlibabacloudDingtalkstorage10.GetSpaceHeaders([:])
        getSpaceHeaders.xAcsDingtalkAccessToken = "<your access token>"
        var getSpaceRequest: AlibabacloudDingtalkstorage10.GetSpaceRequest = AlibabacloudDingtalkstorage10.GetSpaceRequest([
            "unionId": "cxUXxxxxxx"
        ])
        do {
            try await client.getSpaceWithOptions("854xxxxx", getSpaceRequest as! AlibabacloudDingtalkstorage10.GetSpaceRequest, getSpaceHeaders as! AlibabacloudDingtalkstorage10.GetSpaceHeaders, TeaUtils.RuntimeOptions([:]))
        }
        catch {
            if error is Tea.TeaError {
                var err = error as! Tea.TeaError
                if (!TeaUtils.Client.empty(err.code) && !TeaUtils.Client.empty(err.message)) {
                }
            } else {
                throw error
            }
        }
    }
}

Client.main(CommandLine.arguments)

Response

Response body

Name	Type	Description
space	Object	The space details.
id	String	The space ID.
corpId	String	The organization ID that the space belongs to.
creatorId	String	The unionId of the creator.
ownerType	String	The owner type. - USER: User type - APP: App type
ownerId	String	The owner identifier.
modifierId	String	The unionId of the modifier.
usedQuota	Long	The used quota, in bytes.
quota	Long	The total quota, in bytes.
status	String	The space status. - NORMAL: Normal - DELETE: Deleted
createTime	String	The creation time, in ISO 8601 format. For example, 2022-07-29T14:55Z.
modifiedTime	String	The modification time, in ISO 8601 format. For example, 2022-07-29T14:55Z.
appId	String	The appId of the Open Platform app.
scene	String	The business scenario.
sceneId	String	The scenario ID.
capabilities	Object	The space capability items.
canSearch	Boolean	Indicates whether search is supported. - true: Supported - false: Not supported
canRename	Boolean	Indicates whether renaming the space is supported. - true: Supported - false: Not supported
canRecordRecentFile	Boolean	Indicates whether being added to the Recently Used list is supported. - true: Supported - false: Not supported
name	String	The space name.
partitions	Array	The partition quota information. Maximum value: 2.
partitionType	String	The partition type. - PUBLIC_OSS_PARTITION: Public Cloud OSS storage partition - MINI_OSS_PARTITION: Dedicated Mini OSS storage partition
quota	Object	The quota information.
used	Long	The actual used quota, in bytes. Minimum value: 0. Indicates the total quota consumed by files under the app. Uploading, copying, and deleting files update the value of used accordingly.
max	Long	The maximum quota, in bytes. - When the current app quota is set to max, the app quota has an upper limit, and the value of used cannot exceed the value of max. - When the current app quota is not set to max, the value is empty. In this case, the app shares the remaining available quota of the organization.
reserved	Long	The remaining pre-allocated quota, in bytes. The admin console can pre-allocate quota to apps or spaces. This field indicates the remaining pre-allocated quota, that is, the unused portion of the pre-allocated quota. If no pre-allocated quota is set, this field is empty.
type	String	The quota type. - SHARE: Shared quota. In this mode, Quota.max is empty, indicating that the organization quota is shared. - PRIVATE: Pre-allocated quota (dedicated quota). In this mode, after Quota.max is set, the quota is exclusive. Use pre-allocated quota (dedicated quota) when you need to ensure that the available quota of a single app is not affected by other apps.

Response body example

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

{
  "space" : {
    "id" : "854xxxxx",
    "corpId" : "ding12345",
    "creatorId" : "cHtUYxxxxx",
    "ownerType" : "USER",
    "ownerId" : "cHtUYxxxxx",
    "modifierId" : "xxxxx",
    "usedQuota" : 1024,
    "quota" : 1048576,
    "status" : "NORMAL",
    "createTime" : "2022-01-01T10:00:00Z",
    "modifiedTime" : "2022-01-01T10:00:00Z",
    "appId" : "app_id",
    "scene" : "scene",
    "sceneId" : "123",
    "capabilities" : {
      "canSearch" : true,
      "canRename" : true,
      "canRecordRecentFile" : true
    },
    "name" : "Test space",
    "partitions" : [ {
      "partitionType" : "PUBLIC_OSS_PARTITION",
      "quota" : {
        "used" : 1024,
        "max" : 10000,
        "reserved" : 1000,
        "type" : "SHARE"
      }
    } ]
  }
}

Error codes

If an error is returned when you call this API, find the solution in the Global error codes document based on the error message.

HttpCode	Error code	Error message	Description
400	paramError	%s	Parameter error
403	permissionDenied	%s	The user lacks permission to get the space information
404	spaceNotExist	%s	The space does not exist
500	systemError	%s	System error
500	unknownError	Unknown Error	Unknown error
503	operationTimeout	%s	Request timeout

​API call description

​Request

​Basic information

​Request headers

​Path parameters

​Query parameters

​Request example

​Response

​Response body

​Response body example

​Error codes