获取盲水印异步提取任务信息--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

获取盲水印异步提取任务信息

最近更新时间：2025.05.12 20:47:51首次发布时间：2025.05.12 20:47:51

指定任务 ID，获取提交盲水印异步提取任务的执行信息。

注意事项

计费说明：盲水印功能属于附加组件下智能处理模块，属于后付费计费，使用后会产生附加组件智能处理费用。
请求频率：
- 前景图层水印模型（彩色背景通用）：单用户请求频率限制为 3 次/秒。
- 其他模型：单用户请求频率限制为 5 次/秒。
超时时间：约为 50 秒。
服务地址：veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求说明

请求方式：POST
请求地址：https://imagex.volcengineapi.com/?Action=GetImageHmExtractTaskInfo&Version=2023-05-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。

Query

参数类型是否必选示例值描述

Action String 是 GetImageHmExtractTaskInfo 接口名称。当前 API 的名称为 GetImageHmExtractTaskInfo。

Version String 是 2023-05-01 接口版本。当前 API 的版本为 2023-05-01。

参数	类型	是否必选	示例值	描述
Action	String	是	`GetImageHmExtractTaskInfo`	接口名称。当前 API 的名称为 `GetImageHmExtractTaskInfo`。
Version	String	是	`2023-05-01`	接口版本。当前 API 的版本为 `2023-05-01`。
ServiceId	String	是	`97**sh`	提取水印图任务对应的服务 ID。您可以在 veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。

ServiceId

String

是

97**sh

提取水印图任务对应的服务 ID。

您可以在 veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。
您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。

Body

参数	类型	是否必选	示例值	描述
TaskId	String	是	`681b538015***5ca5ac14ef3`	待查询的任务 ID，通过 CreateHmExtractTask 接口返回。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。

参数类型示例值描述

HmInfo String 你好 abc123%^$% 提取出的盲水印文本信息。

参数	类型	示例值	描述
HmInfo	String	`你好 abc123%^$%`	提取出的盲水印文本信息。
TaskStatus	String	`Success`	任务状态。 `Pending`：未开始 `Running`：盲水印信息匹配中 `Success`：提取成功 `Failed`：提取失败
ErrMsg	String	`extract fail`	错误信息。

TaskStatus

String

Success

任务状态。

Pending：未开始
Running：盲水印信息匹配中
Success：提取成功
Failed：提取失败

ErrMsg String extract fail 错误信息。

请求示例

POST https://imagex.volcengineapi.com/?Action=GetImageHmExtractTaskInfo&Version=2023-05-01&ServiceId=97**sh
{
    "TaskId": "681b538015***5ca5ac14ef3"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "GetImageHmExtractTaskInfo",
        "Version": "2023-05-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {
        "HmInfo": "你好 abc123%^$%",
        "TaskStatus": "Success",
        "ErrMsg": "extract fail"
    }
}

错误码

本接口无特有的错误码。更多信息请见公共错误码和 veImageX 错误码。