批量获取节点 - DingTalk Help Center

调用本接口，批量获取节点。

请求

基本信息

字段	值
HTTP URL	https://api.dingtalk.io/v2.0/wiki/nodes/batchQuery
HTTP Method	POST
支持的应用类型	appType-企业内部应用　appType-第三方企业应用
权限要求	permission-Wiki.Node.Read-知识库节点读权限

请求头

名称	类型	是否必填	描述
x-acs-dingtalk-access-token	String	是	调用该接口的访问凭证，通过以下获取： - 企业内部应用，调用获取企业内部应用的accessToken接口获取。 - 第三方企业应用，调用获取第三方应用授权企业的accessToken接口获取。

查询参数

名称	类型	是否必填	描述
operatorId	String	是	操作人unionId。

请求体

名称	类型	是否必填	描述
nodeIds	Array of String	是	节点id。最大size20。
option	Object	否	可选参数。
withStatisticalInfo	Boolean	否	是否获取统计信息： - true：获取 - false：不获取默认值false。
withPermissionRole	Boolean	否	是否获取权限信息： - true：获取 - false：不获取默认值false。

请求示例

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 {

    /**
     * 使用 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<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 中含有 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

# -*- 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_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 中含有 code 和 message 属性，可帮助开发定位问题
                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 中含有 code 和 message 属性，可帮助开发定位问题
                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 {

    /**
     * 使用 Token 初始化账号Client
     * @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 中含有 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));

// 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
  }

  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 中含有 code 和 message 属性，可帮助开发定位问题
    }

  }
  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 {

  /**
   * 使用 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<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 中含有 code 和 message 属性，可帮助开发定位问题
      }

    }    
  }

}

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 
    {

        /**
         * 使用 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.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 中含有 code 和 message 属性，可帮助开发定位问题
                }
            }
            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 中含有 code 和 message 属性，可帮助开发定位问题
                }
            }
        }

    }
}

响应

响应体

名称	类型	描述
nodes	Array	节点列表。
nodeId	String	节点id(dentryUuid)。
workspaceId	String	知识库id(spaceUuid)。
name	String	名称。
size	Long	大小。
type	String	类型，枚举值： - FILE：文件 - FOLDER：文件夹
category	String	类别，枚举值: - ALIDOC：钉钉文档 - DOCUMENT：本地文档 - IMAGE：图片 - VIDEO：视频 - AUDIO：音频 - ARCHIVE：归档文件 - OTHER：其他类型
extension	String	后缀。
url	String	访问url。
creatorId	String	创建者userId。
modifierId	String	修改者userId。
createTime	String	创建时间。
modifiedTime	String	修改时间。
hasChildren	Boolean	是否有子节点。
statisticalInfo	Object	统计信息。
wordCount	Long	字数。
permissionRole	String	当前用户对知识库节点的权限角色，枚举值: - OWNER：拥有者 - MANAGER：管理者 - EDITOR：编辑者 - DOWNLOADER：可查看下载者 - READER：仅可查看者 - NONE：无权限者

响应体示例

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"
  } ]
}

错误码

若调用该接口报错，可根据错误信息在全局错误码文档中查找解决方案。

HttpCode	错误码	错误信息	说明
400	paramError	%s	参数错误
403	permissionDenied	%s	当前用户无此操作权限
500	systemError	%s	服务繁忙，请稍后重试
500	unknownError	Unknown Error	未知错误
503	operationTimeout	%s	请求超时

​请求

​基本信息

​请求头

​查询参数

​请求体

​请求示例

​响应

​响应体

​响应体示例

​错误码

请求

基本信息

请求头

查询参数

请求体

请求示例

响应

响应体

响应体示例

错误码