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

提取数据水印

功能介绍

提取请求数据中水印内容

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

表3 请求Body参数

参数

是否必选

参数类型

描述

watermark_key

String

水印密钥

columns

Array of Columns objects

字段类型列表,最大长度100。使用时,要包含嵌入时所有“primary_key”为true的字段,和至少一个为false的字段用来提取水印

data

Array of Map<String,Object> objects

水印数据,数据条数不超过30,000条

表4 Columns

参数

是否必选

参数类型

描述

name

String

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

type

String

数据的字段类型

枚举值:

  • INTEGER

  • STRING

  • DOUBLE

primary_key

Boolean

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

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

watermarks

Array of strings

提取水印内容列表。上传数据中不同列可能包含不同水印,返回时将所有提取到的水印返回,列表中水印个数不超过100

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

请求示例

提取数据水印,水印密钥是key,字段类型列表中数据的字段名称为col,该字段为非主键。

POST https://{endpoint}/v1/{project_id}/sdg/database/watermark/extract

{
  "watermark_key" : "key",
  "columns" : {
    "name" : "col",
    "type" : "INTEGER",
    "primary_key" : false
  },
  "data" : {
    "col" : 0.1
  }
}

响应示例

状态码: 200

请求成功

{
  "watermarks" : [ "watermark" ]
}

状态码: 400

参数错误

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

SDK代码示例

SDK代码示例如下。

提取数据水印,水印密钥是key,字段类型列表中数据的字段名称为col,该字段为非主键。

 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
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;

public class ShowDatabaseWaterMarkSolution {

    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();
        ShowDatabaseWaterMarkRequest request = new ShowDatabaseWaterMarkRequest();
        ExtractedDatabaseWatermark body = new ExtractedDatabaseWatermark();
        body.withWatermarkKey("key");
        request.withBody(body);
        try {
            ShowDatabaseWaterMarkResponse response = client.showDatabaseWaterMark(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());
        }
    }
}

提取数据水印,水印密钥是key,字段类型列表中数据的字段名称为col,该字段为非主键。

 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
# 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 = ShowDatabaseWaterMarkRequest()
        request.body = ExtractedDatabaseWatermark(
            watermark_key="key"
        )
        response = client.show_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)

提取数据水印,水印密钥是key,字段类型列表中数据的字段名称为col,该字段为非主键。

 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
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.ShowDatabaseWaterMarkRequest{}
	request.Body = &model.ExtractedDatabaseWatermark{
		WatermarkKey: "key",
	}
	response, err := client.ShowDatabaseWaterMark(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

请求成功

400

参数错误

错误码

请参见错误码