Updated on 2026-07-02 GMT+08:00

Querying Technical Assets

Function

Query technology assets.

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

POST /v3/{project_id}/asset/entities/search

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.

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.

workspace

Yes

String

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

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

query

Yes

String

Query keyword. If search_all_attributes is set to true, all attributes are matched. If search_all_attributes is set to false, only the name and description are matched. The default value is false.

type_names

Yes

Array of strings

Category name list.

connection_names

No

Array of strings

List of connection names.

search_all_attributes

No

Boolean

Indicates whether the query keyword matches the asset name and description. The options are as follows: true: match all attributes; false: match only the asset name and description. The default value is false.

tags

No

Array of strings

Tag names

limit

Yes

Integer

Number of results displayed on each page. Default value: 10.

offset

No

Integer

Offset. The default value is 0.

attributes

No

Object

Currently, key can be set to Table, and value can be set to rowCounts, tableSize, database, schema, namespace, ddlUpdateTime, dataUpdateTime or ddlCreateTime Map(String,Set(String)).

filter_criteria

No

FilterCriteria object

Filter criteria.

time_range

No

TimeRange object

Indicates the time filter criteria. You can set the filter criteria to filter assets.

scroll_id

No

String

scroll_id.

security_levels

No

Array of strings

Confidentiality list.

is_import

No

Boolean

Whether to import.

classifications

No

Array of strings

Category List

description

No

String

Description

Table 4 FilterCriteria

Parameter

Mandatory

Type

Description

name

Yes

String

The value can be database.

value

Yes

String

Name of the database.

operator

Yes

String

Operator. Enumerated values:

  • LT: less than

  • GT: greater than

  • LTE: less than or equal to

  • GTE: greater than or equal to

  • EQ: equal to

  • NEQ: not equal to

  • IN: in the list

  • LIKE: any fuzzy match

  • STARTS_WITH: the same start

  • ENDS_WITH: the same end

  • CONTAINS: contains

  • CONTAINS_ANY: contains any

  • CONTAINS_ALL: contains all

  • IS_NULL: null

  • NOT_NULL: not null

Table 5 TimeRange

Parameter

Mandatory

Type

Description

time_type

Yes

String

Time type. Enumerated values:

  • ddlUpdateTime: DDL update time

  • dataUpdateTime: data update time

  • ddlCreateTime: DDL creation time

start

Yes

String

Start time

end

Yes

String

End time.

Response Parameters

Status code: 200

Table 6 Response body parameters

Parameter

Type

Description

count

Integer

Total number of technology assets.

entities

Array of OpenEntityHeader objects

List of technology assets.

scroll_id

String

scroll_id

Table 7 OpenEntityHeader

Parameter

Type

Description

attributes

Object

Attribute

connection

Connection object

Data connection.

display_text

String

Displays documents.

guid

String

Asset GUID.

type_name

String

Type name.

tags

Array of TagHeader objects

List of tags

classification_names

Array of strings

Category name list.

Table 8 Connection

Parameter

Type

Description

guid

String

Associated GUID

display_text

String

Displayed content

type_name

String

Type name

connection_type

String

Connection type

qualified_name

String

Name of a restriction

Table 9 TagHeader

Parameter

Type

Description

name

String

Asset name.

description

Object

Tag description

display_text

String

Tag name.

relation_guid

String

Associated GUID.

tag_guid

String

Specifies the GUID associated with the tag.

Status code: 400

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 401

Table 11 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 403

Table 12 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 404

Table 13 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 500

Table 14 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

{
  "search_all_attributes" : true,
  "offset" : 0,
  "limit" : 10,
  "type_names" : [ "Database" ],
  "query" : "cbu_training"
}

Example Responses

Status code: 200

OK.

{
  "count" : 1,
  "entities" : [ {
    "attributes" : {
      "owner" : "wangyongjie",
      "create_time" : null,
      "qualified_name" : "cbu_training@dli.0833a5737480d53b2f25c010dc1a7b88-workspace-61aa10df45e54431a1901cb3527adab8",
      "name" : "cbu_training",
      "description" : "",
      "security_level" : null
    },
    "classification_names" : [ ],
    "connection" : {
      "connection_type" : "dli",
      "display_text" : "dli",
      "guid" : "0fff4057-c206-4dc3-a4ac-73ffc332bc9a",
      "qualified_name" : "dli@0833a5737480d53b2f25c010dc1a7b88-workspace-61aa10df45e54431a1901cb3527adab8",
      "type_name" : "Connection"
    },
    "display_text" : "cbu_training",
    "guid" : "e2b12c35-48ee-441f-a357-e338a85f5d00",
    "tags" : [ ],
    "type_name" : "dli_database"
  } ],
  "scroll_id" : 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
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 ShowEntitiesSolution {

    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();
        ShowEntitiesRequest request = new ShowEntitiesRequest();
        try {
            ShowEntitiesResponse response = client.showEntities(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
# 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 = ShowEntitiesRequest()
        response = client.show_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
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.ShowEntitiesRequest{}
	response, err := client.ShowEntities(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.