调用该接口向人脸底库添加一个用户。

使用说明

  • 单个阿里云账号调用该接口的每秒请求数(QPS)最大限制为100。
    说明 RAM用户共享阿里云账号配额。
  • 请提前为用户的人脸图片,配置URL下载地址。
    说明 当前仅支持JPEG和JPG格式的图片,且图片URL中不能包含中文。
  • 调用该接口后,系统会返回用户ID(UserId),建议保存该值到本地,以便后续调用其它接口时使用。

调试

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

请求参数

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

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

CustomUserId String 1234567890

用户身份识别ID,支持英文大写字母和数字。

建议您设置为该用户的身份证号、学号等。

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

用户的人脸图片URL下载地址,目前仅支持JPEG和JPG格式的图片,且图片URL不能包含中文。

IsolationId String ZheJiangHZ

业务隔离ID,用于同一个阿里云账号下不同业务应用之间的数据隔离,支持英文大小写字母、数字。

例如,您在A地区和B地区,均有人脸识别业务,那么可设置不同的业务隔离ID,区分A、B地区的人脸识别业务。

注意

请妥善保存业务隔离ID值,以便后续调用此业务隔离区其它接口时使用。

Name String Tony

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

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

用户参数,请自定义。

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

返回数据

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

接口返回码:

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

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

CustomUserId String 1234567890

用户身份识别ID。

Name String Tony

用户名。

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

自定义的用户参数。

UserId String 3mtjaqebeq4d****

系统为本次添加的用户生成的ID。

说明 在人脸底库服务的其它接口调用中,会使用UserId,请妥善保存。
ErrorMessage String face user already exist

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

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

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

Success Boolean true

是否调用成功:

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

示例

请求示例

http(s)://linkvisual.cn-shanghai.aliyuncs.com/?Action=AddFaceUser
&CustomUserId=1234567890
&FacePicUrl=https://example.com/test.jpeg
&IsolationId=ZheJiangHZ
&Name=Tony
&<公共请求参数>

正常返回示例

XML格式

<AddFaceUserResponse>
      <RequestId>0A13279A-5640-45E7-87AA-83750541AD0E</RequestId>
      <Data>
            <UserId>3mtjaqebeq4d****</UserId>
            <CustomUserId>1234567890</CustomUserId>
            <Name>Tony</Name>
      </Data>
      <Code>200</Code>
      <Success>true</Success>
</AddFaceUserResponse>

JSON格式

{
    "RequestId": "0A13279A-5640-45E7-87AA-83750541AD0E",
    "Data": {
        "UserId": "3mtjaqebeq4d****",
        "CustomUserId": "1234567890",
        "Name": "Tony"
    },
    "Code": "200",
    "Success": true
}