ListFaceGroups 获取人脸分组列表_SetFaceGroups 人脸聚类_图片管理类操作_API手册

描述

接口公测中，如有任何使用问题请联系我们

获取一个 Set 内的人脸分组列表。

请求参数

Parameter	Type	Required	Comment
Project	string	Y	Project
SetId	string	Y	媒体集 SetId
Marker	string	N	Marker 翻页标记
Limit	int	N	每页显示数量，范围 [1,100] ，默认 20
OrderBy	string	N	排序字段，可选值为 CreateTime / ModifyTime / FaceCount ，默认 FaceCount
Order	string	N	排序顺序，可选值为 ASC / DESC ，默认 DESC

返回参数

Parameter	Type	Comment
Groups	[]Group	人脸分组列表。
NextMarker	string	Marker 翻页标记

数据类型 Group

Parameter	Type	Comment
GroupName	string	人脸分组名称，自定义字段。
GroupId	string	人脸分组 ID 。
FaceCount	int	组内人脸数量。
CreateTime	string	人脸分组的创建时间。
ModifyTime	string	人脸分组的修改时间。
GroupCoverFace	[]GroupCoverFace	该组的封面人脸。

数据类型 GroupCoverFace

Parameter	Type	Comment
FaceId	string	人脸 ID 。
FaceBoundary	Boundary	人脸框。
ImageUri	string	人脸所属图片的 OSS URI 。

示例

请求示例

POST https://imm.cn-shanghai.aliyuncs.com
?Action=ListFaceGroups
&Project=test-project
&SetId=test-set
...

此处的示例，目的是展示关键参数，还需要其他的公共参数才能正常调用，推荐使用 SDK 来发送 API。

成功返回示例

{
  "FaceGroups": [
    {
      "GroupName": "Test",
      "CreateTime": "2019-02-20T09:35:51.057Z",
      "ModifyTime": "2019-02-20T09:35:51.057Z",
      "FaceCount": 5,
      "GroupId": "Group-45af612b-8024-4987-94ae-6b14374f0ec1",
      "GroupCoverFace": {
        "FaceBoundary": {
          "Top": 141,
          "Height": 200,
          "Width": 201,
          "Left": 132
        },
        "FaceId": "ee93c2669430aedf5d521f98e47571e380fa046c68a80ffca9d7758c984e53a9",
        "ImageUri": "oss://imm-dev-wmt/facegroup/05.jpg"
      }
    }
  ],
  "RequestId": "87A90190-85DF-407A-A395-1E8898286656",
  "NextMarker": ""
}

若在使用中有疑问，请参考 FAQ，或者进入钉钉用户群实时交流。