嵌入工程图纸水印 - CreateEngineeringDrawingWatermark
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
POST /v1/{project_id}/watermark/embed/engineering-drawing
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,用于标识用户所属的项目,实现权限控制和资源隔离。获取方法请参见获取项目ID和名称。 约束限制: 不涉及 取值范围: 长度为32个字符 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| drawing_type | 是 | String | 参数解释: 图纸类型,指定待处理图纸的文件格式 约束限制: 必填,DWG格式不支持可见水印 取值范围: 默认取值: 不涉及 |
| visible_watermark | 否 | String | 参数解释: 可见水印,嵌入到图纸中的可见水印内容 约束限制: 与盲水印至少填写一个 取值范围: 字符串类型,支持中文字符、英文字母、数字、"_"、"-",长度1~256个字符 默认取值: 不涉及 |
| blind_watermark | 否 | String | 参数解释: 盲水印,嵌入到图纸中的不可见水印内容 约束限制: 与可见水印至少填写一个 取值范围: 字符串类型,支持中文字符、英文字母和数字,长度1~256个字符 默认取值: 不涉及 |
| density | 否 | Integer | 参数解释: 水印密度,图纸嵌入水印的密集程度 约束限制: 不涉及 取值范围: 1~100 默认取值: 不涉及 |
| strength | 否 | Integer | 参数解释: 水印强度,图纸嵌入水印的强度值 约束限制: 不涉及 取值范围: 1~100 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| file | 是 | File | 参数解释: 待加水印图纸文件 约束限制: 必填,支持edif、odb、svgz、dwg等图纸格式,文件大小存在上限限制 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| - | File | 参数解释: 加水印后的文件流,以二进制文件形式返回 取值范围: 不涉及 |
请求示例
向EDIF工程图纸中嵌入可见水印和盲水印。
/v1/2b31ed520abcd1234ebedb6e57123456/watermark/embed/engineering-drawing?drawing_type=edif&visible_watermark=机密&blind_watermark=blind-demo
响应示例
状态码:200
{
"description" : "返回加水印后的文件流"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求已成功 |
错误码
请参见错误码。