1. 接口描述
接口请求域名： bda.tencentcloudapi.com 。
获取指定人体库中的人员列表。
默认接口请求频率限制：300次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：GetPersonList。 |
| Version | 是 | String | 公共参数，本接口取值：2020-03-24。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-beijing, ap-chengdu, ap-guangzhou, ap-nanjing, ap-shanghai 。 |
| GroupId | 是 | String | 人体库ID。 |
| Offset | 否 | Integer | 起始序号，默认值为0。 |
| Limit | 否 | Integer | 返回数量，默认值为10，最大值为1000。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| PersonInfos | Array of PersonInfo | 返回的人员信息。 |
| PersonNum | Integer | 该人体库的人员数量。 |
| BodyModelVersion | String | 人体识别所用的算法模型版本。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 调用失败示例
输入示例
POST / HTTP/1.1
Host: bda.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetPersonList
<公共请求参数>
{
"GroupId": "testG10",
"Offset": 0,
"Limit": 1001
}输出示例
{
"Response": {
"Error": {
"Code": "InvalidParameterValue.LimitExceed",
"Message": "返回数量不在合法范围内。"
},
"RequestId": "c803e3eb-25b4-48d9-b4df-b74c570d110b"
}
}示例2 调用成功示例
输入示例
POST / HTTP/1.1
Host: bda.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetPersonList
<公共请求参数>
{
"GroupId": "testG10",
"Offset": 0,
"Limit": 10
}输出示例
{
"Response": {
"PersonNum": 1,
"BodyModelVersion": "1.0",
"PersonInfos": [
{
"PersonName": "testG10P1",
"PersonId": "testG10P1",
"TraceInfos": [
{
"TraceId": "3524775577730961229",
"BodyIds": [
"3524775577730961229-0"
]
}
]
}
],
"RequestId": "2e1841c2-81ee-42db-98ac-6c056aafe9b3"
}
}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.InnerError | 服务内部错误，请重试。 |
| FailedOperation.RequestEntityTooLarge | 整个请求体太大（通常主要是图片）。 |
| FailedOperation.RequestTimeout | 后端服务超时。 |
| FailedOperation.RpcFail | RPC请求失败，一般为算法微服务故障。 |
| InvalidParameter.InvalidParameter | 参数不合法。 |
| InvalidParameterValue.GroupIdIllegal | 人体库ID包含非法字符。人体库ID只支持英文、数字、-%@#&_。 |
| InvalidParameterValue.GroupIdNotExist | 人体库ID不存在。 |
| InvalidParameterValue.GroupIdTooLong | 人体库ID超出长度限制。 |
| InvalidParameterValue.LimitExceed | 返回数量不在合法范围内。 |
| InvalidParameterValue.OffsetExceed | 起始序号过大。请检查需要请求的数组长度。 |
| ResourceUnavailable.InArrears | 账号已欠费。 |
| ResourceUnavailable.NotExist | 计费状态未知，请确认是否已在控制台开通服务。 |
| UnsupportedOperation.UnknowMethod | 未知方法名。 |
