获取分组列表
一、接口描述
1. 功能描述
获取所有人脸分组。
2. 接口使用
平台为每个API提供试用体验服务,您在AI市场选择“免费试用”规格下单后,即可开始体验业内领先的人工智能API服务。 免费试用服务具有调用量、QPS限制,如需更高性能的API服务,可以提交咨询工单,联系京东AI扩容购买。
在获得使用权限后,您可使用已经封装好的SDK/参照接口鉴权规则进行相应开发,整体流程详见 接入流程。
二、请求说明
1. 接口地址:
https://aiapi.jd.com/jdai/groupFetchV1
2. 请求方式:
POST
3. 请求参数
(1)query请求参数
公共请求参数
名称 | 类型 | 必填 | 示例值 | 描述 |
---|---|---|---|---|
appkey | string | 是 | 80d2b762ecb86593f9668526920f46c | 您的appkey,可在买家中心控制台中获取 |
timestamp | long | 是 | 1541491668060 | 请求的时间戳,精确到毫秒,timestamp有效期5分钟 |
sign | string | 是 | 2e148773a0337a8f2200ba90d445f083 | 签名,根据规则MD5(sectetkey+timestamp) |
(2)body请求参数
无
返回说明
1、返回参数
(1)公共返回参数
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
code | string | 1000 | 参见下方错误码-系统级错误码 |
charge | boolean | false 或 true | false:不扣费, true:扣费 |
remainTimes | long | 1305 | 剩余调用次数;免费api:每天剩余调用次数;收费api:剩余次数;无限制时为-1 |
remainSeconds | long | 1223456 | 剩余调用时间(s);免费api:-1;收费api:剩余调用时间;无限制时为-1 |
msg | string | 查询成功 | 参见下方错误码-系统级错误码 |
result | object | {...} | 查询结果 |
(2)业务返回参数
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
code | int | 0 | 状态码,0 为成功,非 0 请参考以下 业务错误码 |
msg | string | Accept | 状态码对应的说明 |
processTimeInMs | long | 34 | 从接收请求到处理结束的耗时,毫秒 |
timestamp | long | 1576728627956 | 返回时的时间戳 |
groups | array | [] | 人脸分组信息数组;具体类型请参考下方 |
groups 数组中单个元素的结构:
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
groupId | string | 5dfb1daa8788720a7305d65f | 人脸分组的唯一 id |
customInfo | string | {} | 请求时输入的 customInfo |
faceCount | int | 26 | 该分组内的人脸个数 |
createTime | long | 1576808089949 | 创建的时间戳 |
updateTime | long | 1576808123367 | 最后一次更新的时间戳 |
2、返回示例
{
"status": 0,
"charge": false,
"remain": 97,
"msg": "查询成功",
"result": {
"code" : 0,
"msg" : "Accept",
"processTimeInMs" : 2,
"timestamp" : 1576729434025,
"groups" : [
{
"createTime" : 1576584622114,
"updateTime" : 1576729150246,
"customInfo" : "{}",
"faceCount" : 26,
"groupId" : "5df8c5ae87887252653b3cec",
"groupName" : "会场人脸签到"
},
{
"createTime" : 1576584623241,
"updateTime" : 1576584623241,
"customInfo" : "{}",
"faceCount" : 46,
"groupId" : "5df8c5af87887252653b3ced",
"groupName" : "三年一班"
}
]
}
}
四、错误码
1.系统级错误码
2.业务错误码
业务错误码(code) | 对应msg | 说明 |
1 | NoRequiredFields | 参数缺失 |
31 | RequestBodyIsNotJson | 请求的 body 需要 json 字符串 |
41 | TimeoutException | 处理超时(> 10秒的处理立即返回) |