Extracting a Data Watermark

Function

This API is used to extract a data watermark.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.

Request Parameters

**Table 2** Request header 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).

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
watermark_key	Yes	String	Watermark key
columns	Yes	Array of Columns objects	Field type list, which cannot exceed 100.
data	Yes	Array of Map<String,Object> objects	Watermark data records, which cannot exceed 30,000.

**Table 4** Columns
Parameter	Mandatory	Type	Description
name	Yes	String	Field name, which can contain a maximum of 256 characters.
type	Yes	String	Field type. Enumeration values: INTEGER STRING DOUBLE
primary_key	Yes	Boolean	Whether a field in the database table is a primary key.

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
watermarks	Array of strings	List of watermarks extracted. The uploaded data may include different watermarks. All watermarks extracted are returned, and the number of watermarks cannot exceed 100.

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error Code
error_msg	String	Error Message

Example Requests

Extract data watermarks. The watermark key is "key", and the data field of the data type table is "col". This field is not a primary key.

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

Example Responses

Status code: 200

Request successful.

{
  "watermarks" : [ "watermark" ]
}

Status code: 400

Parameter error.

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

Status Codes

Status Code	Description
200	Request successful.
400	Parameter error.

Error Codes

See Error Codes.

Parent Topic: Data Watermarking

Previous topic: Injecting a Data Watermark

Next topic: Resource Management

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot