Permintaan
Informasi dasar
| Bidang | Nilai |
|---|---|
| URL HTTP | https://api.dingtalk.io/v2.0/wiki/mineWorkspaces |
| Metode HTTP | GET |
| Tipe aplikasi yang didukung | appType-Aplikasi internal appType-Aplikasi perusahaan pihak ketiga |
| Izin yang diperlukan | permission-Wiki.Workspace.Read-Izin baca 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 Mendapatkan access token aplikasi internal. - Untuk aplikasi perusahaan pihak ketiga, panggil API Mendapatkan access token organisasi yang mengizinkan aplikasi pihak ketiga. |
Parameter query
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| operatorId | String | Ya | unionId dari operator. |
Contoh permintaan
HTTPGET /v2.0/wiki/mineWorkspaces?operatorId=tXguN309iPhE4roSKPlLURAiEiE HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:access_token
Content-Type:application/json
// 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.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<String> args = java.util.Arrays.asList(args_);
com.aliyun.dingtalkwiki_2_0.Client client = Sample.createClient();
com.aliyun.dingtalkwiki_2_0.models.GetMineWorkspaceHeaders getMineWorkspaceHeaders = new com.aliyun.dingtalkwiki_2_0.models.GetMineWorkspaceHeaders();
getMineWorkspaceHeaders.xAcsDingtalkAccessToken = "<your access token>";
com.aliyun.dingtalkwiki_2_0.models.GetMineWorkspaceRequest getMineWorkspaceRequest = new com.aliyun.dingtalkwiki_2_0.models.GetMineWorkspaceRequest()
.setOperatorId("tXguN309iPhE4roSKPlLURAiEiE");
try {
client.getMineWorkspaceWithOptions(getMineWorkspaceRequest, getMineWorkspaceHeaders, 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 untuk membantu menemukan 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 untuk membantu menemukan masalah
}
}
}
}
# -*- 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:
"""
Initialize the account Client with a Token
@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_mine_workspace_headers = dingtalkwiki__2__0_models.GetMineWorkspaceHeaders()
get_mine_workspace_headers.x_acs_dingtalk_access_token = '<your access token>'
get_mine_workspace_request = dingtalkwiki__2__0_models.GetMineWorkspaceRequest(
operator_id='tXguN309iPhE4roSKPlLURAiEiE'
)
try:
client.get_mine_workspace_with_options(get_mine_workspace_request, get_mine_workspace_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 untuk membantu menemukan masalah
pass
@staticmethod
async def main_async(
args: List[str],
) -> None:
client = Sample.create_client()
get_mine_workspace_headers = dingtalkwiki__2__0_models.GetMineWorkspaceHeaders()
get_mine_workspace_headers.x_acs_dingtalk_access_token = '<your access token>'
get_mine_workspace_request = dingtalkwiki__2__0_models.GetMineWorkspaceRequest(
operator_id='tXguN309iPhE4roSKPlLURAiEiE'
)
try:
await client.get_mine_workspace_with_options_async(get_mine_workspace_request, get_mine_workspace_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 untuk membantu menemukan masalah
pass
if __name__ == '__main__':
Sample.main(sys.argv[1:])
<?php
// This file is auto-generated, don't edit it. Thanks.
namespace AlibabaCloud\SDK\Sample;
use AlibabaCloud\SDK\Dingtalk\Vwiki_2_0\Dingtalk;
use \Exception;
use AlibabaCloud\Tea\Exception\TeaError;
use AlibabaCloud\Tea\Utils\Utils;
use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\SDK\Dingtalk\Vwiki_2_0\Models\GetMineWorkspaceHeaders;
use AlibabaCloud\SDK\Dingtalk\Vwiki_2_0\Models\GetMineWorkspaceRequest;
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();
$getMineWorkspaceHeaders = new GetMineWorkspaceHeaders([]);
$getMineWorkspaceHeaders->xAcsDingtalkAccessToken = "<your access token>";
$getMineWorkspaceRequest = new GetMineWorkspaceRequest([
"operatorId" => "tXguN309iPhE4roSKPlLURAiEiE"
]);
try {
$client->getMineWorkspaceWithOptions($getMineWorkspaceRequest, $getMineWorkspaceHeaders, 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 untuk membantu menemukan 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));
// 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"
)
/**
* Initialize the account Client with a Token
* @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
}
getMineWorkspaceHeaders := &dingtalkwiki_2_0.GetMineWorkspaceHeaders{}
getMineWorkspaceHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
getMineWorkspaceRequest := &dingtalkwiki_2_0.GetMineWorkspaceRequest{
OperatorId: tea.String("tXguN309iPhE4roSKPlLURAiEiE"),
}
tryErr := func()(_e error) {
defer func() {
if r := tea.Recover(recover()); r != nil {
_e = r
}
}()
_, _err = client.GetMineWorkspaceWithOptions(getMineWorkspaceRequest, getMineWorkspaceHeaders, &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 untuk membantu menemukan masalah
}
}
return _err
}
func main() {
err := _main(tea.StringSlice(os.Args[1:]))
if err != nil {
panic(err)
}
}
// 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 {
/**
* Initialize the account Client with a Token
* @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<void> {
let client = Client.createClient();
let getMineWorkspaceHeaders = new $dingtalkwiki_2_0.GetMineWorkspaceHeaders({ });
getMineWorkspaceHeaders.xAcsDingtalkAccessToken = "<your access token>";
let getMineWorkspaceRequest = new $dingtalkwiki_2_0.GetMineWorkspaceRequest({
operatorId: "tXguN309iPhE4roSKPlLURAiEiE",
});
try {
await client.getMineWorkspaceWithOptions(getMineWorkspaceRequest, getMineWorkspaceHeaders, new $Util.RuntimeOptions({ }));
} catch (err) {
if (!Util.empty(err.code) && !Util.empty(err.message)) {
// err berisi atribut code dan message untuk membantu menemukan masalah
}
}
}
}
Client.main(process.argv.slice(2));
// 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.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.GetMineWorkspaceHeaders getMineWorkspaceHeaders = new AlibabaCloud.SDK.Dingtalkwiki_2_0.Models.GetMineWorkspaceHeaders();
getMineWorkspaceHeaders.XAcsDingtalkAccessToken = "<your access token>";
AlibabaCloud.SDK.Dingtalkwiki_2_0.Models.GetMineWorkspaceRequest getMineWorkspaceRequest = new AlibabaCloud.SDK.Dingtalkwiki_2_0.Models.GetMineWorkspaceRequest
{
OperatorId = "tXguN309iPhE4roSKPlLURAiEiE",
};
try
{
client.GetMineWorkspaceWithOptions(getMineWorkspaceRequest, getMineWorkspaceHeaders, 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 untuk membantu menemukan 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 untuk membantu menemukan masalah
}
}
}
}
}
Respons
Isi respons
| Nama | Tipe | Deskripsi |
|---|---|---|
| workspace | Object | Knowledge Base. |
| workspaceId | String | ID Knowledge Base (spaceUuid). |
| corpId | String | ID organisasi tempat Knowledge Base berada. |
| teamId | String | ID Grup Pengetahuan tempat Knowledge Base berada. Kosong jika Knowledge Base tidak termasuk dalam Grup Pengetahuan mana pun. |
| rootNodeId | String | ID node root (root dentryUuid). |
| name | String | Nama Knowledge Base. |
| type | String | Tipe Knowledge Base. Nilai enum: - TEAM: Knowledge Base - PERSONAL: Dokumen Saya |
| description | String | Deskripsi Knowledge Base. |
| url | String | URL untuk mengakses Knowledge Base. |
| icon | Object | Ikon Knowledge Base. |
| type | String | Tipe ikon. Nilai enum: - URL: tautan - EMOJI: ikon emoji |
| value | String | Nilai ikon: - Ketika type adalah URL, mengembalikan tautan ikon. - Ketika type adalah EMOJI, mengembalikan nilai Unicode dari ikon emoji. |
| cover | String | URL sampul Knowledge Base. |
| creatorId | String | userId pembuat Knowledge Base. |
| modifierId | String | userId pihak yang memodifikasi Knowledge Base. |
| createTime | String | Waktu pembuatan Knowledge Base. |
| modifiedTime | String | Waktu modifikasi Knowledge Base. |
| permissionRole | String | Peran izin operator pada Knowledge Base. Nilai enum: - OWNER: Pemilik - MANAGER: Manajer - EDITOR: Editor - DOWNLOADER: Penampil dengan izin unduh - READER: Hanya tampilan - NONE: Tanpa izin |
Contoh isi respons
HTTP/1.1 200 OK
Content-Type:application/json
{
"workspace" : {
"workspaceId" : "9r09jSO3WARyxd8A",
"corpId" : "ding16b241fd05********288",
"teamId" : "lHiicjNFM2iSFYSdz2iPuI8ZwiEiE",
"rootNodeId" : "MNDoBb60VLBPraakI1Ywxyyn8lemrZQ3",
"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"
}
}
Kode error
Jika terjadi error saat Anda memanggil API ini, temukan solusinya di dokumen Kode error global berdasarkan pesan error.| HttpCode | Kode error | Pesan error | Deskripsi |
|---|---|---|---|
| 400 | paramError | %s | Error parameter. |
| 403 | permissionDenied | %s | Pengguna saat ini tidak memiliki izin untuk tindakan ini. |
| 500 | systemError | %s | Layanan sedang sibuk. Coba lagi nanti. |
| 500 | unknownError | Unknown Error | Error tidak dikenal. |
| 503 | operationTimeout | %s | Permintaan habis waktu. |