文档嵌入水印（文件地址版本）
功能介绍
对WORD(.docx)，PPT(.pptx)，EXCEL(.xlsx)，PDF(.pdf)*类型的文档嵌入文字暗水印、文字明水印或者图片明水印，用户传入待加水印的文档地址（目前支持OBS)和水印相关信息，DSC服务对文档加完水印后返回给用户已嵌入水印的文档的存放地址。
URI
POST /v1/{project_id}/doc-address/watermark/embed
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务“获取用户Token接口”获取（响应消息头中X-Subject-Token的值） |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
region_id |
是 |
String |
项目所在region的id，如：xx-xx-1。 |
|
src_file |
是 |
String |
待添加水印的文档地址，当前只支持OBS对象，格式为 obs://bucket/object ，其中bucket为和当前项目处于同一区域的OBS桶名称，object为对象全路径名。例如：obs://hwbucket/hwinfo/hw.png，其中obs://表示OBS存储，hwbucket为桶名，hwinfo/hw.png为对象全路径名。 |
|
doc_type |
是 |
String |
待嵌入水印的文档类型。 枚举值：
|
|
dst_file |
否 |
String |
添加水印后的文档存放地址，格式和要求同src_file字段，不设置时，默认取src_file的值，即添加水印后覆盖原文件。 |
|
blind_watermark |
否 |
String |
暗文字水印内容，与“visible_watermark”字段至少有一个不为空 |
|
visible_watermark |
否 |
String |
明文字水印内容，与暗水印“blind_watermark”字段至少有一个不为空。 |
|
image_mark |
否 |
String |
待嵌入的图形明水印文件的地址, 字段格式要求同src_file字段，图形文件的格式必须为“png”或“jpg”，否则返回参数错误；图像文件大小不超过1MB |
|
visible_type |
否 |
String |
该字段控制明水印嵌入文字还是图片。默认为TEXT类型，需填写visible_watermark字段设置明文字水印； 当该字段为IMAGE时，需填写image_watermark字段设置水印图片地址此时 ，“visible_watermark”，“font_size”，“rotation”和“opacity”字段无效。 枚举值：
|
|
file_password |
否 |
String |
待加水印文件有密码时，读取文件的密码， 最大支持长度256。如果Office文档有读密码或域控的权限密码，请输入读密码，或者有读权限的域控密码。 |
|
marked_file_password |
否 |
String |
添加水印后给文件设置密码， 最大支持长度256。默认不加文档密码。 |
|
readonly_password |
否 |
String |
添加水印后给文件设置只读密码， 最大支持长度256。默认不加只读密码。 |
|
front |
否 |
Integer |
明水印字体大小，取值为[1,100]，默认值50 |
|
rotation |
否 |
Integer |
明水印旋转角度，逆时针方向，取值为[0,90]，默认值45。 |
|
opacity |
否 |
Float |
明水印的透明度，取值[0,1]，默认值为0.3； |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
region_id |
String |
当前项目所在region的id，如：xx-xx-1。 |
|
watermarked_file |
String |
添加水印后的文档地址，当前只支持OBS对象，格式为 obs://bucket/object ，其中bucket为和当前项目处于同一区域的OBS桶名称，object为对象全路径名。例如：obs://hwbucket/hwinfo/hw.doc，其中obs://表示OBS存储，hwbucket为桶名，hwinfo/hw.doc为对象全路径名。 |
状态码： 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误信息 |
请求示例
POST /v1/{project_id}/doc-address/watermark/embed
{
"region_id" : "xx-xx-1",
"src_file" : "obs://hwbucket/hwinfo/hw.doc",
"doc_type" : "WORD",
"blind_watermark" : "blind_watermark",
"visible_watermark" : "visible_watermark"
}
响应示例
状态码： 200
请求成功
{
"region_id" : "xx-xx-1",
"watermarked_file" : "obs://hwbucket/hwinfo/hw.docx"
}
状态码： 400
无效请求
{
"error_code" : "DSC.00000007 ",
"error_msg" : "File format error"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求成功 |
|
400 |
无效请求 |
错误码
请参见错误码。
