> ## 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. # ナレッジベースの検索 > ナレッジベースをキーワード検索し、ページネーション対応で結果を取得します 本インターフェースを呼び出すことで、操作者の unionId とキーワード情報に基づいてナレッジベース情報を検索します。 ## リクエスト ### 基本情報 | フィールド | 値 | | ------------ | ---------------------------------------------------------------------------------------------------------------- | | HTTP URL | [https://api.dingtalk.io/v2.0/storage/workspaces/search](https://api.dingtalk.io/v2.0/storage/workspaces/search) | | HTTP Method | POST | | サポートするアプリタイプ | appType-社内アプリ　appType-サードパーティ社内アプリ | | 必要な権限 | permission-Wiki.Workspace.Search-ナレッジベース検索権限 | ### リクエストヘッダー | 名前 | タイプ | 必須 | 説明 | | --------------------------- | ------ | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | x-acs-dingtalk-access-token | String | 必須 | 本インターフェースを呼び出すためのアクセス認証情報。以下の方法で取得します。 - 社内アプリの場合、[社内アプリの accessToken を取得する](/ja/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。 | ### リクエストボディ | 名前 | タイプ | 必須 | 説明 | | ---------- | ------- | -- | -------------------------------- | | keyword | String | 必須 | 検索キーワード。 | | option | Object | 任意 | オプションパラメータ。 | | nextToken | String | 任意 | ページネーションカーソル。 初回取得時は指定不要です。 | | maxResults | Integer | 任意 | ページサイズ。デフォルトは 20。 最大値は 20。 | ### リクエスト例 HTTP ```http theme={"theme":{"light":"github-light","dark":"github-dark"}} POST /v2.0/storage/workspaces/search?operatorId=tXguN309iPhE4roSKPlLURAiEiE HTTP/1.1 Host:api.dingtalk.io x-acs-dingtalk-access-token:access_token Content-Type:application/json { "keyword" : "keyword", "option" : { "nextToken" : "next_token", "maxResults" : 20 } } ``` 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 { /** * トークンを使用してアカウント Client を初期化します * @return Client * @throws Exception */ public static com.aliyun.dingtalkstorage_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.dingtalkstorage_2_0.Client(config); } public static void main(String[] args_) throws Exception { java.util.List args = java.util.Arrays.asList(args_); com.aliyun.dingtalkstorage_2_0.Client client = Sample.createClient(); com.aliyun.dingtalkstorage_2_0.models.SearchWorkspacesHeaders searchWorkspacesHeaders = new com.aliyun.dingtalkstorage_2_0.models.SearchWorkspacesHeaders(); searchWorkspacesHeaders.xAcsDingtalkAccessToken = ""; com.aliyun.dingtalkstorage_2_0.models.SearchWorkspacesRequest.SearchWorkspacesRequestOption option = new com.aliyun.dingtalkstorage_2_0.models.SearchWorkspacesRequest.SearchWorkspacesRequestOption() .setNextToken("next_token") .setMaxResults(20); com.aliyun.dingtalkstorage_2_0.models.SearchWorkspacesRequest searchWorkspacesRequest = new com.aliyun.dingtalkstorage_2_0.models.SearchWorkspacesRequest() .setOperatorId("tXguN309iPhE4roSKPlLURAiEiE") .setKeyword("keyword") .setOption(option); try { client.searchWorkspacesWithOptions(searchWorkspacesRequest, searchWorkspacesHeaders, 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.storage_2_0.client import Client as dingtalkstorage_2_0Client from alibabacloud_tea_openapi import models as open_api_models from alibabacloud_dingtalk.storage_2_0 import models as dingtalkstorage__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() -> dingtalkstorage_2_0Client: """ トークンを使用してアカウント Client を初期化します @return: Client @throws Exception """ config = open_api_models.Config() config.protocol = 'https' config.region_id = 'central' return dingtalkstorage_2_0Client(config) @staticmethod def main( args: List[str], ) -> None: client = Sample.create_client() search_workspaces_headers = dingtalkstorage__2__0_models.SearchWorkspacesHeaders() search_workspaces_headers.x_acs_dingtalk_access_token = '' option = dingtalkstorage__2__0_models.SearchWorkspacesRequestOption( next_token='next_token', max_results=20 ) search_workspaces_request = dingtalkstorage__2__0_models.SearchWorkspacesRequest( operator_id='tXguN309iPhE4roSKPlLURAiEiE', keyword='keyword', option=option ) try: client.search_workspaces_with_options(search_workspaces_request, search_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() search_workspaces_headers = dingtalkstorage__2__0_models.SearchWorkspacesHeaders() search_workspaces_headers.x_acs_dingtalk_access_token = '' option = dingtalkstorage__2__0_models.SearchWorkspacesRequestOption( next_token='next_token', max_results=20 ) search_workspaces_request = dingtalkstorage__2__0_models.SearchWorkspacesRequest( operator_id='tXguN309iPhE4roSKPlLURAiEiE', keyword='keyword', option=option ) try: await client.search_workspaces_with_options_async(search_workspaces_request, search_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(); $searchWorkspacesHeaders = new SearchWorkspacesHeaders([]); $searchWorkspacesHeaders->xAcsDingtalkAccessToken = ""; $option = new option([ "nextToken" => "next_token", "maxResults" => 20 ]); $searchWorkspacesRequest = new SearchWorkspacesRequest([ "operatorId" => "tXguN309iPhE4roSKPlLURAiEiE", "keyword" => "keyword", "option" => $option ]); try { $client->searchWorkspacesWithOptions($searchWorkspacesRequest, $searchWorkspacesHeaders, 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" dingtalkstorage_2_0 "github.com/alibabacloud-go/dingtalk/storage_2_0" openapi "github.com/alibabacloud-go/darabonba-openapi/v2/client" "github.com/alibabacloud-go/tea/tea" ) /** * トークンを使用してアカウント Client を初期化します * @return Client * @throws Exception */ func CreateClient () (_result *dingtalkstorage_2_0.Client, _err error) { config := &openapi.Config{} config.Protocol = tea.String("https") config.RegionId = tea.String("central") _result = &dingtalkstorage_2_0.Client{} _result, _err = dingtalkstorage_2_0.NewClient(config) return _result, _err } func _main (args []*string) (_err error) { client, _err := CreateClient() if _err != nil { return _err } searchWorkspacesHeaders := &dingtalkstorage_2_0.SearchWorkspacesHeaders{} searchWorkspacesHeaders.XAcsDingtalkAccessToken = tea.String("") option := &dingtalkstorage_2_0.SearchWorkspacesRequestOption{ NextToken: tea.String("next_token"), MaxResults: tea.Int32(20), } searchWorkspacesRequest := &dingtalkstorage_2_0.SearchWorkspacesRequest{ OperatorId: tea.String("tXguN309iPhE4roSKPlLURAiEiE"), Keyword: tea.String("keyword"), Option: option, } tryErr := func()(_e error) { defer func() { if r := tea.Recover(recover()); r != nil { _e = r } }() _, _err = client.SearchWorkspacesWithOptions(searchWorkspacesRequest, searchWorkspacesHeaders, &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 dingtalkstorage_2_0, * as $dingtalkstorage_2_0 from '@alicloud/dingtalk/storage_2_0'; import OpenApi, * as $OpenApi from '@alicloud/openapi-client'; import * as $tea from '@alicloud/tea-typescript'; export default class Client { /** * トークンを使用してアカウント Client を初期化します * @return Client * @throws Exception */ static createClient(): dingtalkstorage_2_0 { let config = new $OpenApi.Config({ }); config.protocol = "https"; config.regionId = "central"; return new dingtalkstorage_2_0(config); } static async main(args: string[]): Promise { let client = Client.createClient(); let searchWorkspacesHeaders = new $dingtalkstorage_2_0.SearchWorkspacesHeaders({ }); searchWorkspacesHeaders.xAcsDingtalkAccessToken = ""; let option = new $dingtalkstorage_2_0.SearchWorkspacesRequestOption({ nextToken: "next_token", maxResults: 20, }); let searchWorkspacesRequest = new $dingtalkstorage_2_0.SearchWorkspacesRequest({ operatorId: "tXguN309iPhE4roSKPlLURAiEiE", keyword: "keyword", option: option, }); try { await client.searchWorkspacesWithOptions(searchWorkspacesRequest, searchWorkspacesHeaders, 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 { /** * トークンを使用してアカウント Client を初期化します * @return Client * @throws Exception */ public static AlibabaCloud.SDK.Dingtalkstorage_2_0.Client CreateClient() { AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config(); config.Protocol = "https"; config.RegionId = "central"; return new AlibabaCloud.SDK.Dingtalkstorage_2_0.Client(config); } public static void Main(string[] args) { AlibabaCloud.SDK.Dingtalkstorage_2_0.Client client = CreateClient(); AlibabaCloud.SDK.Dingtalkstorage_2_0.Models.SearchWorkspacesHeaders searchWorkspacesHeaders = new AlibabaCloud.SDK.Dingtalkstorage_2_0.Models.SearchWorkspacesHeaders(); searchWorkspacesHeaders.XAcsDingtalkAccessToken = ""; AlibabaCloud.SDK.Dingtalkstorage_2_0.Models.SearchWorkspacesRequest.SearchWorkspacesRequestOption option = new AlibabaCloud.SDK.Dingtalkstorage_2_0.Models.SearchWorkspacesRequest.SearchWorkspacesRequestOption { NextToken = "next_token", MaxResults = 20, }; AlibabaCloud.SDK.Dingtalkstorage_2_0.Models.SearchWorkspacesRequest searchWorkspacesRequest = new AlibabaCloud.SDK.Dingtalkstorage_2_0.Models.SearchWorkspacesRequest { OperatorId = "tXguN309iPhE4roSKPlLURAiEiE", Keyword = "keyword", Option = option, }; try { client.SearchWorkspacesWithOptions(searchWorkspacesRequest, searchWorkspacesHeaders, 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 属性が含まれており、開発時の問題特定に役立ちます } } } } } ``` ## レスポンス ### レスポンスボディ | 名前 | タイプ | 説明 | | ----------- | ------ | ------------------------------------------- | | items | Array | 検索結果リスト。最大サイズは 20。 | | workspaceId | String | ナレッジベース ID (spaceUuid)。 | | name | String | ナレッジベース名。 | | url | String | ナレッジベースのアクセス URL。 | | nextToken | String | ページネーションカーソル。 空でない場合はさらにデータがあることを示します。 | ### レスポンスボディ例 ```text theme={"theme":{"light":"github-light","dark":"github-dark"}} HTTP/1.1 200 OK Content-Type:application/json { "items" : [ { "workspaceId" : "By8jQS1ZYjGn5b0M", "name" : "workspace_name", "url" : "workspace_url" } ], "nextToken" : "next_token" } ``` ### エラーコード 本インターフェースを呼び出してエラーが発生した場合は、エラーメッセージをもとに [グローバルエラーコード](/ja/open/development/server-api-error-codes-1) ドキュメントから解決策を検索してください。 | HttpCode | エラーコード | エラーメッセージ | 説明 | | -------- | --------------------- | ------------- | ------------------------ | | 400 | paramError | %s | パラメータエラー | | 400 | paramError-keyword | %s | パラメータエラー - keyword | | 400 | paramError.maxResults | %s | パラメータエラー - maxResults | | 500 | systemError | %s | サービスが混雑しています。後で再試行してください | | 500 | unknownError | Unknown Error | 不明なエラー | | 503 | operationTimeout | %s | リクエストタイムアウト |