> ## Documentation Index > Fetch the complete documentation index at: https://help.dingtalk.io/llms.txt > Use this file to discover all available pages before exploring further. # 批量获取知识库 > 调用本接口通过 workspaceIds、option、withPermissionRole 等参数批量获取知识库信息。 用于批量获取知识库。调用时通过 POST 请求提交 workspaceIds、option、withPermissionRole 等业务字段。 ## 请求 ### 基本信息 | 字段 | 值 | | ----------- | ------------------------------------------------------------------------------------------------------------------ | | HTTP URL | [https://api.dingtalk.io/v2.0/wiki/workspaces/batchQuery](https://api.dingtalk.io/v2.0/wiki/workspaces/batchQuery) | | HTTP Method | POST | | 支持的应用类型 | appType-企业内部应用　appType-第三方企业应用 | | 权限要求 | permission-Wiki.Workspace.Read-知识库读权限 | ### 请求头 | 名称 | 类型 | 是否必填 | 描述 | | --------------------------- | ------ | ---- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | x-acs-dingtalk-access-token | String | 是 | 调用该接口的访问凭证，通过以下获取： - 企业内部应用，调用[获取企业内部应用的accessToken](/zh/open/development/obtain-the-access-token-of-an-internal-app#)接口获取。 - 第三方企业应用，调用[获取第三方应用授权企业的accessToken](https://open.dingtalk.com/document/development/obtain-the-access-token-of-the-authorized-enterprise-1#)接口获取。 | ### 查询参数 | 名称 | 类型 | 是否必填 | 描述 | | ---------- | ------ | ---- | ----------- | | operatorId | String | 是 | 操作人unionId。 | ### 请求体 | 名称 | 类型 | 是否必填 | 描述 | | ------------------ | --------------- | ---- | ------------------------------------------------------------------------------------------------------- | | workspaceIds | Array of String | 是 | 知识库id，可通过调用[获取知识库列表](/zh/open/development/get-knowledge-base-list#)接口，获取返回参数`workspaceId`字段。 最大size20。 | | option | Object | 否 | 可选参数 | | withPermissionRole | Boolean | 否 | 是否获取权限信息： - **true**：获取 - **false**：不获取 默认值false。 | ### 请求示例 HTTP ```http theme={"theme":{"light":"github-light","dark":"github-dark"}} POST /v2.0/wiki/workspaces/batchQuery?operatorId=tXguN309iPhE4roSKPlLURAiEiE HTTP/1.1 Host:api.dingtalk.io x-acs-dingtalk-access-token:access_token Content-Type:application/json { "workspaceIds" : [ "9r09jSO3WARyxd8A" ], "option" : { "withPermissionRole" : false } } ``` Java ```java theme={"theme":{"light":"github-light","dark":"github-dark"}} // This file is auto-generated, don't edit it. Thanks. package com.aliyun.sample; import com.aliyun.tea.*; public class Sample { /** * 使用 Token 初始化账号Client * @return Client * @throws Exception */ public static com.aliyun.dingtalkwiki_2_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.dingtalkwiki_2_0.Client(config); } public static void main(String[] args_) throws Exception { java.util.List args = java.util.Arrays.asList(args_); com.aliyun.dingtalkwiki_2_0.Client client = Sample.createClient(); com.aliyun.dingtalkwiki_2_0.models.GetWorkspacesHeaders getWorkspacesHeaders = new com.aliyun.dingtalkwiki_2_0.models.GetWorkspacesHeaders(); getWorkspacesHeaders.xAcsDingtalkAccessToken = ""; com.aliyun.dingtalkwiki_2_0.models.GetWorkspacesRequest.GetWorkspacesRequestOption option = new com.aliyun.dingtalkwiki_2_0.models.GetWorkspacesRequest.GetWorkspacesRequestOption() .setWithPermissionRole(false); com.aliyun.dingtalkwiki_2_0.models.GetWorkspacesRequest getWorkspacesRequest = new com.aliyun.dingtalkwiki_2_0.models.GetWorkspacesRequest() .setOperatorId("tXguN309iPhE4roSKPlLURAiEiE") .setWorkspaceIds(java.util.Arrays.asList( "9r09jSO3WARyxd8A" )) .setOption(option); try { client.getWorkspacesWithOptions(getWorkspacesRequest, getWorkspacesHeaders, 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 ```python theme={"theme":{"light":"github-light","dark":"github-dark"}} # -*- coding: utf-8 -*- # This file is auto-generated, don't edit it. Thanks. import sys from typing import List from alibabacloud_dingtalk.wiki_2_0.client import Client as dingtalkwiki_2_0Client from alibabacloud_tea_openapi import models as open_api_models from alibabacloud_dingtalk.wiki_2_0 import models as dingtalkwiki__2__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() -> dingtalkwiki_2_0Client: """ 使用 Token 初始化账号Client @return: Client @throws Exception """ config = open_api_models.Config() config.protocol = 'https' config.region_id = 'central' return dingtalkwiki_2_0Client(config) @staticmethod def main( args: List[str], ) -> None: client = Sample.create_client() get_workspaces_headers = dingtalkwiki__2__0_models.GetWorkspacesHeaders() get_workspaces_headers.x_acs_dingtalk_access_token = '' option = dingtalkwiki__2__0_models.GetWorkspacesRequestOption( with_permission_role=False ) get_workspaces_request = dingtalkwiki__2__0_models.GetWorkspacesRequest( operator_id='tXguN309iPhE4roSKPlLURAiEiE', workspace_ids=[ '9r09jSO3WARyxd8A' ], option=option ) try: client.get_workspaces_with_options(get_workspaces_request, get_workspaces_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() get_workspaces_headers = dingtalkwiki__2__0_models.GetWorkspacesHeaders() get_workspaces_headers.x_acs_dingtalk_access_token = '' option = dingtalkwiki__2__0_models.GetWorkspacesRequestOption( with_permission_role=False ) get_workspaces_request = dingtalkwiki__2__0_models.GetWorkspacesRequest( operator_id='tXguN309iPhE4roSKPlLURAiEiE', workspace_ids=[ '9r09jSO3WARyxd8A' ], option=option ) try: await client.get_workspaces_with_options_async(get_workspaces_request, get_workspaces_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 ```java theme={"theme":{"light":"github-light","dark":"github-dark"}} protocol = "https"; $config->regionId = "central"; return new Dingtalk($config); } /** * @param string[] $args * @return void */ public static function main($args){ $client = self::createClient(); $getWorkspacesHeaders = new GetWorkspacesHeaders([]); $getWorkspacesHeaders->xAcsDingtalkAccessToken = ""; $option = new option([ "withPermissionRole" => false ]); $getWorkspacesRequest = new GetWorkspacesRequest([ "operatorId" => "tXguN309iPhE4roSKPlLURAiEiE", "workspaceIds" => [ "9r09jSO3WARyxd8A" ], "option" => $option ]); try { $client->getWorkspacesWithOptions($getWorkspacesRequest, $getWorkspacesHeaders, 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)); ``` Go ```go theme={"theme":{"light":"github-light","dark":"github-dark"}} // This file is auto-generated, don't edit it. Thanks. package main import ( "os" util "github.com/alibabacloud-go/tea-utils/v2/service" dingtalkwiki_2_0 "github.com/alibabacloud-go/dingtalk/wiki_2_0" openapi "github.com/alibabacloud-go/darabonba-openapi/v2/client" "github.com/alibabacloud-go/tea/tea" ) /** * 使用 Token 初始化账号Client * @return Client * @throws Exception */ func CreateClient () (_result *dingtalkwiki_2_0.Client, _err error) { config := &openapi.Config{} config.Protocol = tea.String("https") config.RegionId = tea.String("central") _result = &dingtalkwiki_2_0.Client{} _result, _err = dingtalkwiki_2_0.NewClient(config) return _result, _err } func _main (args []*string) (_err error) { client, _err := CreateClient() if _err != nil { return _err } getWorkspacesHeaders := &dingtalkwiki_2_0.GetWorkspacesHeaders{} getWorkspacesHeaders.XAcsDingtalkAccessToken = tea.String("") option := &dingtalkwiki_2_0.GetWorkspacesRequestOption{ WithPermissionRole: tea.Bool(false), } getWorkspacesRequest := &dingtalkwiki_2_0.GetWorkspacesRequest{ OperatorId: tea.String("tXguN309iPhE4roSKPlLURAiEiE"), WorkspaceIds: []*string{tea.String("9r09jSO3WARyxd8A")}, Option: option, } tryErr := func()(_e error) { defer func() { if r := tea.Recover(recover()); r != nil { _e = r } }() _, _err = client.GetWorkspacesWithOptions(getWorkspacesRequest, getWorkspacesHeaders, &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 ```python theme={"theme":{"light":"github-light","dark":"github-dark"}} // This file is auto-generated, don't edit it import Util, * as $Util from '@alicloud/tea-util'; import dingtalkwiki_2_0, * as $dingtalkwiki_2_0 from '@alicloud/dingtalk/wiki_2_0'; import OpenApi, * as $OpenApi from '@alicloud/openapi-client'; import * as $tea from '@alicloud/tea-typescript'; export default class Client { /** * 使用 Token 初始化账号Client * @return Client * @throws Exception */ static createClient(): dingtalkwiki_2_0 { let config = new $OpenApi.Config({ }); config.protocol = "https"; config.regionId = "central"; return new dingtalkwiki_2_0(config); } static async main(args: string[]): Promise { let client = Client.createClient(); let getWorkspacesHeaders = new $dingtalkwiki_2_0.GetWorkspacesHeaders({ }); getWorkspacesHeaders.xAcsDingtalkAccessToken = ""; let option = new $dingtalkwiki_2_0.GetWorkspacesRequestOption({ withPermissionRole: false, }); let getWorkspacesRequest = new $dingtalkwiki_2_0.GetWorkspacesRequest({ operatorId: "tXguN309iPhE4roSKPlLURAiEiE", workspaceIds: [ "9r09jSO3WARyxd8A" ], option: option, }); try { await client.getWorkspacesWithOptions(getWorkspacesRequest, getWorkspacesHeaders, new $Util.RuntimeOptions({ })); } catch (err) { if (!Util.empty(err.code) && !Util.empty(err.message)) { // err 中含有 code 和 message 属性，可帮助开发定位问题 } } } } Client.main(process.argv.slice(2)); ``` C# ```java theme={"theme":{"light":"github-light","dark":"github-dark"}} // 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 { /** * 使用 Token 初始化账号Client * @return Client * @throws Exception */ public static AlibabaCloud.SDK.Dingtalkwiki_2_0.Client CreateClient() { AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config(); config.Protocol = "https"; config.RegionId = "central"; return new AlibabaCloud.SDK.Dingtalkwiki_2_0.Client(config); } public static void Main(string[] args) { AlibabaCloud.SDK.Dingtalkwiki_2_0.Client client = CreateClient(); AlibabaCloud.SDK.Dingtalkwiki_2_0.Models.GetWorkspacesHeaders getWorkspacesHeaders = new AlibabaCloud.SDK.Dingtalkwiki_2_0.Models.GetWorkspacesHeaders(); getWorkspacesHeaders.XAcsDingtalkAccessToken = ""; AlibabaCloud.SDK.Dingtalkwiki_2_0.Models.GetWorkspacesRequest.GetWorkspacesRequestOption option = new AlibabaCloud.SDK.Dingtalkwiki_2_0.Models.GetWorkspacesRequest.GetWorkspacesRequestOption { WithPermissionRole = false, }; AlibabaCloud.SDK.Dingtalkwiki_2_0.Models.GetWorkspacesRequest getWorkspacesRequest = new AlibabaCloud.SDK.Dingtalkwiki_2_0.Models.GetWorkspacesRequest { OperatorId = "tXguN309iPhE4roSKPlLURAiEiE", WorkspaceIds = new List { "9r09jSO3WARyxd8A" }, Option = option, }; try { client.GetWorkspacesWithOptions(getWorkspacesRequest, getWorkspacesHeaders, 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 { { "message", _err.Message } }); if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message)) { // err 中含有 code 和 message 属性，可帮助开发定位问题 } } } } } ``` ## 响应 ### 响应体 | 名称 | 类型 | 描述 | | -------------- | ------ | --------------------------------------------------------------------------------------------------------------------------------- | | workspaces | Array | 知识库列表。 | | workspaceId | String | 知识库id(spaceUuid)。 | | corpId | String | 知识库归属企业的corpId。 | | teamId | String | 知识库归属知识小组的id。 不归属任何知识小组的时候, 返回空。 | | rootNodeId | String | 根节点id(根节点dentryUuid)。 | | name | String | 知识库名称。 | | type | String | 知识库类型，枚举值: - **TEAM**：知识库 - **PERSONAL**：我的文档 | | description | String | 知识库简介。 | | url | String | 知识库访问url。 | | icon | Object | 知识库图标。 | | type | String | 图标类型，枚举值: - **URL**：链接 - **EMOJI**：emoji图标 | | value | String | 图标值： - 当 type 为 URL 时，返回图标链接。 - 当 type 为 EMOJI 时，返回 emoji 图标的 unicode 值。 | | cover | String | 知识库封面url。 | | creatorId | String | 知识库创建者userId。 | | modifierId | String | 知识库修改者userId。 | | createTime | String | 知识库创建时间。 | | modifiedTime | String | 知识库修改时间。 | | permissionRole | String | 查询人对知识库的权限角色，枚举值: - **OWNER**：拥有者 - **MANAGER**：管理者 - **EDITOR**：编辑者 - **DOWNLOADER**：可查看下载者 - **READER**：仅可查看者 - **NONE**：无权限者 | ### 响应体示例 ```text theme={"theme":{"light":"github-light","dark":"github-dark"}} HTTP/1.1 200 OK Content-Type:application/json { "workspaces" : [ { "workspaceId" : "By8jQS1ZYjGn5b0M", "corpId" : "ding16b241fd05********288", "teamId" : "lHiicjNFM2iSFYSdz2iPuI8ZwiEiE", "rootNodeId" : "ZgpG2NdyVXXjrKKzIBqMp5zkVMwvDqPk", "name" : "workspace_name", "type" : "TEAM", "description" : "workspace_description", "url" : "workspace_url", "icon" : { "type" : "URL", "value" : "https://example/file-manage-files/zh-CN/202***13/ldet/avatar3.jpg" }, "cover" : "https://example/file-manage-files/zh-CN/202***13/ldet/XXXX.jpg", "creatorId" : "01472825524039877041", "modifierId" : "01472825524039877041", "createTime" : "2023-05-15T11:29Z", "modifiedTime" : "2023-05-15T11:29Z", "permissionRole" : "READER" } ] } ``` ### 错误码 若调用该接口报错，可根据错误信息在[全局错误码](/zh/open/development/server-api-error-codes-1)文档中查找解决方案。 | HttpCode | 错误码 | 错误信息 | 说明 | | -------- | ----------------- | ------------- | ---------- | | 400 | paramError | %s | 参数错误 | | 403 | permissionDenied | %s | 当前用户无此操作权限 | | 404 | workspaceNotExist | %s | 知识库不存在 | | 500 | systemError | %s | 服务繁忙，请稍后重试 | | 500 | unknownError | Unknown Error | 未知错误 | | 503 | operationTimeout | %s | 请求超时 |