文档首页/ 数据治理中心 DataArts Studio/ API参考/ 数据目录API/ 数据地图接口/ 空间资产目录树(邀测)
更新时间：2025-08-01 GMT+08:00
在线调试
CLI示例
查看PDF
分享

空间资产目录树(邀测)

功能介绍

获取某空间下资产目录树信息。

调用方法

请参见如何调用API。

URI

GET /v2/{project_id}/datamap/categories/workspace/{workspace_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方法请参见项目ID和账号ID。

workspace_id

是

String

工作空间ID，获取方法请参见实例ID和工作空间ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token，使用Token认证时必选。通过调用IAM服务的“获取用户Token”接口获取响应消息头中X-Subject-Token的值。

instance

是

String

实例ID，获取方法请参见实例ID和工作空间ID。

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

categories

Array of CategoryInfo objects

目录树信息。
表4 CategoryInfo

参数

参数类型

描述

guid

String

主题目录guid。

name

String

主题目录名称。

description

String

主题目录描述信息。

code

String

主题目录编码。

path

String

主题目录路径。

alias

String

主题目录别名。

level

String

主题目录级别。

ordinal

Integer

主题目录排序。

name_eng

String

主题目录英文名称。

qualified_name

String

主题目录唯一标识名称。

create_time

Long

资产创建时间。

update_time

Long

资产修改时间。

business_meaning

String

业务意义。

parent_guid

String

父级目录guid。

department

String

主题目录部门。

data_owner

String

数据owner所属部门。

data_steward

String

数据管家。

database

Array of strings

数据库。

obs_bucket

String

obs桶。

obs_encrypt_bucket

String

obs加密桶。

workspace

Array of strings

所属空间。

children

Array of CategoryInfo objects

子级目录列表。

状态码：400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码：401

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码：403

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码：404

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码：500

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

无

响应示例

状态码：200

OK。

{
  "categories" : [ {
    "guid" : "b9202c80841f08278b32c590def70e9b",
    "name" : "zt1",
    "description" : "",
    "code" : "zt1",
    "path" : "171abda634d44255961998b067bd2c40/zt1",
    "alias" : "",
    "level" : "L1",
    "ordinal" : 2,
    "database" : null,
    "workspace" : [ ],
    "children" : [ {
      "guid" : "4a20751ad711b17dbd5eb90fccb22e73",
      "name" : "zt2",
      "description" : "",
      "code" : "zt2",
      "path" : "171abda634d44255961998b067bd2c40/zt1/zt2",
      "alias" : "",
      "level" : "L2",
      "ordinal" : 1,
      "database" : null,
      "workspace" : [ ],
      "children" : [ {
        "guid" : "5392aab49fb3bc57dfa556f9d676a835",
        "name" : "zt3",
        "description" : "无",
        "code" : "BO000001",
        "path" : "171abda634d44255961998b067bd2c40/zt1/zt2/BO000001",
        "alias" : "",
        "level" : "L3",
        "ordinal" : 1,
        "database" : null,
        "workspace" : [ ],
        "children" : [ ],
        "name_eng" : "",
        "qualified_name" : "zt1.zt2.BO000001@Business.0833a5737480d53b2f25c010dc1a7b88-workspace-171abda634d44255961998b067bd2c40",
        "create_time" : 1740710703609,
        "update_time" : 1740710703609,
        "business_meaning" : "无",
        "parent_guid" : null,
        "department" : "",
        "data_owner" : "zt3",
        "data_steward" : "",
        "obs_bucket" : null,
        "obs_encrypt_bucket" : null
      } ],
      "name_eng" : "",
      "qualified_name" : "zt1.zt2@Business.0833a5737480d53b2f25c010dc1a7b88-workspace-171abda634d44255961998b067bd2c40",
      "create_time" : 1740710670634,
      "update_time" : 1740710670634,
      "business_meaning" : "",
      "parent_guid" : null,
      "department" : "",
      "data_owner" : "",
      "data_steward" : "",
      "obs_bucket" : null,
      "obs_encrypt_bucket" : null
    } ],
    "name_eng" : "",
    "qualified_name" : "zt1@Business.0833a5737480d53b2f25c010dc1a7b88-workspace-171abda634d44255961998b067bd2c40",
    "create_time" : 1740710623649,
    "update_time" : 1740710623649,
    "business_meaning" : "",
    "parent_guid" : null,
    "department" : "",
    "data_owner" : "",
    "data_steward" : "",
    "obs_bucket" : null,
    "obs_encrypt_bucket" : null
  }, {
    "guid" : "be08ce18633486af69f8347dba126a47",
    "name" : "azt1",
    "description" : "",
    "code" : "azt1",
    "path" : "171abda634d44255961998b067bd2c40/azt1",
    "alias" : "",
    "level" : "L1",
    "ordinal" : 3,
    "database" : null,
    "workspace" : [ ],
    "children" : [ {
      "guid" : "a71eaed2926a4d70989aee8e2f46c10c",
      "name" : "azt2",
      "description" : "",
      "code" : "azt2",
      "path" : "171abda634d44255961998b067bd2c40/azt1/azt2",
      "alias" : "",
      "level" : "L2",
      "ordinal" : 1,
      "database" : null,
      "workspace" : [ ],
      "children" : [ {
        "guid" : "c607b80652995d2e49f125a9259e12d5",
        "name" : "azt3",
        "description" : "无",
        "code" : "BO000002",
        "path" : "171abda634d44255961998b067bd2c40/azt1/azt2/BO000002",
        "alias" : "",
        "level" : "L3",
        "ordinal" : 1,
        "database" : null,
        "workspace" : [ ],
        "children" : [ ],
        "name_eng" : "",
        "qualified_name" : "azt1.azt2.BO000002@Business.0833a5737480d53b2f25c010dc1a7b88-workspace              -171abda634d44255961998b067bd2c40",
        "create_time" : 1742202731840,
        "update_time" : 1742202731840,
        "business_meaning" : "无",
        "parent_guid" : null,
        "department" : "",
        "data_owner" : "azt",
        "data_steward" : "",
        "obs_bucket" : null,
        "obs_encrypt_bucket" : null
      } ],
      "name_eng" : "",
      "qualified_name" : "azt1.azt2@Business.0833a5737480d53b2f25c010dc1a7b88-workspace-171abda634d44255961998b067bd2c40",
      "create_time" : 1742202722030,
      "update_time" : 1742202722030,
      "business_meaning" : "",
      "parent_guid" : null,
      "department" : "",
      "data_owner" : "",
      "data_steward" : null,
      "obs_bucket" : null,
      "obs_encrypt_bucket" : null
    } ],
    "name_eng" : "",
    "qualified_name" : "azt1@Business.0833a5737480d53b2f25c010dc1a7b88-workspace-171abda634d44255961998b067bd2c40",
    "create_time" : 1742202699735,
    "update_time" : 1742202699735,
    "business_meaning" : "",
    "parent_guid" : null,
    "department" : "",
    "data_owner" : "",
    "data_steward" : "",
    "obs_bucket" : null,
    "obs_encrypt_bucket" : null
  }, {
    "guid" : "af2c213acc896685dcde6cde74feae7a",
    "name" : "slf_test1",
    "description" : "",
    "code" : "slf_test1",
    "path" : "171abda634d44255961998b067bd2c40/slf_test1",
    "alias" : "",
    "level" : "L1",
    "ordinal" : 1,
    "database" : null,
    "workspace" : [ ],
    "children" : [ {
      "guid" : "bafbdd0c7642490dbee2856b0ca05e28",
      "name" : "slf_test11",
      "description" : "",
      "code" : "slf_test11",
      "path" : "171abda634d44255961998b067bd2c40/slf_test1/slf_test11",
      "alias" : "",
      "level" : "L2",
      "ordinal" : 1,
      "database" : null,
      "workspace" : [ ],
      "children" : [ {
        "guid" : "9c49eaa02f963c8172ac55371008ec9c",
        "name" : "slf_test111",
        "description" : "无",
        "code" : "BO000000",
        "path" : "171abda634d44255961998b067bd2c40/slf_test1/slf_test11/BO000000",
        "alias" : "",
        "level" : "L3",
        "ordinal" : 1,
        "database" : null,
        "workspace" : [ ],
        "children" : [ ],
        "name_eng" : "",
        "qualified_name" : "slf_test1.slf_test11.BO000000@Business.0833a5737480d53b2f25c010dc1a7b88-workspace               -171abda634d44255961998b067bd2c40",
        "create_time" : 1740560866403,
        "update_time" : 1740560866403,
        "business_meaning" : "无",
        "parent_guid" : null,
        "department" : "",
        "data_owner" : "XX",
        "data_steward" : "",
        "obs_bucket" : null,
        "obs_encrypt_bucket" : null
      } ],
      "name_eng" : "",
      "qualified_name" : "slf_test1.slf_test11@Business.0833a5737480d53b2f25c010dc1a7b88-workspace-171abda634d44255961998b067bd2c40",
      "create_time" : 1740560859135,
      "update_time" : 1740560859135,
      "business_meaning" : "",
      "parent_guid" : null,
      "department" : "",
      "data_owner" : "",
      "data_steward" : "",
      "obs_bucket" : null,
      "obs_encrypt_bucket" : null
    } ],
    "name_eng" : "",
    "qualified_name" : "slf_test1@Business.0833a5737480d53b2f25c010dc1a7b88-workspace-171abda634d44255961998b067bd2c40",
    "create_time" : 1740560848281,
    "update_time" : 1740560848281,
    "business_meaning" : "",
    "parent_guid" : null,
    "department" : "",
    "data_owner" : "",
    "data_steward" : "",
    "obs_bucket" : null,
    "obs_encrypt_bucket" : null
  } ]
}

SDK代码示例

SDK代码示例如下。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.dataartsstudio.v1.region.DataArtsStudioRegion;
import com.huaweicloud.sdk.dataartsstudio.v1.*;
import com.huaweicloud.sdk.dataartsstudio.v1.model.*;


public class ListCategoriesTreeSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        DataArtsStudioClient client = DataArtsStudioClient.newBuilder()
                .withCredential(auth)
                .withRegion(DataArtsStudioRegion.valueOf("<YOUR REGION>"))
                .build();
        ListCategoriesTreeRequest request = new ListCategoriesTreeRequest();
        request.withWorkspaceId("{workspace_id}");
        try {
            ListCategoriesTreeResponse response = client.listCategoriesTree(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
 
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkdataartsstudio.v1.region.dataartsstudio_region import DataArtsStudioRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkdataartsstudio.v1 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = DataArtsStudioClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(DataArtsStudioRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListCategoriesTreeRequest()
        request.workspace_id = "{workspace_id}"
        response = client.list_categories_tree(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
 
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    dataartsstudio "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := dataartsstudio.NewDataArtsStudioClient(
        dataartsstudio.DataArtsStudioClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListCategoriesTreeRequest{}
	request.WorkspaceId = "{workspace_id}"
	response, err := client.ListCategoriesTree(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例，请参见API Explorer的代码示例页签，可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

OK。

400

BadRequest。

401

Unauthorized。

403

Forbidden。

404

Not Found。

500

InternalServerError。
父主题： 数据地图接口

相关文档