文档

QueryFaceUserByName

更新时间:

调用该接口通过人脸名称查找人脸数据。

使用说明

单个阿里云账号调用该接口的每秒请求数(QPS)最大限制为100。

说明 RAM用户共享阿里云账号配额。

调试

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

请求参数

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

系统规定参数。取值:QueryFaceUserByName。

IsolationId String ZheJiangHZ

业务隔离ID,用于隔离同一个阿里云账号下不同业务应用之间的数据。请与调用AddFaceUser接口添加用户时设置的IsolationId保持一致。

PageNo Integer 1

指定从返回结果中的第几页开始显示。最小取值为1。

PageSize Integer 10

返回结果中,每页显示的记录数量。最大取值50,最小取值1。

Name String Tony

用户名。支持中文、英文字母大小写、数字、下划线(_)和短划线(-),长度不超过64个字符。

支持模糊匹配,若不填,则为全量匹配。

Params String {"key1":"value1", "key2":"value2"}

用户参数,请自定义。

支持匹配搜索,但不支持模糊匹配。

调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数文档。

返回数据

名称 类型 示例值 描述
Code String 200

接口返回码:

  • 200:表示成功。
  • 其它:表示错误码。错误码详情,请参见错误码
Data Struct

调用成功时,返回的数据。

List Array of pageData

调用成功时,返回的人脸信息列表。

CreateTime Long 1636427314000

创建人脸数据的13位时间戳,单位为毫秒。

CustomUserId String 1234567890

用户身份识别ID。

FacePicList Array of facePicList

用户的人脸图片信息列表。

FaceMd5 String TestFaceMd5

用户人脸图片的MD5值。

FaceUrl String https://example.com/test.jpeg

用户的人脸图片URL地址。

FeatureDTOList Array of featureDTO

人脸特征值列表。

AlgorithmName String TestAlgorithmName

算法名。

AlgorithmProvider String TestAlgorithmProvider

算法提供者。

AlgorithmVersion String TestAlgorithmVersion

算法版本。

ErrorCode String 200

算法返回码:

  • 200:表示成功。
  • 其它:表示错误码。错误码详情,请参见错误码
ErrorMessage String parameter error

算法执行出错时,返回的错误信息。

FaceMd5 String TestFaceMd5

人脸特征的MD5值。

ModifyTime Long 1636436864000

最后一次修改人脸数据的时间戳,单位为毫秒。

Name String Tony

用户名。

Params String {"key1":"value1", "key2":"value2"}

自定义的用户参数。

UserId String 3mtjaqebeq4d****

用户ID。

Page Integer 1

当前页面号。

PageSize Integer 15

每页显示的条数。

Total Integer 8

总条数。

ErrorMessage String face user not exist

调用失败时,返回的出错信息。

RequestId String 0A13279A-5640-45E7-87AA-83750541AD0E

阿里云为该请求生成的唯一标识符。

Success Boolean true

是否调用成功:

  • true:调用成功。
  • false:调用失败。

示例

请求示例

http(s)://linkvisual.cn-shanghai.aliyuncs.com/?Action=QueryFaceUserByName
&IsolationId=ZheJiangHZ
&PageNo=1
&PageSize=10
&<公共请求参数>

正常返回示例

XML格式

<QueryFaceUserByNameResponse>
  <RequestId>0A13279A-5640-45E7-87AA-83750541AD0E</RequestId>
  <Data>
        <PageSize>15</PageSize>
        <Total>1</Total>
        <Page>1</Page>
        <List>
              <ModifyTime>1636436864000</ModifyTime>
              <UserId>3mtjaqebeq4d****</UserId>
              <CreateTime>1636427314000</CreateTime>
              <Params>{"key1":"value1", "key2":"value2"}</Params>
              <CustomUserId>1234567890</CustomUserId>
              <Name>Tony</Name>
              <FacePicList>
                    <FaceMd5>TestFaceMd5</FaceMd5>
                    <FaceUrl>https://example.com/test.jpeg</FaceUrl>
                    <FeatureDTOList>
                          <AlgorithmVersion>TestAlgorithmVersion</AlgorithmVersion>
                          <ErrorCode>200</ErrorCode>
                          <AlgorithmProvider>TestAlgorithmProvider</AlgorithmProvider>
                          <FaceMd5>TestFaceMd5</FaceMd5>
                          <AlgorithmName>TestAlgorithmName</AlgorithmName>
                    </FeatureDTOList>
              </FacePicList>
        </List>
  </Data>
  <Code>200</Code>
  <Success>true</Success>
</QueryFaceUserByNameResponse>

JSON格式

{
    "RequestId": "0A13279A-5640-45E7-87AA-83750541AD0E",
    "Data": {
        "PageSize": "15",
        "Total": "1",
        "Page": "1",
        "List": [
            {
                "ModifyTime": "1636436864000",
                "UserId": "3mtjaqebeq4d****",
                "CreateTime": "1636427314000",
                "Params": "{\"key1\":\"value1\", \"key2\":\"value2\"}",
                "CustomUserId": "1234567890",
                "Name": "Tony",
                "FacePicList": [
                    {
                        "FaceMd5": "TestFaceMd5",
                        "FaceUrl": "https://example.com/test.jpeg",
                        "FeatureDTOList": [
                            {
                                "AlgorithmVersion": "TestAlgorithmVersion",
                                "ErrorCode": "200",
                                "AlgorithmProvider": "TestAlgorithmProvider",
                                "FaceMd5": "TestFaceMd5",
                                "AlgorithmName": "TestAlgorithmName"
                            }
                        ]
                    }
                ]
            }
        ]
    },
    "Code": "200",
    "Success": true
}
  • 本页导读 (1)