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

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

Last Article：Injecting a Data Watermark

Next Article：Sensitive Data Discovery

Did you find this page helpful?

Failed to submit the feedback. Please try again later.