按地址嵌入工程图纸水印 - CreateEngineeringDrawingWatermarkByAddress
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
POST /v1/{project_id}/drawing-address/watermark/embed
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,用于标识用户所属的项目,实现权限控制和资源隔离。获取方法请参见获取项目ID和名称。 约束限制: 不涉及 取值范围: 长度为32个字符 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| engineer_drawing_embed_wm_by_address_info | 是 | 参数解释: 按地址嵌入图纸水印信息 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| region_id | 是 | String | 参数解释: 区域ID,用于指定文件所在OBS服务的区域。获取方法请参见获取区域列表。 约束限制: 必填 取值范围: 格式为xx-xx-1,由小写字母、数字和连字符组成,长度1~64个字符 默认取值: 不涉及 |
| src_file | 是 | String | 参数解释: 源图纸文件地址 约束限制: 必填 取值范围: 不涉及 默认取值: 不涉及 |
| dst_file | 是 | String | 参数解释: 加水印后图纸文件地址 约束限制: 必填 取值范围: 不涉及 默认取值: 不涉及 |
| drawing_type | 是 | String | 参数解释: 图纸类型 约束限制: 必填 取值范围: edif-EDIF图纸,odb-ODB++图纸 默认取值: 不涉及 |
| blind_watermark | 否 | String | 参数解释: 盲水印,嵌入到图纸中的不可见水印内容 约束限制: 与可见水印至少填写一个 取值范围: 字符串类型,支持中文字符、英文字母和数字,长度1~256个字符 默认取值: 不涉及 |
| visible_watermark | 否 | String | 参数解释: 可见水印,嵌入到图纸中的可见水印内容 约束限制: 与盲水印至少填写一个 取值范围: 字符串类型,支持中文字符、英文字母、数字、"_"、"-",长度1~256个字符 默认取值: 不涉及 |
| density | 否 | Integer | 参数解释: 水印密度,图纸嵌入水印的密集程度 约束限制: 可选 取值范围: 1~100 默认取值: 不涉及 |
| strength | 否 | Integer | 参数解释: 水印强度,图纸嵌入水印的强度值 约束限制: 可选 取值范围: 1~100 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| region_id | String | 参数解释: 区域ID,用于标识文件所在OBS服务的区域 取值范围: 格式为xx-xx-1,由小写字母、数字和连字符组成,长度1~64个字符 |
| watermarked_file | String | 参数解释: 加水印后图纸文件地址 取值范围: 不涉及 |
请求示例
对OBS地址中的工程图纸嵌入水印。
{
"engineer_drawing_embed_wm_by_address_info" : {
"region_id" : "cn-north-4",
"src_file" : "obs://bucket/a.edif",
"dst_file" : "obs://bucket/a-mark.edif",
"drawing_type" : "edif",
"blind_watermark" : "blind-demo"
}
} 响应示例
状态码:200
{
"region_id" : "cn-north-4",
"watermarked_file" : "obs://bucket/a-mark.edif"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求已成功 |
错误码
请参见错误码。