1. 接口描述
接口请求域名： iai.tencentcloudapi.com 。
获取人员库信息。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：GetGroupInfo。 |
| Version | 是 | String | 公共参数，本接口取值：2020-03-03。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| GroupId | 是 | String | 人员库 ID，取值为创建人员库接口中的GroupId。 示例值：32 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| GroupName | String | 人员库名称。 示例值：正式人员名单 |
| GroupId | String | 人员库ID。 示例值：31 |
| GroupExDescriptions | Array of String | 人员库自定义描述字段。 示例值：["年龄"] |
| Tag | String | 人员库信息备注。 示例值：无实习生 |
| FaceModelVersion | String | 人脸识别所用的算法模型版本。 示例值：3.0 |
| CreationTimestamp | Integer | Group的创建时间和日期。CreationTimestamp 的值是自 Unix 纪元时间到Group创建时间的毫秒数。 示例值：1694139227378 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取人员库信息成功示例
输入示例
https://iai.tencentcloudapi.com/?Action=GetGroupInfo
&GroupId=31
&<公共请求参数>输出示例
{
"Response": {
"GroupName": "人员库",
"GroupId": "31",
"GroupExDescriptions": [
"年龄"
],
"Tag": "不含实习生",
"FaceModelVersion": "3.0",
"CreationTimestamp": 1559530931613,
"RequestId": "6faa05d0-287b-464e-8755-cf3e8d0c703d"
}
}示例2 获取人员库信息失败示例
输入示例
https://iai.tencentcloudapi.com/?Action=GetGroupInfo
&GroupId=200
&<公共请求参数>输出示例
{
"Response": {
"Error": {
"Code": "InvalidParameterValue.GroupIdNotExist",
"Message": "人员库ID不存在。"
},
"RequestId": "0e77ad29-ad65-4901-9efc-b49a6e0a357b"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.RequestLimitExceeded | 请求频率超过限制。 |
| FailedOperation.RequestTimeout | 后端服务超时。 |
| FailedOperation.ServerError | 算法服务异常，请重试。 |
| InvalidParameterValue.GroupIdIllegal | 人员库ID包含非法字符。人员库ID只支持英文、数字、-%@#&_。 |
| InvalidParameterValue.GroupIdNotExist | 人员库ID不存在。 |
| InvalidParameterValue.GroupIdTooLong | 人员库ID超出长度限制。 |
| ResourceUnavailable.InArrears | 账号已欠费。 |
| ResourceUnavailable.NotExist | 计费状态未知，请确认是否已在控制台开通服务。 |
| ResourceUnavailable.StopUsing | 账号已停服。 |
| ResourcesSoldOut.ChargeStatusException | 计费状态异常。 |
