Help Center/ DataArts Studio/ API Reference/ DataArts Catalog APIs/ Data Map APIs/ Obtaining Logical Entities in a Directory (Closed Beta Test)
Updated on 2026-07-02 GMT+08:00

Obtaining Logical Entities in a Directory (Closed Beta Test)

Function

This API is used to obtain the logical entities in a directory.

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/logicentitys/guid/{guid}

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.

guid

Yes

String

Theme directory asset GUID. For details about how to obtain the asset GUID, see Data Asset GUID.

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

[items]

Array of Entity objects

Asset list.

Table 4 Entity

Parameter

Type

Description

version

Number

Data version.

relationship_attributes

Object

Association relationship attribute. The data type is Map<String, Object>. The options are as follows: key: relationship type; value: association relationship object.

super_type_names

Array of strings

Parent asset type.

business_attributes

Object

Service attribute. The data type is Map<String, Map<String, Object>>. The options are as follows: key: service relationship type; value: service relationship.

multi_attributes

Object

Multi-value object data structure that bears security levels and tags. The data structure is Map<String, List<Map<String, Object>>>. key indicates the comprehensive relationship type, and value indicates the comprehensive relationship.

privilege_info

EntityPrivilegeInfo object

Entity privilege information.

extended_attributes

Object

Extended attribute. The data structure is Map<String, Object>. The key field indicates the extended attribute, and the value field indicates the extended attribute value.

guid

String

Asset GUID.

type_name

String

Asset type name.

type_display_name

String

Type display name.

display_text

String

Display name.

attributes

Object

Asset attribute, which is a Map<String, Object>. The key is an attribute, and value is the attribute value.

updated_attributes

Array of strings

List of modified attributes.

project_id

String

Project ID

domain_id

String

Main account ID.

instance_id

Array of strings

Instantiation ID.

workspace_id

Array of strings

Workspace IDs

status

String

Status

created_by

String

Creator

updated_by

String

User who makes a modification.

create_time

String

Creation time.

update_time

String

Modification time.

Table 5 EntityPrivilegeInfo

Parameter

Type

Description

privileges

Array of strings

Privilege list.

inherit_privileges

Array of strings

List of inherited privileges.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 403

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 404

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 500

Table 10 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.

[ {
  "guid" : "3ec2aee915ba8f9c2cad41344333f398",
  "attributes" : {
    "approvalOwner" : "",
    "owner" : "",
    "code" : "test12",
    "qualifiedName" : "slf_test1.test12@Business.0833a5737480d53b2f25c010dc1a7b88-workspace-171abda634d44255961998b067bd2c40",
    "description" : "None",
    "updateTime" : "2025-02-26T09:15:46.094+00:00",
    "baseType" : "LogicEntity",
    "isHidden" : false,
    "path" : "171abda634d44255961998b067bd2c40/slf_test1",
    "nameEng" : "",
    "createBy" : "",
    "selfDefinedFields" : "",
    "catalogId" : "catalog@cn-north-7",
    "createTime" : "2025-02-26T09:15:46.094+00:00",
    "updateBy" : "",
    "name" : "test12",
    "alias" : "",
    "id" : "",
    "businessOwner" : "",
    "publishStatus" : ""
  },
  "status" : "ACTIVE",
  "version" : 1,
  "type_name" : "datamgt.LogicEntity",
  "type_display_name" : "Logical entities",
  "project_id" : "0833a5737480d53b2f25c010dc1a7b88",
  "domain_id" : "0833a5736980d53b0f22c0102ffcbfc0",
  "instance_id" : [ "dd97167b873d4a79b2aad54d4370a3bc" ],
  "workspace_id" : [ "171abda634d44255961998b067bd2c40" ],
  "created_by" : "username",
  "updated_by" : "username",
  "create_time" : "2025-02-26T09:15:46.463+00:00",
  "update_time" : "2025-03-10T01:57:43.234+00:00",
  "super_type_names" : [ "base.Asset", "base.GovernanceAsset" ],
  "business_attributes" : {
    "businessName" : {
      "confidence" : 1,
      "name" : "test12",
      "confirmed" : true
    },
    "category" : {
      "path" : "171abda634d44255961998b067bd2c40/slf_test1",
      "confidence" : 1,
      "confirmed" : true
    }
  },
  "multi_attributes" : {
    "classifications" : [ ],
    "tags" : [ ]
  },
  "extended_attributes" : { },
  "display_text" : "test12"
} ]

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

    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();
        ListLogicEntitiesRequest request = new ListLogicEntitiesRequest();
        request.withGuid("{guid}");
        try {
            ListLogicEntitiesResponse response = client.listLogicEntities(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 = ListLogicEntitiesRequest()
        request.guid = "{guid}"
        response = client.list_logic_entities(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.ListLogicEntitiesRequest{}
	request.Guid = "{guid}"
	response, err := client.ListLogicEntities(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.