API 文档

获取人员查重任务列表

最近更新时间:2020-04-02 08:10:05

我的收藏

1. 接口描述

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

获取人员查重任务列表,按任务创建时间逆序(最新的在前面)。

只保留最近1年的数据。

默认接口请求频率限制:20次/秒。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:GetCheckSimilarPersonJobIdList。
Version String 公共参数,本接口取值:2018-03-01。
Region String 公共参数,本接口不需要传递此参数。
Offset Integer 起始序号,默认值为0。
Limit Integer 返回数量,默认值为10,最大值为1000。

3. 输出参数

参数名称 类型 描述
JobIdInfos Array of JobIdInfo 人员查重任务信息列表。
JobIdNum Integer 查重任务总数量。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 调用成功示例

输入示例

https://iai.tencentcloudapi.com/?Action=GetCheckSimilarPersonJobIdList
&Limit=2
&Version=2018-03-01
&<公共请求参数>

输出示例

{
  "Response": {
    "JobIdInfos": [
      {
        "JobId": "d6dGLOcFSISPtIfy",
        "StartTime": 1576567050654,
        "JobStatus": 0
      },
      {
        "JobId": "251006443_merge_person_1576565489_wjBy9I3B",
        "StartTime": 1576565489239,
        "JobStatus": 2
      }
    ],
    "JobIdNum": 408,
    "RequestId": "6434816c-3b15-4f26-b909-8f5a8452cd58"
  }
}

示例2 调用失败示例

输入示例

https://iai.tencentcloudapi.com/?Action=GetCheckSimilarPersonJobIdList
&Limit=1001
&Version=2018-03-01
&<公共请求参数>

输出示例

{
  "Response": {
    "Error": {
      "Code": "InvalidParameterValue.LimitExceed",
      "Message": "返回数量不在合法范围内。"
    },
    "RequestId": "3bc56633-5efd-4cff-8dfb-08ac6f88a8b9"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.AcrossVersionsError 该操作不支持跨算法模型版本。
FailedOperation.JobIdNotExist 人员查重记录不存在。
FailedOperation.JobNotExist 没有人员查重记录。
FailedOperation.RequestTimeout 后端服务超时。
FailedOperation.ServerError 算法服务异常,请重试。
InternalError 内部错误。
InvalidParameter 参数错误
InvalidParameter.InvalidParameter 参数不合法。
ResourceUnavailable.Delivering 资源正在发货中。
ResourceUnavailable.Freeze 帐号已被冻结。
ResourceUnavailable.GetAuthInfoError 获取认证信息失败。
ResourceUnavailable.InArrears 帐号已欠费。
ResourceUnavailable.LowBalance 余额不足。
ResourceUnavailable.NotExist 计费状态未知,请确认是否已在控制台开通服务。
ResourceUnavailable.NotReady 服务未开通。
ResourceUnavailable.Recover 资源已被回收。
ResourceUnavailable.StopUsing 帐号已停服。
ResourceUnavailable.UnknownStatus 计费状态未知。
ResourcesSoldOut.ChargeStatusException 计费状态异常。
UnsupportedOperation.UnknowMethod 未知方法名。
目录