调用getPersonFacesInfo接口查询个体的人脸信息,例如人脸图片的ID、人脸图片的URL。

QPS限制

本接口的单用户QPS限制为20次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。

请求语法

POST /green/sface/faces HTTPS|HTTP

请求头

该接口使用公共请求头,无特殊请求头。请参见公共请求头

请求参数

名称 类型 是否必选 示例值 描述
clientInfo JSONObject {"userId":"120234234","userNick":"Mike","userType":"others"} 客户端信息,由ClientInfo结构体通过JSON序列化获得,包含umid、imei等信息,具体结构描述,请参见ClientInfo

RequestBody

RequestBody中还需要输入以下参数,用来指定要查询的个体信息。

名称 类型 是否必选 示例值 描述
personId String person1 要查询的个体ID。
faceIds Array ["11111","2222"] 人脸图片的ID。
说明 如果您未输入该参数,则返回指定个体ID下的所有人脸图片的ID。

响应参数

所有请求均返回JSON格式的数据。关于返回数据中的公共字段,请参见公共返回参数。返回数据中的data字段表示与业务相关的数据,一般是一个JSON结构体或数组。
说明 响应出错的情况下,data字段可能为空。

该接口返回的data字段包含以下参数。

名称 类型 示例值 描述
code Integer 200 错误码,和HTTP状态码一致。

更多信息,请参见公共错误码

faceImageItems JSONArray person1 指定个体的人脸对象列表。数组中每个元素是一个结构体。
success Boolean true 人脸信息是否查询成功。取值:
  • true:表示查询成功。
  • false:表示查询失败。
faceId Long 2****************6 人脸图片的ID。
url String https://www.aliyundoc.com/aaa.jpg 人脸图片的URL。

示例

请求示例
POST /green/sface/faces HTTP/1.1
公共请求头
{
    "personId": "person1",
    "faceIds":["1111","22222"]
}
正常返回示例
{
    "code":200,
    "requestId":"82E9202A-183F-4DDE-A45E-D554F8FA8D7B",
    "data":{
        "code":200,
        "faceImageItems":[
            {
                "success":true,
                "faceId":2****************6,
                "url":"https://www.aliyundoc.com/aaa.jpg"
            }
        ]
    }
}

错误码

访问错误中心查看更多错误码。