Creating or Modifying an Asset (Invitational Test)
Function
This API is used to create or modify assets. It is in invitational test and will be available for OBT in the future.
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 /v1/{project_id}/datamap/entities
| 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. |
| instance | Yes | String | Instance ID. For details about how to obtain the instance ID, see Instance ID and Workspace ID. |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| entity | No | Entity object | Asset information. |
| referred_entities | No | Object | Associated asset information, which is a Map<String, Entity>. The key is the asset GUID, and value is the asset information. |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| version | No | Number | Data version. |
| relationship_attributes | No | 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 | No | Array of strings | Parent asset type. |
| business_attributes | No | 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 | No | 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 | No | EntityPrivilegeInfo object | Entity privilege information. |
| extended_attributes | No | 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 | No | String | Asset GUID. |
| type_name | No | String | Asset type name. |
| type_display_name | No | String | Type display name. |
| display_text | No | String | Display name. |
| attributes | No | Object | Asset attribute, which is a Map<String, Object>. The key is an attribute, and value is the attribute value. |
| updated_attributes | No | Array of strings | List of modified attributes. |
| project_id | No | String | Project ID |
| domain_id | No | String | Main account ID. |
| instance_id | No | Array of strings | Instantiation ID. |
| workspace_id | No | Array of strings | Workspace IDs |
| status | No | String | Status |
| created_by | No | String | Creator |
| updated_by | No | String | User who makes a modification. |
| create_time | No | String | Creation time. |
| update_time | No | String | Modification time. |
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" : {
"guid" : -1,
"attributes" : {
"owner" : "username",
"is_favorite" : 0,
"qualifiedName" : "dws@a96be22c-77f3-46ea-96ab-c8913052ec7d",
"favorites_count" : 0,
"description" : "This temp entity was generated from DLF lineage service",
"clusterId" : "",
"click_through" : 10,
"baseType" : "Source",
"path" : "",
"catalogId" : "",
"workspaceVsId" : { },
"createTime" : 0,
"port" : 8000,
"sourceType" : "dws",
"name" : "dws_4autotest1_nomodify",
"host" : "",
"id" : "f9338475eb8c4cbda61b85c05908a432",
"projectId" : ""
},
"status" : "ACTIVE",
"version" : 0,
"type_name" : "dataasset.Source",
"type_display_name" : "Data sources",
"project_id" : 123456,
"domain_id" : 123456,
"instance_id" : [ "123456" ],
"workspace_id" : [ "123456" ],
"updated_by" : "username",
"create_time" : 0,
"update_time" : 0,
"super_type_names" : [ "base.Asset", "base.Infrastructure" ],
"business_attributes" : {
"businessName" : {
"confidence" : 1.0,
"name" : "dws0505",
"confirmed" : true
}
},
"multi_attributes" : {
"tags" : [ {
"confidence" : 1.0,
"name" : "Mistaken deletion of personal data",
"confirmed" : false
} ]
},
"privilege_info" : {
"privileges" : [ ],
"inherit_privileges" : [ ]
},
"extended_attributes" : { },
"display_text" : "dws0505"
},
"referred_entities" : null
} 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 CreateOrUpdateEntitiesSolution { 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(); CreateOrUpdateEntitiesRequest request = new CreateOrUpdateEntitiesRequest(); try { CreateOrUpdateEntitiesResponse response = client.createOrUpdateEntities(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 = CreateOrUpdateEntitiesRequest() response = client.create_or_update_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.CreateOrUpdateEntitiesRequest{} response, err := client.CreateOrUpdateEntities(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 | Internal server error. |
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