产品文档

人脸搜索

帮助中心 > 产品文档 > 人脸搜索 > 获取分组列表接口文档

获取人脸分组列表

一、接口描述

1.功能描述

获取用户的所有分组。

2. 接口使用

使用接口前,需要先完成API的下单购买,然后可使用已经封装好的SDK进行相应开发,整体流程详见调用方法

二、请求说明

1. 接口地址 :

 https://aiapi.jdcloud.com/jdai/getFaceGroupList 

2. 请求方式:

https post aiapi.jdcloud.com/jdai/getFaceGroupList

3. 请求参数

(1)header请求参数

业务请求参数

名称 类型 必填 示例值 描述
Authorization string JDCLOUD2-HMAC-SHA256Credential=access... 签名

(2)query请求参数

业务请求参数

名称 类型 必填 示例值 描述
start int 0 查询起始位置
length int 2 从查询起始位置开始查询的长度,默认为5,最高值为5

4. 请求代码示例

建议您使用我们提供的SDK进行调用,SDK获取及调用方式详见sdk的使用方法

三、返回说明

1、返回参数

(1)公共返回参数

名称 类型 示例值 描述
code string 1000 参见错误码-系统级错误码
charge boolean false 或 true false:不扣费, true:扣费
remain long 1305 按天计算剩余调用次数
msg string 查询成功 参见错误码-系统级错误码
result object {...} 查询结果

(2)业务返回参数

名称 类型 示例值 描述
status int 0 返回结果,0表示成功;非0为对应错误号,参见错误码-系统级错误码
message string Success 若status为0,返回分组id,否则返回错误信息,参见错误码-系统级错误码
result string 分组列表

2、返回示例

 {  "status": 0,  "charge": false,  "remain": 97,  "msg": "查询成功",  "result": {  {"result": "  [  {\"createTime\":1543415835000,  \"groupId\":\"31270059-7698-4af1-82d5-7fd66ce772e1\",  \"groupInfo\":\"test\",  \"groupName\":\"test\",  \"maxNumUser\":100000,  \"subIndex\":1,  \"updateTime\":1543415835000}  ]",  "requestid": "081b1c5fe6dc465a9a54d75cedf78051",  "message": "success",  "status": 0  }  } } 

更新时间:2020-04-28 21:14:27