本文介绍查询人脸样本列表ListFaceEntities的语法及示例。

功能描述

ListFaceEntities用于查询人脸数据库中的人脸样本列表。

前提条件

请确保您已开通人脸人体服务,若未开通服务请立即开通

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String ListFaceEntities

要执行的操作。取值:ListFaceEntities。

DbName String default

数据库名称。

Offset Integer 1

起始记录。

Limit Integer 50

每页最多显示的样本数目。

Token String 2

当查询结果超过2000条时,需要使用上一次请求返回的Token作为请求下一页的参数。

Labels String 鹿班

标签,最多支持10个标签,多个标签以英文逗号(,)分割。

EntityIdPrefix String U1

样本ID,包含数字、字母和下划线。

Order String asc

排列方式。包括asc(升序)和desc(降序)。

返回数据

名称 类型 示例值 描述
Data Struct

返回的结果数据内容。

Entities Array of Entity

查询到的实体数据。

CreatedAt Long 1589203871832

人脸样本的创建时间。

DbName String default

人脸样本所在的数据库名称。

EntityId String 222

实体ID,如员工编号。

FaceCount Integer 3

人脸样本包含的人脸数量。

Labels String 鹿班

查询到的人脸数据标签。

UpdatedAt Long 1589203871832

人脸样本的更新时间。

Token String 2

当查询结果超过2000条时,可以使用Token来查询下一页的数据。

TotalCount Integer 200

人脸样本的总数量。

RequestId String DA7CAFEB-0A37-4496-9CDF-E3DBB6309CB2

请求ID。

示例

请求示例

http(s)://facebody.cn-shanghai.aliyuncs.com/?Action=ListFaceEntities
&DbName=default
&Offset=1
&<公共请求参数>

正常返回示例

XML 格式

<RequestId>DA7CAFEB-0A37-4496-9CDF-E3DBB6309CB2</RequestId>
<Data>
    <Token>2</Token>
    <TotalCount>200</TotalCount>
    <Entities>
        <DbName>default</DbName>
        <EntityId>222</EntityId>
        <FaceCount>3</FaceCount>
        <Labels>鹿班</Labels>
        <CreatedAt>1589203871832</CreatedAt>
        <UpdatedAt>1589203871832</UpdatedAt>
    </Entities>
</Data>

JSON 格式

{
  "RequestId": "DA7CAFEB-0A37-4496-9CDF-E3DBB6309CB2",
  "Data": {
    "Token": "2",
    "TotalCount":"200",
    "Entities": [
      {
        "DbName": "default",
        "EntityId": "222",
        "FaceCount": "3",
        "Labels": "鹿班",
        "CreatedAt":"1589203871832",
        "UpdatedAt":"1589203871832"
      }
    ]
  }
}

错误码

关于查询人脸样本列表的错误码,详情请参见常见错误码

SDK参考

阿里云视觉AI能力支持使用SDK调用,具体可参见SDK总览下载安装。

安全声明

  • 请确保上传的图片或文件来源符合相应的法律法规。
  • 通过体验调试上传的临时文件有效期为1小时,在24小时后会被系统自动清理删除。