spaceId を指定してスペース情報を取得する

リクエスト

基本情報

フィールド	値
HTTP URL	https://api.dingtalk.io/v1.0/drive/managements/spaces/query
HTTP Method	POST
対応アプリタイプ	appType-社内アプリ　appType-サードパーティ社内アプリ
必要な権限	permission-Drive.SpaceManage.Read-ドライブアプリスペース管理情報の読み取り権限

リクエストヘッダー

名前	タイプ	必須	説明
x-acs-dingtalk-access-token	String	はい	本インターフェース呼び出しのアクセス認証情報です。以下の方法で取得します。 - 社内アプリの場合は、社内アプリの accessToken を取得するインターフェースを呼び出して取得します。 - サードパーティ社内アプリの場合は、サードパーティアプリで権限付与された企業の accessToken を取得するインターフェースを呼び出して取得します。

リクエストボディ

名前	タイプ	必須	説明
spaceIds	Array of String	はい	スペース ID のリスト。最大 30 件まで指定可能です。スペースリストを取得するインターフェースを呼び出して取得できます。
unionId	String	はい	ユーザーの unionId。ユーザー詳細を照会するインターフェースを呼び出して取得できます。

リクエスト例

HTTP

POST /v1.0/drive/managements/spaces/query HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:2db66caxxxx
Content-Type:application/json

{
  "spaceIds" : [ "123" ],
  "unionId" : "sKUPRiijxxxxx"
}

Java

package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * <b>description</b> :
     * <p>Token を使用してアカウント Client を初期化します</p>
     * @return Client
     * 
     * @throws Exception
     */
    public static com.aliyun.dingtalkdrive_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.dingtalkdrive_1_0.Client(config);
    }

    public static void main(String[] args_) throws Exception {
        
        com.aliyun.dingtalkdrive_1_0.Client client = Sample.createClient();
        com.aliyun.dingtalkdrive_1_0.models.ManagementListSpacesHeaders managementListSpacesHeaders = new com.aliyun.dingtalkdrive_1_0.models.ManagementListSpacesHeaders();
        managementListSpacesHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkdrive_1_0.models.ManagementListSpacesRequest managementListSpacesRequest = new com.aliyun.dingtalkdrive_1_0.models.ManagementListSpacesRequest()
                .setSpaceIds(java.util.Arrays.asList(
                    "123"
                ))
                .setUnionId("sKUPRiijxxxxx");
        try {
            client.managementListSpacesWithOptions(managementListSpacesRequest, managementListSpacesHeaders, 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 には 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 属性が含まれており、開発時の問題特定に役立ちます
            }

        }        
    }
}

Python

# -*- coding: utf-8 -*-
# This file is auto-generated, don't edit it. Thanks.
import os
import sys
import json

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:
        """
        Token を使用してアカウント Client を初期化します
        @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()
        management_list_spaces_headers = dingtalkdrive__1__0_models.ManagementListSpacesHeaders()
        management_list_spaces_headers.x_acs_dingtalk_access_token = '<your access token>'
        management_list_spaces_request = dingtalkdrive__1__0_models.ManagementListSpacesRequest(
            space_ids=[
                '123'
            ],
            union_id='sKUPRiijxxxxx'
        )
        try:
            client.management_list_spaces_with_options(management_list_spaces_request, management_list_spaces_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()
        management_list_spaces_headers = dingtalkdrive__1__0_models.ManagementListSpacesHeaders()
        management_list_spaces_headers.x_acs_dingtalk_access_token = '<your access token>'
        management_list_spaces_request = dingtalkdrive__1__0_models.ManagementListSpacesRequest(
            space_ids=[
                '123'
            ],
            union_id='sKUPRiijxxxxx'
        )
        try:
            await client.management_list_spaces_with_options_async(management_list_spaces_request, management_list_spaces_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

<?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\ManagementListSpacesHeaders;
use AlibabaCloud\SDK\Dingtalk\Vdrive_1_0\Models\ManagementListSpacesRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * Token を使用してアカウント 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();
        $managementListSpacesHeaders = new ManagementListSpacesHeaders([]);
        $managementListSpacesHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $managementListSpacesRequest = new ManagementListSpacesRequest([
            "spaceIds" => [
                "123"
            ],
            "unionId" => "sKUPRiijxxxxx"
        ]);
        try {
            $client->managementListSpacesWithOptions($managementListSpacesRequest, $managementListSpacesHeaders, 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));

package main

import (
  "encoding/json"
  "strings"
  "fmt"
  "os"
  util  "github.com/alibabacloud-go/tea-utils/v2/service"
  dingtalkdrive_1_0  "github.com/alibabacloud-go/dingtalk/drive_1_0"
  openapi  "github.com/alibabacloud-go/darabonba-openapi/v2/client"
  "github.com/alibabacloud-go/tea/tea"
)

// Description:
// 
// Token を使用してアカウント Client を初期化します
// 
// @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
  }

  managementListSpacesHeaders := &dingtalkdrive_1_0.ManagementListSpacesHeaders{}
  managementListSpacesHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  managementListSpacesRequest := &dingtalkdrive_1_0.ManagementListSpacesRequest{
    SpaceIds: []*string{tea.String("123")},
    UnionId: tea.String("sKUPRiijxxxxx"),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.ManagementListSpacesWithOptions(managementListSpacesRequest, managementListSpacesHeaders, &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)
  }
}

Node.js

'use strict';
// This file is auto-generated, don't edit it
const Util = require('@alicloud/tea-util');
const dingtalkdrive_1_0 = require('@alicloud/dingtalk/drive_1_0');
const OpenApi = require('@alicloud/openapi-client');
const Tea = require('@alicloud/tea-typescript');

class Client {

  /**
   * Token を使用してアカウント Client を初期化します
   * @return Client
   * @throws Exception
   */
  static createClient() {
    let config = new OpenApi.Config({ });
    config.protocol = 'https';
    config.regionId = 'central';
    return new dingtalkdrive_1_0.default(config);
  }

  static async main(args) {
    let client = Client.createClient();
    let managementListSpacesHeaders = new dingtalkdrive_1_0.ManagementListSpacesHeaders({ });
    managementListSpacesHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let managementListSpacesRequest = new dingtalkdrive_1_0.ManagementListSpacesRequest({
      spaceIds: [
        '123'
      ],
      unionId: 'sKUPRiijxxxxx',
    });
    try {
      await client.managementListSpacesWithOptions(managementListSpacesRequest, managementListSpacesHeaders, new Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.default.empty(err.code) && !Util.default.empty(err.message)) {
        // err には code と message 属性が含まれており、開発時の問題特定に役立ちます
      }

    }    
  }

}

exports.Client = Client;
Client.main(process.argv.slice(2));

using Newtonsoft.Json;
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 
    {

        /// <term><b>Description:</b></term>
        /// <description>
        /// <para>Token を使用してアカウント Client を初期化します</para>
        /// </description>
        /// 
        /// <returns>
        /// Client
        /// </returns>
        /// 
        /// <term><b>Exception:</b></term>
        /// 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.ManagementListSpacesHeaders managementListSpacesHeaders = new AlibabaCloud.SDK.Dingtalkdrive_1_0.Models.ManagementListSpacesHeaders();
            managementListSpacesHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkdrive_1_0.Models.ManagementListSpacesRequest managementListSpacesRequest = new AlibabaCloud.SDK.Dingtalkdrive_1_0.Models.ManagementListSpacesRequest
            {
                SpaceIds = new List<string>
                {
                    "123"
                },
                UnionId = "sKUPRiijxxxxx",
            };
            try
            {
                client.ManagementListSpacesWithOptions(managementListSpacesRequest, managementListSpacesHeaders, 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 属性が含まれており、開発時の問題特定に役立ちます
                }
            }
        }

    }
}

レスポンス

レスポンスボディ

名前	タイプ	説明
spaces	Array	スペースのリスト。
spaceId	String	スペース ID。
spaceName	String	スペース名。
spaceType	String	スペースのタイプ。 - personal：個人スペース - org：企業スペース
quota	Long	スペースの総容量。 - -1：スペースの容量が無制限であることを示します。企業属性がある場合、企業スペースの容量を超えることはできません。
usedQuota	Long	スペースの使用済み容量。
permissionMode	String	権限レベル。値は以下のとおりです。 - acl：acl 権限付与 - custom：カスタム権限付与
createTime	String	作成時間。ISO8601 形式（例：2022-07-29T14:55Z）。
modifyTime	String	編集時間。ISO8601 形式（例：2022-07-29T14:55Z）。

レスポンスボディの例

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

{
  "spaces" : [ {
    "spaceId" : "123456789",
    "spaceName" : "山田太郎の共有フォルダ",
    "spaceType" : "org",
    "quota" : 2147483648,
    "usedQuota" : 640445953,
    "permissionMode" : "acl",
    "createTime" : "2016-02-28T10:47:08Z",
    "modifyTime" : "2021-03-29T14:20:36Z"
  } ]
}

エラーコード

本インターフェースの呼び出しでエラーが発生した場合は、エラーメッセージをもとにグローバルエラーコードドキュメントで解決方法を検索してください。

HttpCode	エラーコード	エラーメッセージ	説明
400	param.error	Invalid Param	パラメータエラー
500	request.overlimit	You have sent too many requests.	リクエストが頻繁すぎます
500	unsupported.operation	Does not support the operation	この操作には対応していません
500	no.priviledge	You are not authorized to perform this operation.	この操作を行う権限がありません
500	unknown.error	Unknown Error	不明なエラー

API 呼び出しガイド

認証と認可

連絡先

カレンダー

会議

AI Table

Docs とファイル

IM

spaceId を指定してスペース情報を取得する

spaceId を指定してスペース情報を取得する

リクエスト

基本情報

リクエストヘッダー

リクエストボディ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディの例

エラーコード

​spaceId を指定してスペース情報を取得する

​リクエスト

​基本情報

​リクエストヘッダー

​リクエストボディ

​リクエスト例

​レスポンス

​レスポンスボディ

​レスポンスボディの例

​エラーコード

spaceId を指定してスペース情報を取得する

リクエスト

基本情報

リクエストヘッダー

リクエストボディ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディの例

エラーコード