Injecting a Data Watermark
Function
This API is used to dynamically inject a watermark into the JSON body.
Calling Method
For details, see Calling APIs.
URI
POST /v1/{project_id}/sdg/database/watermark/embed
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token, which can be obtained by calling the IAM API (value of X-Subject-Token in the response header). |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
watermark_content |
Yes |
String |
Watermark content |
watermark_key |
Yes |
String |
Watermark key |
columns |
Yes |
Array of Columns objects |
List of field types. The number of field types in a list cannot exceed 100. At least two fields must be included. primary_key set to true indicates the primary key and primary_key set to false indicates watermark injection. |
data |
Yes |
Array of Map<String,Object> objects |
Content of a field, which can contain a maximum of 2000 characters. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
marked_data |
Array of Map<String,Object> objects |
Watermarked data |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error Code |
error_msg |
String |
Error Message |
Example Requests
Embed the watermark test12345678test. The watermark key is "keyword". The data field of the data type table is "item1". This field is the primary key.
POST https://{endpoit}/v1/{project_id}/sdg/database/watermark/embed { "watermark_content" : "test12345678test", "watermark_key" : "keyword", "columns" : [ { "name" : "item1", "type" : "INTEGER", "primary_key" : true }, { "name" : "item2", "type" : "INTEGER", "primary_key" : false } ], "data" : [ { "item1" : 0, "item2" : 3 }, { "item1" : 1, "item2" : 4 } ] }
Example Responses
Status code: 200
Request successful.
{ "marked_data" : [ { "item2" : 3, "item1" : "test" }, { "item2" : 5, "item1" : "test" } ] }
Status code: 400
Parameter error.
{ "error_code" : "DSC.00000004", "error_msg" : "Invalid parameter" }
SDK Sample Code
The SDK sample code is as follows.
Embed the watermark test12345678test. The watermark key is "keyword". The data field of the data type table is "item1". This field is the primary key.
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 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 |
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.dsc.v1.region.DscRegion; import com.huaweicloud.sdk.dsc.v1.*; import com.huaweicloud.sdk.dsc.v1.model.*; import java.util.List; import java.util.ArrayList; import java.util.Map; import java.util.HashMap; public class CreateDatabaseWaterMarkSolution { 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"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); DscClient client = DscClient.newBuilder() .withCredential(auth) .withRegion(DscRegion.valueOf("<YOUR REGION>")) .build(); CreateDatabaseWaterMarkRequest request = new CreateDatabaseWaterMarkRequest(); EmbeddedDatabaseWatermark body = new EmbeddedDatabaseWatermark(); Map<String, Object> listDataData = new HashMap<>(); listDataData.put("item1", "1"); listDataData.put("item2", "4"); Map<String, Object> listDataData1 = new HashMap<>(); listDataData1.put("item1", "0"); listDataData1.put("item2", "3"); List<Map<String, Object>> listbodyData = new ArrayList<>(); listbodyData.add(listDataData); listbodyData.add(listDataData1); List<Columns> listbodyColumns = new ArrayList<>(); listbodyColumns.add( new Columns() .withName("item1") .withType(Columns.TypeEnum.fromValue("INTEGER")) .withPrimaryKey(true) ); listbodyColumns.add( new Columns() .withName("item2") .withType(Columns.TypeEnum.fromValue("INTEGER")) .withPrimaryKey(false) ); body.withData(listbodyData); body.withColumns(listbodyColumns); body.withWatermarkKey("keyword"); body.withWatermarkContent("test12345678test"); request.withBody(body); try { CreateDatabaseWaterMarkResponse response = client.createDatabaseWaterMark(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()); } } } |
Embed the watermark test12345678test. The watermark key is "keyword". The data field of the data type table is "item1". This field is the primary key.
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 48 49 50 51 52 53 54 55 56 57 58 59 60 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkdsc.v1.region.dsc_region import DscRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkdsc.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"] credentials = BasicCredentials(ak, sk) client = DscClient.new_builder() \ .with_credentials(credentials) \ .with_region(DscRegion.value_of("<YOUR REGION>")) \ .build() try: request = CreateDatabaseWaterMarkRequest() listDataData = { "item1": "1", "item2": "4" } listDataData1 = { "item1": "0", "item2": "3" } listDatabody = [ listDataData, listDataData1 ] listColumnsbody = [ Columns( name="item1", type="INTEGER", primary_key=True ), Columns( name="item2", type="INTEGER", primary_key=False ) ] request.body = EmbeddedDatabaseWatermark( data=listDatabody, columns=listColumnsbody, watermark_key="keyword", watermark_content="test12345678test" ) response = client.create_database_water_mark(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Embed the watermark test12345678test. The watermark key is "keyword". The data field of the data type table is "item1". This field is the primary key.
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 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" dsc "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dsc/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dsc/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dsc/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") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := dsc.NewDscClient( dsc.DscClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.CreateDatabaseWaterMarkRequest{} var listDataData = map[string]interface{}{ "item1": "1", "item2": "4", } var listDataData3 = map[string]interface{}{ "item1": "0", "item2": "3", } var listDatabody = []map[string]interface{}{ listDataData, listDataData3, } var listColumnsbody = []model.Columns{ { Name: "item1", Type: model.GetColumnsTypeEnum().INTEGER, PrimaryKey: true, }, { Name: "item2", Type: model.GetColumnsTypeEnum().INTEGER, PrimaryKey: false, }, } request.Body = &model.EmbeddedDatabaseWatermark{ Data: listDatabody, Columns: listColumnsbody, WatermarkKey: "keyword", WatermarkContent: "test12345678test", } response, err := client.CreateDatabaseWaterMark(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 |
Request successful. |
400 |
Parameter error. |
Error Codes
See Error Codes.
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