Copied.
This API is used to query an unrelated table.
Function
This API is used to query tables without lineages based on classification, type_names, connection_names, or query.
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}/lineage/search/unrelated/table
| 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
| 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. |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| attributes | No | Object | Attribute |
| classifications | No | Array of strings | Grouping mode. |
| connection_names | No | Array of strings | Data connection. |
| exclude_classifications | No | Boolean | Indicates whether to exclude a category. |
| exclude_security_levels | No | Boolean | Indicates whether to exclude the security level. |
| exclude_tags | No | Boolean | Whether to exclude tags |
| include_classification_attributes | No | Boolean | Contains classification attributes. |
| include_sub_classifications | No | Boolean | Contains sub-categories. |
| limit | No | Integer | Specifies the maximum number of records on each page. By default, all records are queried. |
| offset | No | Integer | Specifies the offset. By default, all records are queried. |
| order | No | String | Enumerates the sorting types. |
| query | No | String | Query parameters. |
| search_name_and_description | No | Boolean | Indicates whether to search by name and description. |
| security_levels | No | Array of strings | Security Level List. |
| term_names | No | Array of strings | List of tags |
| type_names | No | Array of strings | Indicates the type list. |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| attributes | AttributeSearchResult object | Attributes |
| classification | String | Grouping mode. |
| count | Integer | Total number of results. |
| entities | Array of AtlasEntityHeader objects | Asset information. |
| full_text_result | Array of AtlasFullTextResult objects | Full text results. |
| query_text | String | Query content. |
| query_type | String | Query type. The value can be DSL, FULL_TEXT, GREMLIN, BASIC, ATTRIBUTE, RELATIONSHIP or ADVANCED. |
| referred_entities | Object | Map(String, AtlasEntityHeader). key: guid; value: asset information AtlasEntityHeader. |
| scroll_id | String | Scroll bar ID. |
| search_parameters | Object | Parameter |
| type | String | Type |
| Parameter | Type | Description |
|---|---|---|
| name | Array of strings | Specifies names. |
| values | Array of objects | List of tag values |
| Parameter | Type | Description |
|---|---|---|
| type_name | String | Type name. |
| guid | String | Asset GUID. |
| name | String | Name |
| display_text | String | recommendation |
| status | String | Status. Enumerated values: |
| classification_names | Array of strings | Category name list. |
| classifications | Array of AtlasClassificationInfo objects | Category information. |
| meaning_names | Array of strings | Tag names |
| meanings | Array of TermAssignmentHeader objects | Associate a task. |
| children | Object | Entity map Map(String, AtlasEntityHeader) The key is the GUID, and value is the asset information. |
| attributes | Object | Entity map, which is Map (String, Object) The key is the attribute name, and value is the attribute value. |
| Parameter | Type | Description |
|---|---|---|
| entity | AtlasEntityHeader object | Asset information. |
| score | Number | Sub-option code. |
| Parameter | Type | Description |
|---|---|---|
| entity_guid | String | Asset GUID. |
| propagate | Boolean | Indicates whether to propagate. |
| validity_periods | Array of TimeBoundary objects | Time information. |
| type_name | String | Type name. |
| attributes | Object | Entity map Map(String, Object). key: attribute name; value: attribute value. |
| Parameter | Type | Description |
|---|---|---|
| start_time | String | Start time. |
| end_time | String | End time. |
| time_zone | String | Time zone. |
| Parameter | Type | Description |
|---|---|---|
| confidence | Integer | Trust ID. |
| steward | String | Administrator |
| source | String | Source. |
| status | String | Enumerated values: DISCOVERED, PROPOSED, IMPORTED, VALIDATED, DEPRECATED, OBSOLETE and OTHER. |
| create_user | String | Creator |
| expression | String | Expression. |
| display_text | String | Display information |
| term_guid | String | Tag GUID |
| relation_guid | String | Associated GUID |
Status code: 400
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code. |
| error_msg | String | Error description. |
Status code: 401
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code. |
| error_msg | String | Error description. |
Status code: 403
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code. |
| error_msg | String | Error description. |
Status code: 404
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code. |
| error_msg | String | Error description. |
Example Requests
{
"attributes" : {
"database" : [ "database" ],
"classifications" : [ ],
"connection_names" : [ ],
"exclude_classifications" : false,
"exclude_security_levels" : false,
"exclude_tags" : false,
"include_classification_attributes" : false,
"include_sub_classifications" : false,
"limit" : 10,
"offset" : 0,
"order" : "incr",
"query" : "wk_02",
"search_name_and_description" : true,
"security_levels" : [ ],
"term_names" : [ ],
"type_names" : [ ]
}
} Example Responses
Status code: 200
OK.
{
"attributes" : null,
"classification" : null,
"count" : 78,
"entities" : [ {
"attributes" : {
"securityLevel" : null,
"owner" : "DA_test",
"comments" : null,
"createTime" : 1674961143000,
"qualifiedName" : "wk.hive_02@hive.192.168.0.96-mrs_3x_autotest_do_not_del.0833a5737480d53b2f25c010dc1a7b88-workspace -b88c445407b24283aa949f9833a38fd8",
"connectionQName" : "hive@192.168.0.96-mrs_3x_autotest_do_not_del.0833a5737480d53b2f25c010dc1a7b88-workspace -b88c445407b24283aa949f9833a38fd8",
"name" : "hive_02",
"description" : null,
"connectionType" : "hive"
},
"children" : null,
"classification_names" : [ ],
"classifications" : null,
"display_text" : null,
"guid" : "9915ee1e-3803-4f4d-86b2-ee5dfadc0d46",
"meaning_names" : [ ],
"meanings" : [ ],
"name" : null,
"status" : "ACTIVE",
"type_name" : "hive_table"
} ],
"full_text_result" : null,
"query_text" : "",
"query_type" : "ADVANCED",
"referred_entities" : null,
"scroll_id" : null,
"search_parameters" : null,
"type" : 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 ShowUnrelatedTableSolution { 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(); ShowUnrelatedTableRequest request = new ShowUnrelatedTableRequest(); try { ShowUnrelatedTableResponse response = client.showUnrelatedTable(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 = ShowUnrelatedTableRequest() response = client.show_unrelated_table(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.ShowUnrelatedTableRequest{} response, err := client.ShowUnrelatedTable(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. |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot