# 查询技术资产 - ShowEntities #### 功能介绍 查询技术资产。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-dataartsstudio/making_request.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dataartsstudio/abcd.html)。 - 如果使用身份策略授权，当前API调用无需身份策略权限。 #### URI POST /v3/{project_id}/asset/entities/search 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID，获取方法请参见[项目ID和账号ID](https://support.huaweicloud.com/api-dataartsstudio/projectid_accountid.html)。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | 用户Token，使用[Token认证](https://support.huaweicloud.com/api-dataartsstudio/dataartsstudio_02_0010.html)时必选。通过调用IAM服务的"获取用户Token"接口获取响应消息头中X-Subject-Token的值。 | | workspace | 是 | String | 工作空间ID，获取方法请参见[实例ID和工作空间ID](https://support.huaweicloud.com/api-dataartsstudio/dataartsstudio_02_0350.html)。 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | query | 是 | String | 查询关键字，search_all_attributes为true匹配所有属性，false只匹配名称、描述，默认false。 | | type_names | 是 | Array of strings | 分类名称列表。 | | connection_names | 否 | Array of strings | 连接名称列表。 | | search_all_attributes | 否 | Boolean | 查询关键字是否匹配资产的名称描述信息，true：匹配所有属性，false：只匹配名称、描述，默认false。 | | tags | 否 | Array of strings | 标签名称列表。 | | limit | 是 | Integer | 分页显示每页返回结果数。默认值：10。 | | offset | 否 | Integer | 偏移量，默认值：0。 | | attributes | 否 | Object | key当前支持Table，value可为以下中的一个或多个：rowCounts、tableSize、database、schema、namespace、ddlUpdateTime、dataUpdateTime、ddlCreateTime Map(String,Set(String))。 | | filter_criteria | 否 | [FilterCriteria] object | 过滤条件。 | | time_range | 否 | [TimeRange] object | 时间过滤条件，可以根据此条件设置过滤资产。 | | scroll_id | 否 | String | scroll_id。 | | security_levels | 否 | Array of strings | 密级列表。 | | is_import | 否 | Boolean | 是否导入。 | | classifications | 否 | Array of strings | 分类列表。 | | description | 否 | String | 描述。 | 表4FilterCriteria | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 是 | String | 当前可选值：database。 | | value | 是 | String | database的名称。 | | operator | 是 | String | 操作标识。枚举值： - LT 小于 - GT 大于 - LTE 小于等于 - GTE 大于等于 - EQ 相等 - NEQ 不相等 - IN 在列表中 - LIKE 任意模糊匹配 - STARTS_WITH 起始相同匹配 - ENDS_WITH 结束相同匹配 - CONTAINS 包含 - CONTAINS_ANY 包含任意 - CONTAINS_ALL 包含所有 - IS_NULL 为空 - NOT_NULL 不为空 | 表5TimeRange | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | time_type | 是 | String | 时间类型。枚举值： - ddlUpdateTime ddl新时间 - dataUpdateTime 数据修改时间 - ddlCreateTime ddl创建时间 | | start | 是 | String | 开始时间。 | | end | 是 | String | 结束时间。 | #### 响应参数 **状态码：200** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | count | Integer | 技术资产总数。 | | entities | Array of [OpenEntityHeader] objects | 技术资产列表。 | | scroll_id | String | scroll_id | 表7OpenEntityHeader | 参数 | 参数类型 | 描述 | |:---|:---|:---| | attributes | Object | 属性。 | | connection | [Connection] object | 数据连接。 | | display_text | String | 展示文档。 | | guid | String | 资产guid。 | | type_name | String | 类型名称。 | | tags | Array of [TagHeader] objects | 标签列表。 | | classification_names | Array of strings | 分类名称列表。 | 表8Connection | 参数 | 参数类型 | 描述 | |:---|:---|:---| | guid | String | 关联guid。 | | display_text | String | 显示内容。 | | type_name | String | 类型名称。 | | connection_type | String | 连接类型。 | | qualified_name | String | 限定名称。 | 表9TagHeader | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | 资产名称。 | | description | Object | 标签描述。 | | display_text | String | 标签的名称。 | | relation_guid | String | 关联的guid。 | | tag_guid | String | 标签关联的guid。 | **状态码：400** 表10响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误描述。 | **状态码：401** 表11响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误描述。 | **状态码：403** 表12响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误描述。 | **状态码：404** 表13响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误描述。 | **状态码：500** 表14响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误描述。 | #### 请求示例 ``` { "search_all_attributes" : true, "offset" : 0, "limit" : 10, "type_names" : [ "Database" ], "query" : "cbu_training" } ``` #### 响应示例 **状态码：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代码示例 SDK代码示例如下。 - [Java] ``` 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("")) .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()); } } } ``` - [Python] ``` # 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("")) \ .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) ``` - [Go] ``` 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := dataartsstudio.DataArtsStudioClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := dataartsstudio.NewDataArtsStudioClient(hcClient) request := &model.ShowEntitiesRequest{} response, err := client.ShowEntities(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/DataArtsStudio/sdk?api=ShowEntities)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK。 | | 400 | BadRequest。 | | 401 | Unauthorized。 | | 403 | Forbidden。 | | 404 | Not Found。 | | 500 | InternalServerError。 |