文档首页> 数据安全中心 DSC> API参考> API说明> 文档水印> 文档提取暗水印(文档地址版本)
更新时间:2023-10-07 GMT+08:00

文档提取暗水印(文档地址版本)

功能介绍

支持对已嵌入文字暗水印的WORD(.docx),PPT(.pptx),EXCEL(.xlsx),PDF(.pdf)类型的文档进行水印提取,用户传入待提取水印的文档地址(目前支持OBS),DSC服务以JSON的格式返回从文档里提取的出的文字暗水印内容。

URI

POST /v1/{project_id}/doc-address/watermark/extract

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

表3 请求Body参数

参数

是否必选

参数类型

描述

region_id

String

项目所在region的id,如:xx-xx-1。

doc_type

String

待提取水印的文档类型

枚举值:

  • WORD

  • EXCEL

  • PDF

  • PPT

src_file

String

待提取文字暗水印的文档的地址,当前只支持OBS对象,格式为 obs://bucket/object ,其中bucket为和当前项目处于同一区域的OBS桶名称,object为对象全路径名。例如:obs://hwbucket/hwinfo/hw.doc,其中obs://表示OBS存储,hwbucket为桶名,hwinfo/hw.doc为对象全路径名。

file_password

String

解密文件的密码, 最大支持长度256。如果Office文档有读密码或域控的权限密码,请输入读密码,或者有读权限的域控密码。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

watermark

String

暗水印内容,长度不超过32个字节

状态码: 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

请求示例

提取obs://hwbucket/hwinfo/hw.docx路径下的WORD文档中的暗水印。

POST /v1/{project_id}/doc-address/watermark/extract

{
  "region_id" : "xx-xx-1",
  "src_file" : "obs://hwbucket/hwinfo/hw.docx",
  "doc_type" : "WORD"
}

响应示例

状态码: 200

请求成功

{
  "watermark" : "blind_watermark"
}

状态码: 400

无效请求

{
  "error_code" : "DSC.00000007",
  "error_msg" : "File format error"
}

状态码

状态码

描述

200

请求成功

400

无效请求

错误码

请参见错误码