Help Center/ DataArts Studio/ API Reference/ DataArts Catalog APIs/ Data Map APIs/ Obtaining the Asset Directory Tree in a Workspace (Closed Beta Test)
Updated on 2026-07-02 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Obtaining the Asset Directory Tree in a Workspace (Closed Beta Test)

Function

This API is used to obtain the asset directory tree in a workspace.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain it, see Project ID and Account ID.

workspace_id

Yes

String

Workspace ID. For details about how to obtain the workspace ID, see Instance ID and Workspace ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. This parameter is mandatory when token authentication is used. You can obtain it from the value of X-Subject-Token in the response message header returned by the "Obtaining a User Token" API of the IAM service.

instance

Yes

String

Instance ID. For details about how to obtain it, see Instance ID and Workspace ID.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

categories

Array of CategoryInfo objects

Directory tree information.
Table 4 CategoryInfo

Parameter

Type

Description

guid

String

Theme directory guid.

name

String

Theme directory name.

description

String

Theme directory description.

code

String

Theme directory code.

path

String

Theme directory path.

alias

String

Alias of the theme directory.

level

String

Theme directory level.

ordinal

Integer

Theme directory sorting.

name_eng

String

English name of the theme directory.

qualified_name

String

Unique name of a theme directory.

create_time

Long

Time when an asset is created.

update_time

Long

Asset modification time.

business_meaning

String

Business meaning.

parent_guid

String

Parent directory guid.

department

String

Theme directory department.

data_owner

String

Department to which the data owner belongs.

data_steward

String

Data steward.

database

Array of strings

Database.

obs_bucket

String

OBS bucket.

obs_encrypt_bucket

String

OBS encrypted bucket.

workspace

Array of strings

Owning space.

children

Array of CategoryInfo objects

Sub-directory list.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 403

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 404

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 500

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

None

Example Responses

Status code: 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" : "None",
        "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" : "None",
        "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" : "None",
        "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" : "None",
        "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" : "None",
        "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" : "None",
        "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 Sample Code

The SDK sample code is as follows.

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

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

OK.

400

Bad request.

401

Unauthorized.

403

Forbidden.

404

Not found.

500

InternalServerError.
Parent Topic: Data Map APIs