API 文档

获取人员库信息

最近更新时间:2020-04-28 08:10:47

1. 接口描述

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

获取人员库信息。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:GetGroupInfo。
Version String 公共参数,本接口取值:2018-03-01。
Region String 公共参数,本接口不需要传递此参数。
GroupId String 人员库 ID。

3. 输出参数

参数名称 类型 描述
GroupName String 人员库名称
GroupId String 人员库ID
GroupExDescriptions Array of String 人员库自定义描述字段
Tag String 人员库信息备注
FaceModelVersion String 人脸识别所用的算法模型版本。
CreationTimestamp Integer Group的创建时间和日期 CreationTimestamp。CreationTimestamp 的值是自 Unix 纪元时间到Group创建时间的毫秒数。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取人员库信息

输入示例

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

输出示例

{
  "Response": {
    "GroupName": "aaa",
    "GroupId": "aaa",
    "GroupExDescriptions": [
      "24"
    ],
    "Tag": "fdsaf",
    "FaceModelVersion": "3.0",
    "CreationTimestamp": 1559530931613,
    "RequestId": "6faa05d0-287b-464e-8755-cf3e8d0c703d"
  }
}

5. 开发者资源

API Explorer

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

SDK

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

命令行工具

6. 错误码

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

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