提取工程图纸水印 - ExtractEngineeringDrawingWatermark
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
POST /v1/{project_id}/watermark/extract/engineering-drawing
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,用于标识用户所属的项目,实现权限控制和资源隔离。获取方法请参见获取项目ID和名称。 约束限制: 不涉及 取值范围: 长度为32个字符 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| region_id | 否 | String | 参数解释: 区域ID,用于指定文件所在OBS服务的区域。获取方法请参见获取区域列表。 约束限制: 当input_type为obs时,该参数必填 取值范围: 不涉及 默认取值: 不涉及 |
| drawing_type | 是 | String | 参数解释: 图纸类型 约束限制: 必填 取值范围: 默认取值: 不涉及 |
| input_type | 是 | String | 参数解释: 输入方式,指定图纸文件是通过文件流上传还是通过OBS文件地址输入 约束限制: 必填 取值范围: 默认取值: 不涉及 |
| file_address | 否 | String | 参数解释: 图纸文件地址,用于指定待提取水印的图纸文件在OBS上的存储路径 约束限制: 当input_type为obs时该参数必填 取值范围: 格式为obs://bucket/file,字符串长度1~2048个字符 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| file | 否 | File | 参数解释: 待提取水印的图纸文件 约束限制: 当input_type为file时必填,支持edif、odb、svgz、dwg等图纸格式,文件大小存在上限限制 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| watermark | String | 参数解释: 从工程图纸中提取的盲水印内容 取值范围: 字符串类型,长度1~256个字符 |
请求示例
从EDIF工程图纸中提取盲水印。
/v1/{project_id}/watermark/extract/engineering-drawing?drawing_type=edif&input_type=file 响应示例
状态码:200
{
"watermark" : "blind-demo"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求已成功 |
错误码
请参见错误码。