Cari Knowledge Base

Panggil API ini untuk mencari informasi Knowledge Base berdasarkan unionId operator dan kata kunci.

Permintaan

Informasi dasar

Bidang	Nilai
URL HTTP	https://api.dingtalk.io/v2.0/storage/workspaces/search
Metode HTTP	POST
Tipe aplikasi yang didukung	appType-Aplikasi internal　appType-Aplikasi perusahaan pihak ketiga
Izin yang diperlukan	permission-Wiki.Workspace.Search-Izin pencarian Knowledge Base

Header permintaan

Nama	Tipe	Wajib	Deskripsi
x-acs-dingtalk-access-token	String	Ya	Kredensial akses untuk memanggil API ini. Dapatkan dengan cara berikut: - Untuk aplikasi internal, panggil API Dapatkan access token aplikasi internal. - Untuk aplikasi perusahaan pihak ketiga, panggil API Dapatkan access token organisasi yang mengizinkan aplikasi pihak ketiga.

Parameter query

Nama	Tipe	Wajib	Deskripsi
operatorId	String	Ya	unionId operator.

Isi permintaan

Nama	Tipe	Wajib	Deskripsi
keyword	String	Ya	Kata kunci pencarian.
option	Object	Tidak	Parameter opsional.
nextToken	String	Tidak	Cursor paginasi. Kosongkan untuk permintaan pertama.
maxResults	Integer	Tidak	Ukuran halaman. Nilai default: 20. Nilai maksimum: 20.

Contoh permintaan

HTTP

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

// File ini dibuat otomatis, jangan diedit. Terima kasih.
package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * Inisialisasi Client akun menggunakan Token
     * @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<String> 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 = "<your access token>";
        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 berisi atribut code dan message yang membantu pemecahan masalah
            }

        } 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 berisi atribut code dan message yang membantu pemecahan masalah
            }

        }        
    }
}

Python

# -*- coding: utf-8 -*-
# File ini dibuat otomatis, jangan diedit. Terima kasih.
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:
        """
        Inisialisasi Client akun menggunakan Token
        @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 = '<your 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 berisi atribut code dan message yang membantu pemecahan masalah
                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 = '<your 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 berisi atribut code dan message yang membantu pemecahan masalah
                pass

if __name__ == '__main__':
    Sample.main(sys.argv[1:])

PHP

<?php

// File ini dibuat otomatis, jangan diedit. Terima kasih.
namespace AlibabaCloud\SDK\Sample;

use AlibabaCloud\SDK\Dingtalk\Vstorage_2_0\Dingtalk;
use \Exception;
use AlibabaCloud\Tea\Exception\TeaError;
use AlibabaCloud\Tea\Utils\Utils;

use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\SDK\Dingtalk\Vstorage_2_0\Models\SearchWorkspacesHeaders;
use AlibabaCloud\SDK\Dingtalk\Vstorage_2_0\Models\SearchWorkspacesRequest\option;
use AlibabaCloud\SDK\Dingtalk\Vstorage_2_0\Models\SearchWorkspacesRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * Inisialisasi Client akun menggunakan 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();
        $searchWorkspacesHeaders = new SearchWorkspacesHeaders([]);
        $searchWorkspacesHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $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 berisi atribut code dan message yang membantu pemecahan masalah
            }
        }
    }
}
$path = __DIR__ . \DIRECTORY_SEPARATOR . '..' . \DIRECTORY_SEPARATOR . 'vendor' . \DIRECTORY_SEPARATOR . 'autoload.php';
if (file_exists($path)) {
    require_once $path;
}
Sample::main(array_slice($argv, 1));

// File ini dibuat otomatis, jangan diedit. Terima kasih.
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"
)

/**
 * Inisialisasi Client akun menggunakan Token
 * @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("<your access token>")
  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 berisi atribut code dan message yang membantu pemecahan masalah
    }

  }
  return _err
}

func main() {
  err := _main(tea.StringSlice(os.Args[1:]))
  if err != nil {
    panic(err)
  }
}

Node.js

// File ini dibuat otomatis, jangan diedit
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 {

  /**
   * Inisialisasi Client akun menggunakan Token
   * @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<void> {
    let client = Client.createClient();
    let searchWorkspacesHeaders = new $dingtalkstorage_2_0.SearchWorkspacesHeaders({ });
    searchWorkspacesHeaders.xAcsDingtalkAccessToken = "<your access token>";
    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 berisi atribut code dan message yang membantu pemecahan masalah
      }

    }    
  }

}

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

// File ini dibuat otomatis, jangan diedit. Terima kasih.

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 
    {

        /**
         * Inisialisasi Client akun menggunakan Token
         * @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 = "<your access token>";
            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 berisi atribut code dan message yang membantu pemecahan masalah
                }
            }
            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 berisi atribut code dan message yang membantu pemecahan masalah
                }
            }
        }

    }
}

Respons

Isi respons

Nama	Tipe	Deskripsi
items	Array	Daftar hasil pencarian. Ukuran maksimum: 20.
workspaceId	String	ID Knowledge Base (spaceUuid).
name	String	Nama Knowledge Base.
url	String	URL akses Knowledge Base.
nextToken	String	Cursor paginasi. Nilai yang tidak kosong menandakan masih ada data lain yang tersedia.

Contoh isi respons

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

{
  "items" : [ {
    "workspaceId" : "By8jQS1ZYjGn5b0M",
    "name" : "workspace_name",
    "url" : "workspace_url"
  } ],
  "nextToken" : "next_token"
}

Kode error

Jika terjadi error saat memanggil API ini, cari pesan error dalam dokumen Kode error global untuk solusinya.

HttpCode	Kode error	Pesan error	Deskripsi
400	paramError	%s	Error parameter
400	paramError-keyword	%s	Error parameter - keyword
400	paramError.maxResults	%s	Error parameter - maxResults
500	systemError	%s	Layanan sedang sibuk. Coba lagi nanti.
500	unknownError	Unknown Error	Error tidak diketahui
503	operationTimeout	%s	Permintaan melebihi batas waktu

Panduan pemanggilan API

Autentikasi & otorisasi

Kontak

Kalender

Konferensi

AI Table

Dokumen & file

IM

Permintaan

Informasi dasar

Header permintaan

Parameter query

Isi permintaan

Contoh permintaan

Respons

Isi respons

Contoh isi respons

Kode error

​Permintaan

​Informasi dasar

​Header permintaan

​Parameter query

​Isi permintaan

​Contoh permintaan

​Respons

​Isi respons

​Contoh isi respons

​Kode error

Permintaan

Informasi dasar

Header permintaan

Parameter query

Isi permintaan

Contoh permintaan

Respons

Isi respons

Contoh isi respons

Kode error