更新时间:2024-07-29 GMT+08:00

嵌入数据水印

功能介绍

对json体中数据动态添加水印

调用方法

请参见如何调用API

URI

POST /v1/{project_id}/sdg/database/watermark/embed

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。通过调用IAM服务“获取用户Token接口”获取(响应消息头中X-Subject-Token的值)

表3 请求Body参数

参数

是否必选

参数类型

描述

watermark_content

String

添加水印的内容

watermark_key

String

水印密钥

columns

Array of Columns objects

字段类型列表,最大长度100。使用时,至少包含两个字段,一个“primary_key”为true表示主键,一个为false用来嵌入水印

data

Array of Map<String,Object> objects

数据字段的内容,最大支持长度2000

表4 Columns

参数

是否必选

参数类型

描述

name

String

数据的字段名称,最大支持长度256

type

String

数据的字段类型

枚举值:

  • INTEGER

  • STRING

  • DOUBLE

primary_key

Boolean

标记该字段是否为主键。true为主键,表示用来定位水印位置;false为非主键,将在该列嵌入/提取水印内容。字段类型列表中可同时包含多个为true或为false的字段

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

marked_data

Array of Map<String,Object> objects

嵌入水印后的数据

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

请求示例

嵌入内容为test12345678test的水印,水印密钥是keyword,字段类型列表中数据的字段名称为item1,该字段为主键。

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
  } ]
}

响应示例

状态码: 200

请求成功

{
  "marked_data" : [ {
    "item2" : 3,
    "item1" : "test"
  }, {
    "item2" : 5,
    "item1" : "test"
  } ]
}

状态码: 400

参数错误

{
  "error_code" : "DSC.00000004",
  "error_msg" : "Invalid parameter"
}

SDK代码示例

SDK代码示例如下。

嵌入内容为test12345678test的水印,水印密钥是keyword,字段类型列表中数据的字段名称为item1,该字段为主键。

 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());
        }
    }
}

嵌入内容为test12345678test的水印,水印密钥是keyword,字段类型列表中数据的字段名称为item1,该字段为主键。

 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)

嵌入内容为test12345678test的水印,水印密钥是keyword,字段类型列表中数据的字段名称为item1,该字段为主键。

 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)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

请求成功

400

参数错误

错误码

请参见错误码