文档中心>API 中心

人员库升级结果查询

最近更新时间:2024-04-03 11:20:19

我的收藏

1. 接口描述

此接口处于预下线状态 。

预计下线时间:2023-05-10 16:23:24

接口请求域名: iai.tencentcloudapi.com 。

避免官网歧义

人员库升级结果查询

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:GetUpgradeGroupFaceModelVersionResult。
Version String 公共参数,本接口取值:2020-03-03。
Region String 公共参数,详见产品支持的 地域列表
JobId String 升级任务ID,用于查询、获取人员库升级的进度和结果。
示例值:251007453_upgrade_group_qta_1596529493_gjwh07X7

3. 输出参数

参数名称 类型 描述
EndTimestamp Integer 人员升级任务预估结束时间。 StartTimestamp的值是自 Unix 纪元时间到人员查重任务预估结束的毫秒数。
Unix 纪元时间是 1970 年 1 月 1 日星期四,协调世界时 (UTC) 00:00:00。
如果为0表示这个任务已经执行完毕。
示例值:1596529510000
Progress Float 升级任务完成进度。取值[0.0,100.0]。
示例值:100
Status Integer 0表示升级中,1表示升级完毕,2表示回滚完毕,3表示升级失败。
示例值:1
StartTime Integer 升级起始时间。
StartTime的值是自 Unix 纪元时间到Group创建时间的毫秒数。
Unix 纪元时间是 1970 年 1 月 1 日星期四,协调世界时 (UTC) 00:00:00。
有关更多信息,请参阅 Unix 时间。
示例值:1596529493217
FromFaceModelVersion String 当前算法模型版本。
示例值:2.0
ToFaceModelVersion String 目标算法模型版本。
示例值:3.0
GroupId String 人员库ID。
示例值:100001testGroupUpgrade
FailedFacesUrl String 无法升级的人脸Id信息,文件格式为json。内容参见下方示例。url有效期为半小时。
示例值:"https://iaiface-upgradegroup-failedface-1254418846.cos.ap-guang
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 人员库升级结果查询(升级中)

人员库升级中(Status返回0)

输入示例

https://iai.tencentcloudapi.com/?Action=GetUpgradeGroupFaceModelVersionResult
&JobId=251007453_upgrade_group_qta_1596529493_gjwh07X7
&<公共请求参数>

输出示例

{
    "Response": {
        "Progress": 77,
        "EndTimestamp": 1607091150000,
        "Status": 0,
        "StartTime": 1607073566782,
        "FromFaceModelVersion": "2.0",
        "GroupId": "965e41210ab6eaf56dee78bad4743b23",
        "FailedFacesUrl": "",
        "ToFaceModelVersion": "3.0",
        "RequestId": "3c834d55-967a-4795-9beb-4c877418cd79"
    }
}

示例2 人员库升级结果查询(升级失败)

人员库升级失败(Status返回3),FailedFacesUrl包含失败人脸信息,需对失败人脸信息删除后进行重新升级。如果FailedFacesUrl返回值是空,可能是系统失败,可以重新发起一次升级。
失败人脸信息示例:
[{
face_id: "3758206365629500199",
person_id: "testGroupUpgradePerson1100001"
}, {
face_id: "3758206372549784459",
person_id: "testGroupUpgradePerson2100001"
}]

输入示例

https://iai.tencentcloudapi.com/?Action=GetUpgradeGroupFaceModelVersionResult
&JobId=251007453_upgrade_group_qta_1596529493_gjwh07X7
&<公共请求参数>

输出示例

{
    "Response": {
        "Progress": 100,
        "EndTimestamp": 1607058209000,
        "Status": 3,
        "StartTime": 1607058207375,
        "FromFaceModelVersion": "3.0",
        "GroupId": "test_2_upgrade",
        "FailedFacesUrl": "https://iaiface-upgradegroup-failedface-1254418846.cos.ap-guangzhou.myqcloud.com/1253657503/1253657503_upgrade_group_1607058207_qW6RX1UO.json",
        "ToFaceModelVersion": "2.0",
        "RequestId": "b667bf57-b40f-4618-9ef4-eb2d350eb068"
    }
}

示例3 人员库升级结果查询(升级成功)

人员库升级成功(Status返回1)

输入示例

https://iai.tencentcloudapi.com/?Action=GetUpgradeGroupFaceModelVersionResult
&JobId=251007453_upgrade_group_qta_1596529493_gjwh07X7
&<公共请求参数>

输出示例

{
    "Response": {
        "Progress": 100,
        "EndTimestamp": 1596529510000,
        "Status": 1,
        "StartTime": 1596529493217,
        "FromFaceModelVersion": "2.0",
        "GroupId": "100001testGroupUpgrade",
        "FailedFacesUrl": "",
        "ToFaceModelVersion": "3.0",
        "RequestId": "b0835106-e301-4959-90d5-f982007bb4c8"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation.RequestTimeout 后端服务超时。
FailedOperation.ServerError 算法服务异常,请重试。
FailedOperation.UpgradeJobIdNotExist 人员库升级任务不存在。
InvalidParameter.InvalidParameter 参数不合法。
InvalidParameterValue.GroupIdNotExist 人员库ID不存在。
ResourceUnavailable.InArrears 账号已欠费。
ResourceUnavailable.NotExist 计费状态未知,请确认是否已在控制台开通服务。
ResourceUnavailable.StopUsing 账号已停服。
ResourcesSoldOut.ChargeStatusException 计费状态异常。