Adding or Modifying an Asset
Function
Add or modify an asset.
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
| 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 |
|---|---|---|---|
| entity | Yes | AtlasAssetEntity object | Asset information. |
| referred_entities | No | Object | Associated asset map Map(String, AtlasAssetEntity). The key is guid, and the value is asset information. |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| type_name | Yes | String | Type name. |
| guid | No | String | Asset GUID. |
| version | No | Integer | Version |
| update_time | No | Number | Modification time. |
| update_user | No | String | User who makes a modification. |
| create_time | No | Number | Creation time. |
| create_user | No | String | Creator |
| display_text | No | String | recommendation |
| status | No | String | Status. Enumerated values: |
| classifications | No | Array of AtlasClassificationInfo objects | Category information. |
| meanings | No | Array of TermAssignmentHeader objects | Associate a task. |
| relation_ship_attributes | No | Object | Entity map Map(String, Object). key: association relationship type. value: association relationship information. |
| attributes | Yes | Object | Entity map Map(String, Object). key: attribute name; value: attribute value. |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| entity_guid | No | String | Asset GUID. |
| propagate | No | Boolean | Indicates whether to propagate. |
| validity_periods | No | Array of TimeBoundary objects | Time information. |
| type_name | No | String | Type name. |
| attributes | No | Object | Entity map Map(String, Object). key: attribute name; value: attribute value. |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| start_time | No | String | Start time. |
| end_time | No | String | End time. |
| time_zone | No | String | Time zone. |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| confidence | No | Integer | Trust ID. |
| steward | No | String | Administrator |
| source | No | String | Source. |
| status | No | String | Enumerated values: DISCOVERED, PROPOSED, IMPORTED, VALIDATED, DEPRECATED, OBSOLETE and OTHER. |
| create_user | No | String | Creator |
| expression | No | String | Expression. |
| display_text | No | String | Display information |
| term_guid | No | String | Tag GUID |
| relation_guid | No | String | Associated GUID |
Response Parameters
Status code: 200
OK.
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. |
Status code: 500
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code. |
| error_msg | String | Error description. |
Example Requests
{
"entity" : {
"attributes" : {
"owner" : null,
"comments" : null,
"qualifiedName" : "postgres.dm_autotest.duoallfuhe013.dqc_create_timestamp@dws.dws-4autotest-nomodify.dws.myhuaweicloud.com-dws_4autotest_nomodify.0833a5737480d53b2f25c010dc1a7b88-workspace-1b59d3c777ad4d619b89eeac4f3cce87",
"isPartitionColumn" : false,
"description" : null,
"isPrimaryKey" : false,
"type" : "bigint",
"ordinalPosition" : 6,
"connectionType" : "dws",
"securityLevel" : null,
"connectionQName" : "dws@dws-4autotest-nomodify.dws.myhuaweicloud.com-dws_4autotest_nomodify.0833a5737480d53b2f25c010dc1a7b88-workspace-1b59d3c777ad4d619b89eeac4f3cce87",
"isNullable" : "true",
"name" : "dqc_create_timestamp",
"connectionId" : "null:8a94806e79e693a30179e972c4aa000c",
"alias" : null,
"table" : {
"uniqueAttributes" : {
"qualifiedName" : "postgres.dm_autotest.duoallfuhe013@dws.dws-4autotest-nomodify.dws.myhuaweicloud.com-dws_4autotest_nomodify.0833a5737480d53b2f25c010dc1a7b88-workspace-1b59d3c777ad4d619b89eeac4f3cce87"
},
"typeName" : "dws_table",
"name" : "duoallfuhe013",
"guid" : "bc9af691-3401-4a7e-959f-413359dafeb6"
}
},
"classifications" : null,
"create_time" : 1662567796444,
"create_user" : "user_demo",
"display_text" : "dqc_create_timestamp",
"guid" : "266b1194-1713-47c9-94be-fdac82023f2f",
"meanings" : null,
"relation_ship_attributes" : {
"inputToProcesses" : [ ],
"meanings" : [ ],
"table" : {
"relationshipAttributes" : {
"typeName" : "dws_table_column"
},
"displayText" : "duoallfuhe013",
"relationshipGuid" : "f78811cb-0dd8-4459-8fda-54ca44d66005",
"typeName" : "dws_table",
"guid" : "bc9af691-3401-4a7e-959f-413359dafeb6",
"relationshipStatus" : "ACTIVE"
},
"outputFromProcesses" : [ ]
},
"status" : "ACTIVE",
"type_name" : "dws_column",
"update_time" : 1662567796444,
"update_user" : "user_demo",
"version" : 0
},
"referred_entities" : {
"dws@dws-4autotest-nomodify.dws.myhuaweicloud.com-dws_4autotest_nomodify.0833a5737480d53b2f25c010dc1a7b88-workspace-1b59d3c777ad4d619b89eeac4f3cce87" : {
"attributes" : {
"owner" : "user_demo",
"securityLevel" : null,
"createTime" : 0,
"port" : 8000,
"qualifiedName" : "dws@dws-4autotest-nomodify.dws.myhuaweicloud.com-dws_4autotest_nomodify.0833a5737480d53b2f25c010dc1a7b88-workspace-1b59d3c777ad4d619b89eeac4f3cce87",
"name" : "dws_test",
"host" : null,
"description" : null,
"id" : "8a94806e79e693a30179e972c4aa000c",
"connectionType" : "dws"
},
"classifications" : null,
"create_time" : 1665641601524,
"create_user" : "user_demo",
"display_text" : "dws_test",
"guid" : "46bdc502-7912-460f-9d67-15141e9ab096",
"meanings" : null,
"relation_ship_attributes" : {
"meanings" : [ ]
},
"status" : "ACTIVE",
"type_name" : "Connection",
"update_time" : 1669914264150,
"update_user" : "user_demo",
"version" : 0
}
}
} Example Responses
None
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 CreateOrUpdateAssetSolution { 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(); CreateOrUpdateAssetRequest request = new CreateOrUpdateAssetRequest(); try { CreateOrUpdateAssetResponse response = client.createOrUpdateAsset(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 = CreateOrUpdateAssetRequest() response = client.create_or_update_asset(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.CreateOrUpdateAssetRequest{} response, err := client.CreateOrUpdateAsset(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. |
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