調用該接口向人臉底庫添加一個用戶。
使用說明
- 單個阿里云賬號調用該接口的每秒請求數(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 | 接口返回碼:
|
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 | 是否調用成功:
|
示例
請求示例
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
}
文檔內容是否對您有幫助?