List spaces - DingTalk Help Center

Call this API to query the list of Drive spaces.

Request

Basic information

Field	Value
HTTP URL	https://api.dingtalk.io/v1.0/drive/spaces
HTTP Method	GET
Supported app types	appType-Internal app　appType-Third-party enterprise app
Required permissions	permission-Drive.Space.Read-Read permission on Drive app spaces

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 enterprise authorized to a third-party app API.

Query parameters

Name	Type	Required	Description
unionId	String	Yes	The unionId of the user. Call the Query user details API to obtain it.
spaceType	String	Yes	The space type. - org: organization space
nextToken	String	No	The pagination cursor.
maxResults	Integer	Yes	The page size.

Request example

HTTP

GET /v1.0/drive/spaces?unionId=sKUPRiijiSrqsuwqcPiSdbeNwiXxx&spaceType=org&nextToken=2CMlB97VtVJWfoVliPIXPUQiEiE&maxResults=50 HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:2db66caxxxx
Content-Type:application/json

Java

// 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.dingtalkdrive_1_0.*;
import com.aliyun.dingtalkdrive_1_0.models.*;
import com.aliyun.teaopenapi.*;
import com.aliyun.teaopenapi.models.*;

public class Sample {

    /**
     * Initialize the account client by using a Token
     * @return Client
     * @throws Exception
     */
    public static com.aliyun.dingtalkdrive_1_0.Client createClient() throws Exception {
        Config config = new Config();
        config.protocol = "https";
        config.regionId = "central";
        return new com.aliyun.dingtalkdrive_1_0.Client(config);
    }

    public static void main(String[] args_) throws Exception {
        java.util.List<String> args = java.util.Arrays.asList(args_);
        com.aliyun.dingtalkdrive_1_0.Client client = Sample.createClient();
        ListSpacesHeaders listSpacesHeaders = new ListSpacesHeaders();
        listSpacesHeaders.xAcsDingtalkAccessToken = "<your access token>";
        ListSpacesRequest listSpacesRequest = new ListSpacesRequest()
                .setUnionId("sKUPRiijiSrqsuwqcPiSdbeNwiXxx")
                .setSpaceType("org")
                .setNextToken("2CMlB97VtVJWfoVliPIXPUQiEiE")
                .setMaxResults(50);
        try {
            client.listSpacesWithOptions(listSpacesRequest, listSpacesHeaders, new RuntimeOptions());
        } catch (TeaException err) {
            if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) {
                // err contains code and message properties 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 properties 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.drive_1_0.client import Client as dingtalkdrive_1_0Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_dingtalk.drive_1_0 import models as dingtalkdrive__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() -> dingtalkdrive_1_0Client:
        """
        Initialize the account client by using a Token
        @return: Client
        @throws Exception
        """
        config = open_api_models.Config()
        config.protocol = 'https'
        config.region_id = 'central'
        return dingtalkdrive_1_0Client(config)

    @staticmethod
    def main(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        list_spaces_headers = dingtalkdrive__1__0_models.ListSpacesHeaders()
        list_spaces_headers.x_acs_dingtalk_access_token = '<your access token>'
        list_spaces_request = dingtalkdrive__1__0_models.ListSpacesRequest(
            union_id='sKUPRiijiSrqsuwqcPiSdbeNwiXxx',
            space_type='org',
            next_token='2CMlB97VtVJWfoVliPIXPUQiEiE',
            max_results=50
        )
        try:
            client.list_spaces_with_options(list_spaces_request, list_spaces_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 properties to help locate the issue
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        list_spaces_headers = dingtalkdrive__1__0_models.ListSpacesHeaders()
        list_spaces_headers.x_acs_dingtalk_access_token = '<your access token>'
        list_spaces_request = dingtalkdrive__1__0_models.ListSpacesRequest(
            union_id='sKUPRiijiSrqsuwqcPiSdbeNwiXxx',
            space_type='org',
            next_token='2CMlB97VtVJWfoVliPIXPUQiEiE',
            max_results=50
        )
        try:
            await client.list_spaces_with_options_async(list_spaces_request, list_spaces_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 properties 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\Vdrive_1_0\Dingtalk;
use \Exception;
use AlibabaCloud\Tea\Exception\TeaError;
use AlibabaCloud\Tea\Utils\Utils;

use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\SDK\Dingtalk\Vdrive_1_0\Models\ListSpacesHeaders;
use AlibabaCloud\SDK\Dingtalk\Vdrive_1_0\Models\ListSpacesRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * Initialize the account client by using 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();
        $listSpacesHeaders = new ListSpacesHeaders([]);
        $listSpacesHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $listSpacesRequest = new ListSpacesRequest([
            "unionId" => "sKUPRiijiSrqsuwqcPiSdbeNwiXxx",
            "spaceType" => "org",
            "nextToken" => "2CMlB97VtVJWfoVliPIXPUQiEiE",
            "maxResults" => 50
        ]);
        try {
            $client->listSpacesWithOptions($listSpacesRequest, $listSpacesHeaders, 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 properties 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/service"
  dingtalkdrive_1_0  "github.com/alibabacloud-go/dingtalk/drive_1_0"
  openapi  "github.com/alibabacloud-go/darabonba-openapi/client"
  "github.com/alibabacloud-go/tea/tea"
)

/**
 * Initialize the account client by using a Token
 * @return Client
 * @throws Exception
 */
func CreateClient () (_result *dingtalkdrive_1_0.Client, _err error) {
  config := &openapi.Config{}
  config.Protocol = tea.String("https")
  config.RegionId = tea.String("central")
  _result = &dingtalkdrive_1_0.Client{}
  _result, _err = dingtalkdrive_1_0.NewClient(config)
  return _result, _err
}

func _main (args []*string) (_err error) {
  client, _err := CreateClient()
  if _err != nil {
    return _err
  }

  listSpacesHeaders := &dingtalkdrive_1_0.ListSpacesHeaders{}
  listSpacesHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  listSpacesRequest := &dingtalkdrive_1_0.ListSpacesRequest{
    UnionId: tea.String("sKUPRiijiSrqsuwqcPiSdbeNwiXxx"),
    SpaceType: tea.String("org"),
    NextToken: tea.String("2CMlB97VtVJWfoVliPIXPUQiEiE"),
    MaxResults: tea.Int32(50),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.ListSpacesWithOptions(listSpacesRequest, listSpacesHeaders, &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 properties 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 dingtalkdrive_1_0, * as $dingtalkdrive_1_0 from '@alicloud/dingtalk/drive_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 by using a Token
   * @return Client
   * @throws Exception
   */
  static createClient(): dingtalkdrive_1_0 {
    let config = new $OpenApi.Config({ });
    config.protocol = "https";
    config.regionId = "central";
    return new dingtalkdrive_1_0(config);
  }

  static async main(args: string[]): Promise<void> {
    let client = Client.createClient();
    let listSpacesHeaders = new $dingtalkdrive_1_0.ListSpacesHeaders({ });
    listSpacesHeaders.xAcsDingtalkAccessToken = "<your access token>";
    let listSpacesRequest = new $dingtalkdrive_1_0.ListSpacesRequest({
      unionId: "sKUPRiijiSrqsuwqcPiSdbeNwiXxx",
      spaceType: "org",
      nextToken: "2CMlB97VtVJWfoVliPIXPUQiEiE",
      maxResults: 50,
    });
    try {
      await client.listSpacesWithOptions(listSpacesRequest, listSpacesHeaders, new $Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.empty(err.code) && !Util.empty(err.message)) {
        // err contains code and message properties 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 by using a Token
         * @return Client
         * @throws Exception
         */
        public static AlibabaCloud.SDK.Dingtalkdrive_1_0.Client CreateClient()
        {
            AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config();
            config.Protocol = "https";
            config.RegionId = "central";
            return new AlibabaCloud.SDK.Dingtalkdrive_1_0.Client(config);
        }

        public static void Main(string[] args)
        {
            AlibabaCloud.SDK.Dingtalkdrive_1_0.Client client = CreateClient();
            AlibabaCloud.SDK.Dingtalkdrive_1_0.Models.ListSpacesHeaders listSpacesHeaders = new AlibabaCloud.SDK.Dingtalkdrive_1_0.Models.ListSpacesHeaders();
            listSpacesHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkdrive_1_0.Models.ListSpacesRequest listSpacesRequest = new AlibabaCloud.SDK.Dingtalkdrive_1_0.Models.ListSpacesRequest
            {
                UnionId = "sKUPRiijiSrqsuwqcPiSdbeNwiXxx",
                SpaceType = "org",
                NextToken = "2CMlB97VtVJWfoVliPIXPUQiEiE",
                MaxResults = 50,
            };
            try
            {
                client.ListSpacesWithOptions(listSpacesRequest, listSpacesHeaders, 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 properties 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 properties to help locate the issue
                }
            }
        }

    }
}

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

#include <alibabacloud/dingtalkdrive__1__0.hpp>
#include <alibabacloud/open_api.hpp>
#include <boost/any.hpp>
#include <darabonba/core.hpp>
#include <darabonba/util.hpp>
#include <iostream>
#include <map>

using namespace std;

Alibabacloud_Dingtalkdrive_1_0::Client createClient() {
  shared_ptr<Alibabacloud_OpenApi::Config> config = make_shared<Alibabacloud_OpenApi::Config>();
  config->protocol = make_shared<string>("https");
  config->regionId = make_shared<string>("central");
  return Alibabacloud_Dingtalkdrive_1_0::Client(config);
}

int main(int argc, char *args[]) {
  args;
  shared_ptr<Alibabacloud_Dingtalkdrive_1_0::Client> client = make_shared<Alibabacloud_Dingtalkdrive_1_0::Client>(createClient());
  shared_ptr<Alibabacloud_Dingtalkdrive_1_0::ListSpacesHeaders> listSpacesHeaders = make_shared<Alibabacloud_Dingtalkdrive_1_0::ListSpacesHeaders>();
  listSpacesHeaders->xAcsDingtalkAccessToken = make_shared<string>("<your access token>");
  shared_ptr<Alibabacloud_Dingtalkdrive_1_0::ListSpacesRequest> listSpacesRequest = make_shared<Alibabacloud_Dingtalkdrive_1_0::ListSpacesRequest>(map<string, boost::any>({
    {"unionId", boost::any(string("sKUPRiijiSrqsuwqcPiSdbeNwiXxx"))},
    {"spaceType", boost::any(string("org"))},
    {"nextToken", boost::any(string("2CMlB97VtVJWfoVliPIXPUQiEiE"))},
    {"maxResults", boost::any(50)}
  }));
  try {
    client->listSpacesWithOptions(listSpacesRequest, listSpacesHeaders, make_shared<Darabonba_Util::RuntimeOptions>(Darabonba_Util::RuntimeOptions()));
  }
  catch (std::exception &err) {
    if (!Darabonba_Util::Client::empty(err.code) && !Darabonba_Util::Client::empty(err.message)) {
      // err contains code and message properties to help locate the issue
    }
  }
}

Response

Response body

Name	Type	Description
spaces	Array	The list of spaces.
spaceId	String	The space ID.
spaceName	String	The space name.
spaceType	String	The space type. - personal: personal space - org: organization space
quota	Long	The total quota of the space. A value of -1 indicates that the space quota is unlimited. If the space is associated with an organization, the quota cannot exceed the organization’s space quota.
usedQuota	Long	The used quota of the space.
permissionMode	String	The authorization mode. Valid values: - acl: ACL authorization - custom: custom authorization
createTime	String	The created time.
modifyTime	String	The modified time.
nextToken	String	The cursor for the next page. An empty string indicates the end of pagination.

Response body example

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

{
  "spaces" : [ {
    "spaceId" : "123456789",
    "spaceName" : "Zhang San's Shared Folder",
    "spaceType" : "org",
    "quota" : 2147483648,
    "usedQuota" : 640445953,
    "permissionMode" : "acl",
    "createTime" : "2016-02-28T10:47:08Z",
    "modifyTime" : "2021-03-29T14:20:36Z"
  } ],
  "nextToken" : "fekaf"
}

Error codes

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

HttpCode	Error code	Error message	Description
400	param.error.maxresults	Too Large MaxResults	MaxResults is too large
400	param.error	Invalid Param	Parameter error
400	request.overlimit	You have sent too many requests.	Requests are too frequent
400	unsupported.operation	Does not support the operation	This operation is not supported
400	no.priviledge	You are not authorized to perform this operation.	You are not authorized to perform this action
500	unknown.error	Unknown Error	Unknown error

​Request

​Basic information

​Request headers

​Query parameters

​Request example

​Response

​Response body

​Response body example

​Error codes