Skip to main content
Call this API to retrieve the organization’s storage information. For example, the storage space is 100 GB and 953.5 MB has been used.

Request

Basic information

FieldValue
HTTP URLhttps://api.dingtalk.io/v1.0/storage/orgs/{corpId}
HTTP MethodGET
Supported app typesappType-Internal app appType-Third-party enterprise app
Required permissionspermission-Storage.Org.Read-Organization storage read permission

Request headers

NameTypeRequiredDescription
x-acs-dingtalk-access-tokenStringYesThe access credential used to call 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

NameTypeRequiredDescription
corpIdStringYesThe organization ID.

Query parameters

NameTypeRequiredDescription
unionIdStringYesThe unionId of the user. Call the Query user details API to obtain it.

Request example

HTTP
GET /v1.0/storage/orgs/ding123xxxxx?unionId=cHtUYxxxxx 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.GetOrgHeaders getOrgHeaders = new com.aliyun.dingtalkstorage_1_0.models.GetOrgHeaders();
        getOrgHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkstorage_1_0.models.GetOrgRequest getOrgRequest = new com.aliyun.dingtalkstorage_1_0.models.GetOrgRequest()
                .setUnionId("cHtUYxxxxx");
        try {
            client.getOrgWithOptions("ding123xxxxx", getOrgRequest, getOrgHeaders, 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_org_headers = dingtalkstorage__1__0_models.GetOrgHeaders()
        get_org_headers.x_acs_dingtalk_access_token = '<your access token>'
        get_org_request = dingtalkstorage__1__0_models.GetOrgRequest(
            union_id='cHtUYxxxxx'
        )
        try:
            client.get_org_with_options('ding123xxxxx', get_org_request, get_org_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_org_headers = dingtalkstorage__1__0_models.GetOrgHeaders()
        get_org_headers.x_acs_dingtalk_access_token = '<your access token>'
        get_org_request = dingtalkstorage__1__0_models.GetOrgRequest(
            union_id='cHtUYxxxxx'
        )
        try:
            await client.get_org_with_options_async('ding123xxxxx', get_org_request, get_org_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\GetOrgHeaders;
use AlibabaCloud\SDK\Dingtalk\Vstorage_1_0\Models\GetOrgRequest;
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();
        $getOrgHeaders = new GetOrgHeaders([]);
        $getOrgHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $getOrgRequest = new GetOrgRequest([
            "unionId" => "cHtUYxxxxx"
        ]);
        try {
            $client->getOrgWithOptions("ding123xxxxx", $getOrgRequest, $getOrgHeaders, 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));
Go
// 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
  }

  getOrgHeaders := &dingtalkstorage_1_0.GetOrgHeaders{}
  getOrgHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  getOrgRequest := &dingtalkstorage_1_0.GetOrgRequest{
    UnionId: tea.String("cHtUYxxxxx"),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.GetOrgWithOptions(tea.String("ding123xxxxx"), getOrgRequest, getOrgHeaders, &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 getOrgHeaders = new $dingtalkstorage_1_0.GetOrgHeaders({ });
    getOrgHeaders.xAcsDingtalkAccessToken = "<your access token>";
    let getOrgRequest = new $dingtalkstorage_1_0.GetOrgRequest({
      unionId: "cHtUYxxxxx",
    });
    try {
      await client.getOrgWithOptions("ding123xxxxx", getOrgRequest, getOrgHeaders, 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));
C#
// 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.GetOrgHeaders getOrgHeaders = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.GetOrgHeaders();
            getOrgHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.GetOrgRequest getOrgRequest = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.GetOrgRequest
            {
                UnionId = "cHtUYxxxxx",
            };
            try
            {
                client.GetOrgWithOptions("ding123xxxxx", getOrgRequest, getOrgHeaders, 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_org_headers = dingtalkstorage__1__0_models.GetOrgHeaders()
        get_org_headers.x_acs_dingtalk_access_token = '<your access token>'
        get_org_request = dingtalkstorage__1__0_models.GetOrgRequest(
            union_id='cHtUYxxxxx'
        )
        try:
            client.get_org_with_options('ding123xxxxx', get_org_request, get_org_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 getOrgHeaders: AlibabacloudDingtalkstorage10.GetOrgHeaders = AlibabacloudDingtalkstorage10.GetOrgHeaders([:])
        getOrgHeaders.xAcsDingtalkAccessToken = "<your access token>"
        var getOrgRequest: AlibabacloudDingtalkstorage10.GetOrgRequest = AlibabacloudDingtalkstorage10.GetOrgRequest([
            "unionId": "cHtUYxxxxx"
        ])
        do {
            try await client.getOrgWithOptions("ding123xxxxx", getOrgRequest as! AlibabacloudDingtalkstorage10.GetOrgRequest, getOrgHeaders as! AlibabacloudDingtalkstorage10.GetOrgHeaders, 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

NameTypeDescription
orgObjectThe organization information.
corpIdStringThe organization ID.
partitionsArrayThe list of partition capacity information.
partitionTypeStringThe partition type. - PUBLIC_OSS_PARTITION: Public Cloud OSS storage partition. - MINI_OSS_PARTITION: Dedicated MiniOSS storage partition.
quotaObjectThe capacity information.
usedLongThe used capacity, in bytes.
maxLongThe maximum capacity, in bytes.
reservedLongThe remaining pre-allocated capacity, in bytes. You can pre-allocate capacity to an app or space in the admin console. This field indicates the remaining pre-allocated capacity, that is, the unused portion of the pre-allocated capacity. If no pre-allocated capacity is configured, this field is empty.
typeStringThe capacity type. - SHARE: Shared organization capacity. - PRIVATE: Dedicated capacity.

Response body example

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

{
  "org" : {
    "corpId" : "ding123xxxxx",
    "partitions" : [ {
      "partitionType" : "PUBLIC_OSS_PARTITION",
      "quota" : {
        "used" : 1024,
        "max" : 1048576,
        "reserved" : 1000,
        "type" : "PRIVATE"
      }
    } ]
  }
}

Error codes

If an error is returned when you call this API, refer to the Global error codes document for solutions based on the error message.
HttpCodeError codeError messageDescription
400paramError%sParameter error.
403permissionDenied%sThe user does not have permission to obtain organization information.
500systemError%sSystem error.
500unknownErrorUnknown ErrorUnknown error.
503operationTimeout%sRequest timed out.