ListFacegroups - 列举人脸分组

列举人脸分组。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求语法

POST /v2/image/list_facegroups HTTP/1.1

请求参数

名称类型必填描述示例值
bodyobject

请求体参数。

drive_idstring

空间 id

1
remarksstring

查询过滤使用, 长度最大 128 字符,采用的是精确匹配过滤

张三
limitinteger

limit 值,n 的取值范围:1~100, 默认 100。

100
markerstring

设定结果从 marker 之后按字母排序的第一个开始返回。如果不设定,则从头开始返回数据。 默认值:无

NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg
return_total_countboolean

是否返回搜到的文件总数

false

返回参数

名称类型描述示例值
object
itemsarray

人脸分组列表

FaceGroup

人脸分组

next_markerstring

下一页起始资源标识符, 最后一页该值为空。

NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg
total_countlong

命中的文件总数

30

示例

正常返回示例

JSON格式

{
  "items": [
    {
      "group_id": "Cluster-ae6e3472-999e-410b-b54e-cd5dba****",
      "group_name": "name",
      "image_count": 10,
      "created_at": "2022-01-14T10:10:52.83948013+08:00",
      "updated_at": "2022-01-14T10:10:52.83948013+08:00",
      "group_cover_url": "https://xxx",
      "group_cover_file_id": "6549c959640fbd517c9b4d93b3b36aecc45xxxxx",
      "group_cover_width": 1920,
      "group_cover_height": 1080,
      "group_cover_face_boundary": {
        "Width": 200,
        "Height": 300,
        "Top": 30,
        "Left": 10
      },
      "remarks": "",
      "remarks_array": [
        ""
      ]
    }
  ],
  "next_marker": "NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg",
  "total_count": 30
}

错误码

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