Skip to main content
Call this API to query multiple nodes in a batch.

Request

Basic information

FieldValue
HTTP URLhttps://api.dingtalk.io/v2.0/wiki/nodes/batchQuery
HTTP MethodPOST
Supported app typesappType-Internal app appType-Third-party enterprise app
Required permissionspermission-Wiki.Node.Read-Knowledge Base node read permission

Request headers

NameTypeRequiredDescription
x-acs-dingtalk-access-tokenStringYesThe access credential for calling this API. Obtain it as follows: - For an internal app, call the Get the access token of an internal app API. - For a third-party enterprise app, call the Get the access token of an enterprise authorized to a third-party app API.

Query parameters

NameTypeRequiredDescription
operatorIdStringYesThe unionId of the operator.

Request body

NameTypeRequiredDescription
nodeIdsArray of StringYesThe node IDs. The maximum size is 20.
optionObjectNoOptional parameters.
withStatisticalInfoBooleanNoWhether to retrieve statistical information: - true: Retrieve. - false: Do not retrieve. The default value is false.
withPermissionRoleBooleanNoWhether to retrieve permission information: - true: Retrieve. - false: Do not retrieve. The default value is false.

Request example

HTTP
POST /v2.0/wiki/nodes/batchQuery?operatorId=tXguN309iPhE4roSKPlLURAiEiE HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:access_token
Content-Type:application/json

{
  "nodeIds" : [ "a9E05BDRVQ9K600yf1NplNDxV63zgkYA" ],
  "option" : {
    "withStatisticalInfo" : false,
    "withPermissionRole" : false
  }
}
Java
// 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.GetNodesHeaders getNodesHeaders = new com.aliyun.dingtalkwiki_2_0.models.GetNodesHeaders();
        getNodesHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkwiki_2_0.models.GetNodesRequest.GetNodesRequestOption option = new com.aliyun.dingtalkwiki_2_0.models.GetNodesRequest.GetNodesRequestOption()
                .setWithStatisticalInfo(false)
                .setWithPermissionRole(false);
        com.aliyun.dingtalkwiki_2_0.models.GetNodesRequest getNodesRequest = new com.aliyun.dingtalkwiki_2_0.models.GetNodesRequest()
                .setOperatorId("tXguN309iPhE4roSKPlLURAiEiE")
                .setNodeIds(java.util.Arrays.asList(
                    "a9E05BDRVQ9K600yf1NplNDxV63zgkYA"
                ))
                .setOption(option);
        try {
            client.getNodesWithOptions(getNodesRequest, getNodesHeaders, 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 contains the code and message properties, which help diagnose the issue
            }

        } 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 contains the code and message properties, which help diagnose the issue
            }

        }        
    }
}
Python
# -*- 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_nodes_headers = dingtalkwiki__2__0_models.GetNodesHeaders()
        get_nodes_headers.x_acs_dingtalk_access_token = '<your access token>'
        option = dingtalkwiki__2__0_models.GetNodesRequestOption(
            with_statistical_info=False,
            with_permission_role=False
        )
        get_nodes_request = dingtalkwiki__2__0_models.GetNodesRequest(
            operator_id='tXguN309iPhE4roSKPlLURAiEiE',
            node_ids=[
                'a9E05BDRVQ9K600yf1NplNDxV63zgkYA'
            ],
            option=option
        )
        try:
            client.get_nodes_with_options(get_nodes_request, get_nodes_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err contains the code and message properties, which help diagnose the issue
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        get_nodes_headers = dingtalkwiki__2__0_models.GetNodesHeaders()
        get_nodes_headers.x_acs_dingtalk_access_token = '<your access token>'
        option = dingtalkwiki__2__0_models.GetNodesRequestOption(
            with_statistical_info=False,
            with_permission_role=False
        )
        get_nodes_request = dingtalkwiki__2__0_models.GetNodesRequest(
            operator_id='tXguN309iPhE4roSKPlLURAiEiE',
            node_ids=[
                'a9E05BDRVQ9K600yf1NplNDxV63zgkYA'
            ],
            option=option
        )
        try:
            await client.get_nodes_with_options_async(get_nodes_request, get_nodes_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err contains the code and message properties, which help diagnose the issue
                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\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\GetNodesHeaders;
use AlibabaCloud\SDK\Dingtalk\Vwiki_2_0\Models\GetNodesRequest\option;
use AlibabaCloud\SDK\Dingtalk\Vwiki_2_0\Models\GetNodesRequest;
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();
        $getNodesHeaders = new GetNodesHeaders([]);
        $getNodesHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $option = new option([
            "withStatisticalInfo" => false,
            "withPermissionRole" => false
        ]);
        $getNodesRequest = new GetNodesRequest([
            "operatorId" => "tXguN309iPhE4roSKPlLURAiEiE",
            "nodeIds" => [
                "a9E05BDRVQ9K600yf1NplNDxV63zgkYA"
            ],
            "option" => $option
        ]);
        try {
            $client->getNodesWithOptions($getNodesRequest, $getNodesHeaders, 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 contains the code and message properties, which help diagnose the issue
            }
        }
    }
}
$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
// 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
  }

  getNodesHeaders := &dingtalkwiki_2_0.GetNodesHeaders{}
  getNodesHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  option := &dingtalkwiki_2_0.GetNodesRequestOption{
    WithStatisticalInfo: tea.Bool(false),
    WithPermissionRole: tea.Bool(false),
  }
  getNodesRequest := &dingtalkwiki_2_0.GetNodesRequest{
    OperatorId: tea.String("tXguN309iPhE4roSKPlLURAiEiE"),
    NodeIds: []*string{tea.String("a9E05BDRVQ9K600yf1NplNDxV63zgkYA")},
    Option: option,
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.GetNodesWithOptions(getNodesRequest, getNodesHeaders, &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 contains the code and message properties, which help diagnose the issue
    }

  }
  return _err
}

func main() {
  err := _main(tea.StringSlice(os.Args[1:]))
  if err != nil {
    panic(err)
  }
}
Node.js
// 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 getNodesHeaders = new $dingtalkwiki_2_0.GetNodesHeaders({ });
    getNodesHeaders.xAcsDingtalkAccessToken = "<your access token>";
    let option = new $dingtalkwiki_2_0.GetNodesRequestOption({
      withStatisticalInfo: false,
      withPermissionRole: false,
    });
    let getNodesRequest = new $dingtalkwiki_2_0.GetNodesRequest({
      operatorId: "tXguN309iPhE4roSKPlLURAiEiE",
      nodeIds: [
        "a9E05BDRVQ9K600yf1NplNDxV63zgkYA"
      ],
      option: option,
    });
    try {
      await client.getNodesWithOptions(getNodesRequest, getNodesHeaders, new $Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.empty(err.code) && !Util.empty(err.message)) {
        // err contains the code and message properties, which help diagnose the issue
      }

    }    
  }

}

Client.main(process.argv.slice(2));
C#
// 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.GetNodesHeaders getNodesHeaders = new AlibabaCloud.SDK.Dingtalkwiki_2_0.Models.GetNodesHeaders();
            getNodesHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkwiki_2_0.Models.GetNodesRequest.GetNodesRequestOption option = new AlibabaCloud.SDK.Dingtalkwiki_2_0.Models.GetNodesRequest.GetNodesRequestOption
            {
                WithStatisticalInfo = false,
                WithPermissionRole = false,
            };
            AlibabaCloud.SDK.Dingtalkwiki_2_0.Models.GetNodesRequest getNodesRequest = new AlibabaCloud.SDK.Dingtalkwiki_2_0.Models.GetNodesRequest
            {
                OperatorId = "tXguN309iPhE4roSKPlLURAiEiE",
                NodeIds = new List<string>
                {
                    "a9E05BDRVQ9K600yf1NplNDxV63zgkYA"
                },
                Option = option,
            };
            try
            {
                client.GetNodesWithOptions(getNodesRequest, getNodesHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
            }
            catch (TeaException err)
            {
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // err contains the code and message properties, which help diagnose the issue
                }
            }
            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 contains the code and message properties, which help diagnose the issue
                }
            }
        }

    }
}

Response

Response body

NameTypeDescription
nodesArrayThe list of nodes.
nodeIdStringThe node ID (dentryUuid).
workspaceIdStringThe Knowledge Base ID (spaceUuid).
nameStringThe name.
sizeLongThe size.
typeStringThe type. Enum values: - FILE: File. - FOLDER: Folder.
categoryStringThe category. Enum values: - ALIDOC: DingTalk Docs. - DOCUMENT: Local document. - IMAGE: Image. - VIDEO: Video. - AUDIO: Audio. - ARCHIVE: Archive file. - OTHER: Other type.
extensionStringThe file extension.
urlStringThe access URL.
creatorIdStringThe userId of the creator.
modifierIdStringThe userId of the modifier.
createTimeStringThe created time.
modifiedTimeStringThe modified time.
hasChildrenBooleanWhether the node has child nodes.
statisticalInfoObjectThe statistical information.
wordCountLongThe word count.
permissionRoleStringThe current user’s permission role for the Knowledge Base node. Enum values: - OWNER: Owner. - MANAGER: Manager. - EDITOR: Editor. - DOWNLOADER: Viewer with download permission. - READER: View-only. - NONE: No permissions.

Response body example

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

{
  "nodes" : [ {
    "nodeId" : "EpGBa2Lm8aRmzkkNhplMx1prWgN7R35y",
    "workspaceId" : "By8jQS1ZYjGn5b0M",
    "name" : "node_name",
    "size" : 512,
    "type" : "FILE",
    "category" : "ALIDOC",
    "extension" : "adoc",
    "url" : "node_url",
    "creatorId" : "01472825524039877041",
    "modifierId" : "01472825524039877041",
    "createTime" : "2023-05-15T11:29Z",
    "modifiedTime" : "2023-05-15T11:29Z",
    "hasChildren" : false,
    "statisticalInfo" : {
      "wordCount" : 123
    },
    "permissionRole" : "READER"
  } ]
}

Error codes

If an error occurs when you call this API, look up the solution in the Global error codes document based on the error message.
HttpCodeError codeError messageDescription
400paramError%sParameter error.
403permissionDenied%sThe current user does not have permission to perform this action.
500systemError%sThe service is busy. Try again later.
500unknownErrorUnknown ErrorUnknown error.
503operationTimeout%sThe request timed out.