調用該接口通過人臉名稱查找人臉數據。
使用說明
單個阿里云賬號調用該接口的每秒請求數(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 | 接口返回碼:
|
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 | 算法返回碼:
|
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 | 是否調用成功:
|
示例
請求示例
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
}
文檔內容是否對您有幫助?