- What's New
- Function Overview
- Service Overview
- Billing
- Getting Started
-
User Guide
- Service Provisioning
- Allowing or Disallowing Access to Cloud Assets
- Asset Map
- Asset Management
- Sensitive Data Identification
- Policy Center
- Data Asset Protection
- Data Security Operations
- Alarm Notifications
- Multi-Account Management
- Permissions Management
- Key DSC Operations
- Best Practices
-
API Reference
- Before You Start
- Calling APIs
-
API Description
- Data Watermarking
- Resource Management
- Dynamic Data Masking
- Alarm Notifications
-
Image Watermarking
- Injecting Invisible Watermarks into Images
- Extracting Invisible Text Watermarks
- Extracting Invisible Watermarks from Images
- Injecting Invisible Watermarks into Images (Image Addresses)
- Extracting Dark Watermarks from Images (Image Addresses)
- Extracting Invisible Image Watermarks from Images (Image Addresses)
- Asset Management
- Document Watermarking
-
Sensitive Data Discovery
- Querying the Identification Task List
- Querying the Result of an Identification Task
- Viewing the Rule List
- Creating a Sensitive Data Scanning Rule
- Modifying a Sensitive Data Scanning Rule
- Deleting a Sensitive Data Scanning Rule
- Querying Sensitive Data Scanning Rule Groups
- Creating a Sensitive Data Scanning Rule Group
- Deleting a Sensitive Data Scanning Rule Group
- Creating a Sensitive Data Scanning Task
- Deleting a Sensitive Data Scanning Task
- Static Data Masking
- API Call Records
- Appendixes
- SDK Reference
-
FAQs
- Product Consulting
- Regions and AZs
- Asset Authorization
-
Sensitive Data Identification and Masking
- What Services Can Use DSC to Scan for Sensitive Data?
- How Long Does It Take for DSC to Identify and Mask Sensitive Data?
- What Are the Built-in Identification Rules of DSC?
- What Are the Identification Rules in the Built-in Identification Template of DSC?
- Does Data Masking Affect My Raw Data?
- Does DSC Have Specific Requirements on the Character Set for Which Sensitive Data Is to Be Identified and Masked?
- Why Cannot I Find a Table in an Existing Database When Creating a Database Data Masking Task?
- Data Watermarking
- Data Usage Audit
- Videos
-
More Documents
-
User Guide (ME-Abu Dhabi Region)
- Service Overview
- Service Provisioning
- Assets
- Overview
- Sensitive Data Identification
- Data Masking
- Data Watermarking
- Alarm Notifications
- Permissions Management
-
FAQs
- Product Consulting
- Adding Data Assets
-
Sensitive Data Identification and Masking
- What Services Can Use DSC to Scan for Sensitive Data?
- How Long Does It Take for DSC to Identify and Mask Sensitive Data?
- Which Types of Sensitive Data Can Be Identified by DSC?
- Does Data Masking Affect My Raw Data?
- Does DSC Have Specific Requirements on the Character Set for Which Sensitive Data Is to Be Identified and Masked?
- How Do I Add Multiple Identification Rule Groups?
- Data Watermarking
- Change History
-
API Reference (ME-Abu Dhabi Region)
- Before You Start
- Calling APIs
-
API Description
- Data Watermarking
- Resource Management
- Dynamic Data Masking
- Alarm Notifications
-
Image Watermarking
- Injecting Invisible Watermarks into Images
- Extracting Invisible Text Watermarks
- Extracting Invisible Watermarks from Images
- Injecting Invisible Watermarks into Images (Image Addresses)
- Extracting Dark Watermarks from Images (Image Addresses)
- Extracting Invisible Image Watermarks from Images (Image Addresses)
- Asset Management
- Document Watermarking
-
Sensitive Data Discovery
- Querying the Identification Task List
- Querying the Result of an Identification Task
- Viewing the Rule List
- Creating a Sensitive Data Scanning Rule
- Modifying a Sensitive Data Scanning Rule
- Deleting a Sensitive Data Scanning Rule
- Querying Sensitive Data Scanning Rule Groups
- Creating a Sensitive Data Scanning Rule Group
- Deleting a Sensitive Data Scanning Rule Group
- Creating a Sensitive Data Scanning Task
- Querying the Database Lineage Graph
- Querying the Table Lineage Graph in Pages
- Querying Data Linage Graph at the Column Level
- Querying the OBS Bucket Lineage Graph
- Querying the OBS File Linage Graph in Pages
- Static Data Masking
- API Call Records
- Appendixes
- Change History
-
User Guide (ME-Abu Dhabi Region)
- General Reference
Copied.
Injecting Watermarks into Documents
Function
This API is used to inject invisible text watermarks, visible text watermarks, or visible image watermarks into Word (.docx), PPT (.pptx), Excel (.xlsx), and PDF (.pdf) files. You need to pass file and watermark information in formData format to this API, DSC returns the binary stream of the watermarked file.
URI
POST /v1/{project_id}/sdg/doc/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 |
---|---|---|---|
doc_type |
Yes |
String |
Type of the document into which a watermark is injected. Enumeration values:
|
file_password |
No |
String |
This API is used to read file passwords, which can contain a maximum of 256 characters. If an Office Word document requires a password for read or domain control, you need to enter the password to open the file. |
marked_file_password |
No |
String |
This API is used to set a password for the file after the watermark is added. The maximum length is 256 characters. The file is not encrypted by default and does not require a password. |
readonly_password |
No |
String |
This API is used to set a password for reading the file after the watermark is added. The maximum length is 256 characters. By default, the file is not encrypted for reading and does not require a password. |
visible_watermark |
No |
String |
Visible watermark content. |
font_size |
No |
String |
Font size of a visible watermark. The value ranges from 1 to 100, and the default value is 50. |
rotation |
No |
String |
Font angle of a visible watermark, in anticlockwise direction. The value range is [0, 90], and the default value is 45. |
opacity |
No |
String |
Transparency of a visible watermark. The value range is [0, 1], and the default value is 0.3. |
blind_watermark |
No |
String |
Invisible watermark content. |
file |
Yes |
File |
Document into which a watermark is injected. |
image_mark |
No |
File |
Image added in the document as the watermark. The image must be in the PNG or JPG format and cannot exceed 1 MB. The value of name in Content-Disposition in the API request must be set to image_mark. |
visible_type |
No |
String |
Type of visible watermark. The default value of this field is TEXT. When this field is set to IMAGE:
Enumeration values:
|
Response Parameters
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error Code |
error_msg |
String |
Error Message |
Example Requests
Submit the request using the form. The "file" indicates a specified document.
POST /v1/{project_id}/sdg/doc/watermark/embed { "file" : "test.doc", "doc_type" : "WORD", "opacity" : "0.1", "font_size" : "30", "rotation" : "45", "blind_watermark" : "blind_watermark", "visible_watermark" : "visible_watermark" }
Example Responses
Status code: 200
Request successful.
"{\"Watermarked document\"}"
Status code: 400
Invalid request.
{ "error_code" : "DSC.00000007 ", "error_msg" : "File format error" }
Status Codes
Status Code |
Description |
---|---|
200 |
Request successful. |
400 |
Invalid request. |
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