获取异步去重任务详情--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

获取异步去重任务详情

最近更新时间：2023.11.16 17:44:39首次发布时间：2022.10.12 11:42:27

本接口支持通过指定异步去重任务 ID 获取对应异步去重任务执行详细情况。

注意事项

请求频率：单用户请求频率限制为 5 次/秒。
超时时间：超时时间约为 20 秒。
服务地址：veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址

请求说明

请求方式：GET
接口地址：https://imagex.volcengineapi.com/?Action=GetDedupTaskStatus&Version=2018-08-01

请求参数

以下请求参数列表仅列出了该接口的部分公共参数，完整公共参数列表见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetDedupTaskStatus`	接口名称。当前 API 的名称为 `GetDedupTaskStatus`。
Version	String	是	`2018-08-01`	接口版本。当前 API 的版本为 `2018-08-01`。
TaskId	String	是	`1982**1027`	任务 ID，您可以通过调用使用图片去重获取结果值接口获取异步去重`TaskId`返回值。

返回参数

参数类型示例值描述

参数	类型	示例值	描述
Status	Int	`0`	异步任务状态，取值如下所示： 0：任务进行中 1：任务执行成功 2：任务执行失败
TaskId	String	`1982**1027`	任务 ID。
Result	Array of Result	`-`	任务执行结果

Status

Int

0

异步任务状态，取值如下所示：

0：任务进行中
1：任务执行成功
2：任务执行失败

TaskId String 1982**1027 任务 ID。

Result Array of Result - 任务执行结果

Result

参数	类型	示例值	描述
Score	String	`1.0`	图片评分，仅在两张图片对比才返回 Score 字段。
Groups	Json	`-`	分组结果，若输入 2 个以上原图时，将按组返回内容相同的图片，每组的图片个数非固定值。

示例

请求示例

GET https://imagex.volcengineapi.com/?Action=GetDedupTaskStatus&Version=2018-08-01&TaskId=testTaskId

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
        "Action": "GetDedupTaskStatus",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1"
    },
    "Result": {
        "Status": 1,
        "Result": {
            "Score": "1.0",
            "Groups": {
                "group0": [
                    "https://test.iamge.cn/obj/tos-cn-i-jc***ko/ee***7e",
                    "https://test.iamge.cn/obj/tos-cn-i-jc***ko/ee***7e"
                ]
            }
     }
}

错误码

访问错误码和附加组件错误码获取详细信息。