> ## 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.

# Get a node by URL

> Call this API to retrieve the corresponding Knowledge Base node information by the operator's unionId and the document URL.

Call this API to get node information based on the operator's unionId and the document URL.

## Request

### Basic information

| Field                | Value                                                                                                    |
| -------------------- | -------------------------------------------------------------------------------------------------------- |
| HTTP URL             | [https://api.dingtalk.io/v2.0/wiki/nodes/queryByUrl](https://api.dingtalk.io/v2.0/wiki/nodes/queryByUrl) |
| HTTP Method          | POST                                                                                                     |
| Supported app types  | appType-Internal app　appType-Third-party enterprise app                                                  |
| Required permissions | permission-Wiki.Node.Read-Knowledge Base node read permission                                            |

### Request headers

| Name                        | Type   | Required | Description                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| --------------------------- | ------ | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| x-acs-dingtalk-access-token | String | Yes      | The access credential for calling this API. Obtain it as follows:   - For an internal app, call the [Get the access token of an internal app](/open/development/obtain-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](https://open.dingtalk.com/document/development/obtain-the-access-token-of-the-authorized-enterprise-1#) API. |

### Query parameters

| Name       | Type   | Required | Description                                                                                                            |
| ---------- | ------ | -------- | ---------------------------------------------------------------------------------------------------------------------- |
| operatorId | String | Yes      | The unionId of the operator. Obtain it by calling the [Query user details](/open/development/query-user-details#) API. |

### Request body

| Name                | Type    | Required | Description                                                                            |
| ------------------- | ------- | -------- | -------------------------------------------------------------------------------------- |
| url                 | String  | Yes      | The document URL.                                                                      |
| option              | Object  | No       | Optional parameters.                                                                   |
| withStatisticalInfo | Boolean | No       | Whether to return statistical information:   - **true**: Yes - **false** (default): No |
| withPermissionRole  | Boolean | No       | Whether to return permission information:   - **true**: Yes - **false** (default): No  |

### Request example

HTTP

```http theme={"theme":{"light":"github-light","dark":"github-dark"}}
POST /v2.0/wiki/nodes/queryByUrl?operatorId=tXguN309iPhE4roSKPlLURAiEiE HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:access_token
Content-Type:application/json

{
  "url" : "https://docs.dingtalk.io/i/nodes/EpGBa2L*********gN7R35y",
  "option" : {
    "withStatisticalInfo" : false,
    "withPermissionRole" : false
  }
}
```

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 {

    /**
     * Initialize the account Client using 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.GetNodeByUrlHeaders getNodeByUrlHeaders = new com.aliyun.dingtalkwiki_2_0.models.GetNodeByUrlHeaders();
        getNodeByUrlHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkwiki_2_0.models.GetNodeByUrlRequest.GetNodeByUrlRequestOption option = new com.aliyun.dingtalkwiki_2_0.models.GetNodeByUrlRequest.GetNodeByUrlRequestOption()
                .setWithStatisticalInfo(false)
                .setWithPermissionRole(false);
        com.aliyun.dingtalkwiki_2_0.models.GetNodeByUrlRequest getNodeByUrlRequest = new com.aliyun.dingtalkwiki_2_0.models.GetNodeByUrlRequest()
                .setOperatorId("tXguN309iPhE4roSKPlLURAiEiE")
                .setUrl("https://docs.dingtalk.io/i/nodes/EpGBa2L*********gN7R35y")
                .setOption(option);
        try {
            client.getNodeByUrlWithOptions(getNodeByUrlRequest, getNodeByUrlHeaders, 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 code and message properties to help locate 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 code and message properties to help locate the issue
            }

        }        
    }
}
```

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.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 using 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_node_by_url_headers = dingtalkwiki__2__0_models.GetNodeByUrlHeaders()
        get_node_by_url_headers.x_acs_dingtalk_access_token = '<your access token>'
        option = dingtalkwiki__2__0_models.GetNodeByUrlRequestOption(
            with_statistical_info=False,
            with_permission_role=False
        )
        get_node_by_url_request = dingtalkwiki__2__0_models.GetNodeByUrlRequest(
            operator_id='tXguN309iPhE4roSKPlLURAiEiE',
            url='https://docs.dingtalk.io/i/nodes/EpGBa2L*********gN7R35y',
            option=option
        )
        try:
            client.get_node_by_url_with_options(get_node_by_url_request, get_node_by_url_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err contains code and message properties to help locate the issue
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        get_node_by_url_headers = dingtalkwiki__2__0_models.GetNodeByUrlHeaders()
        get_node_by_url_headers.x_acs_dingtalk_access_token = '<your access token>'
        option = dingtalkwiki__2__0_models.GetNodeByUrlRequestOption(
            with_statistical_info=False,
            with_permission_role=False
        )
        get_node_by_url_request = dingtalkwiki__2__0_models.GetNodeByUrlRequest(
            operator_id='tXguN309iPhE4roSKPlLURAiEiE',
            url='https://docs.dingtalk.io/i/nodes/EpGBa2L*********gN7R35y',
            option=option
        )
        try:
            await client.get_node_by_url_with_options_async(get_node_by_url_request, get_node_by_url_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err contains code and message properties to help locate the issue
                pass

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

PHP

```java theme={"theme":{"light":"github-light","dark":"github-dark"}}
<?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\GetNodeByUrlHeaders;
use AlibabaCloud\SDK\Dingtalk\Vwiki_2_0\Models\GetNodeByUrlRequest\option;
use AlibabaCloud\SDK\Dingtalk\Vwiki_2_0\Models\GetNodeByUrlRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * Initialize the account Client using 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();
        $getNodeByUrlHeaders = new GetNodeByUrlHeaders([]);
        $getNodeByUrlHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $option = new option([
            "withStatisticalInfo" => false,
            "withPermissionRole" => false
        ]);
        $getNodeByUrlRequest = new GetNodeByUrlRequest([
            "operatorId" => "tXguN309iPhE4roSKPlLURAiEiE",
            "url" => "https://docs.dingtalk.io/i/nodes/EpGBa2L*********gN7R35y",
            "option" => $option
        ]);
        try {
            $client->getNodeByUrlWithOptions($getNodeByUrlRequest, $getNodeByUrlHeaders, 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 code and message properties to help locate 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

```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"
  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 using 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
  }

  getNodeByUrlHeaders := &dingtalkwiki_2_0.GetNodeByUrlHeaders{}
  getNodeByUrlHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  option := &dingtalkwiki_2_0.GetNodeByUrlRequestOption{
    WithStatisticalInfo: tea.Bool(false),
    WithPermissionRole: tea.Bool(false),
  }
  getNodeByUrlRequest := &dingtalkwiki_2_0.GetNodeByUrlRequest{
    OperatorId: tea.String("tXguN309iPhE4roSKPlLURAiEiE"),
    Url: tea.String("https://docs.dingtalk.io/i/nodes/EpGBa2L*********gN7R35y"),
    Option: option,
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.GetNodeByUrlWithOptions(getNodeByUrlRequest, getNodeByUrlHeaders, &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 code and message properties to help locate the issue
    }

  }
  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 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 using 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 getNodeByUrlHeaders = new $dingtalkwiki_2_0.GetNodeByUrlHeaders({ });
    getNodeByUrlHeaders.xAcsDingtalkAccessToken = "<your access token>";
    let option = new $dingtalkwiki_2_0.GetNodeByUrlRequestOption({
      withStatisticalInfo: false,
      withPermissionRole: false,
    });
    let getNodeByUrlRequest = new $dingtalkwiki_2_0.GetNodeByUrlRequest({
      operatorId: "tXguN309iPhE4roSKPlLURAiEiE",
      url: "https://docs.dingtalk.io/i/nodes/EpGBa2L*********gN7R35y",
      option: option,
    });
    try {
      await client.getNodeByUrlWithOptions(getNodeByUrlRequest, getNodeByUrlHeaders, new $Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.empty(err.code) && !Util.empty(err.message)) {
        // err contains code and message properties to help locate the issue
      }

    }    
  }

}

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 
    {

        /**
         * Initialize the account Client using 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.GetNodeByUrlHeaders getNodeByUrlHeaders = new AlibabaCloud.SDK.Dingtalkwiki_2_0.Models.GetNodeByUrlHeaders();
            getNodeByUrlHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkwiki_2_0.Models.GetNodeByUrlRequest.GetNodeByUrlRequestOption option = new AlibabaCloud.SDK.Dingtalkwiki_2_0.Models.GetNodeByUrlRequest.GetNodeByUrlRequestOption
            {
                WithStatisticalInfo = false,
                WithPermissionRole = false,
            };
            AlibabaCloud.SDK.Dingtalkwiki_2_0.Models.GetNodeByUrlRequest getNodeByUrlRequest = new AlibabaCloud.SDK.Dingtalkwiki_2_0.Models.GetNodeByUrlRequest
            {
                OperatorId = "tXguN309iPhE4roSKPlLURAiEiE",
                Url = "https://docs.dingtalk.io/i/nodes/EpGBa2L*********gN7R35y",
                Option = option,
            };
            try
            {
                client.GetNodeByUrlWithOptions(getNodeByUrlRequest, getNodeByUrlHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
            }
            catch (TeaException err)
            {
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // err contains code and message properties to help locate 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 code and message properties to help locate the issue
                }
            }
        }

    }
}
```

## Response

### Response body

| Name            | Type    | Description                                                                                                                                                                                                                                        |
| --------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| node            | Object  | The node.                                                                                                                                                                                                                                          |
| nodeId          | String  | The node ID (dentryUuid).                                                                                                                                                                                                                          |
| workspaceId     | String  | The Knowledge Base ID (spaceUuid).                                                                                                                                                                                                                 |
| name            | String  | The name.                                                                                                                                                                                                                                          |
| size            | Long    | The size.                                                                                                                                                                                                                                          |
| type            | String  | The type. Enum values:   - **FILE**: File - **FOLDER**: Folder                                                                                                                                                                                     |
| category        | String  | The category. Enum values:   - **ALIDOC**: DingTalk Docs - **DOCUMENT**: Local document - **IMAGE**: Image - **VIDEO**: Video - **AUDIO**: Audio - **ARCHIVE**: Archive file - **OTHER**: Other types                                              |
| extension       | String  | The file extension.                                                                                                                                                                                                                                |
| url             | String  | The access URL.                                                                                                                                                                                                                                    |
| creatorId       | String  | The userId of the creator.                                                                                                                                                                                                                         |
| modifierId      | String  | The userId of the modifier.                                                                                                                                                                                                                        |
| createTime      | String  | The created time.                                                                                                                                                                                                                                  |
| modifiedTime    | String  | The modified time.                                                                                                                                                                                                                                 |
| hasChildren     | Boolean | Whether the node has child nodes.                                                                                                                                                                                                                  |
| statisticalInfo | Object  | The statistical information.                                                                                                                                                                                                                       |
| wordCount       | Long    | The word count.                                                                                                                                                                                                                                    |
| permissionRole  | String  | The current user's permission role on the Knowledge Base node. Enum values:   - **OWNER**: Owner - **MANAGER**: Manager - **EDITOR**: Editor - **DOWNLOADER**: Viewer with download permission - **READER**: Viewer only - **NONE**: No permission |

### Response body example

```text theme={"theme":{"light":"github-light","dark":"github-dark"}}
HTTP/1.1 200 OK
Content-Type:application/json

{
  "node" : {
    "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 calling this API, find the solution in the [Global error codes](/open/development/server-api-error-codes-1) document based on the error message.

| HttpCode | Error code       | Error message | Description                                               |
| -------- | ---------------- | ------------- | --------------------------------------------------------- |
| 400      | paramError       | %s            | Parameter error                                           |
| 403      | permissionDenied | %s            | The current user does not have permission for this action |
| 404      | nodeNotExist     | %s            | The node does not exist                                   |
| 500      | systemError      | %s            | The service is busy. Try again later                      |
| 500      | unknownError     | Unknown Error | Unknown error                                             |
| 503      | operationTimeout | %s            | The request timed out                                     |