QueryFaceUser
更新時間:
調(diào)用該接口查詢指定用戶信息。
限制條件
單個阿里云賬號調(diào)用該接口的每秒請求數(shù)(QPS)最大限制為100。
說明 RAM用戶共享阿里云賬號配額。
調(diào)試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
請求參數(shù)
名稱 | 類型 | 是否必選 | 示例值 | 描述 |
Action | String | 是 | QueryFaceUser | 系統(tǒng)規(guī)定參數(shù)。取值:QueryFaceUser。 |
IsolationId | String | 是 | ZheJiangHZ | 業(yè)務(wù)隔離ID,用于隔離同一個阿里云賬號下不同業(yè)務(wù)應(yīng)用之間的數(shù)據(jù)。請與調(diào)用AddFaceUser接口添加用戶時設(shè)置的IsolationId保持一致。 |
UserId | String | 是 | 3mtjaqebeq4d**** | 用戶ID。請傳入在調(diào)用AddFaceUser接口添加用戶后,獲取并保存到本地的用戶ID。 |
調(diào)用API時,除了本文介紹的該API的特有請求參數(shù),還需傳入公共請求參數(shù)。公共請求參數(shù)說明,請參見公共參數(shù)文檔。
返回數(shù)據(jù)
名稱 | 類型 | 示例值 | 描述 |
Code | String | 200 | 接口返回碼:
|
Data | Struct | 調(diào)用成功時,返回的數(shù)據(jù)。 |
|
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 | 算法執(zhí)行出錯時,返回的錯誤信息。 |
FaceMd5 | String | TestFaceMd5 | 人臉特征的MD5值。 |
Name | String | Tony | 用戶名。 |
Params | String | {"key1":"value1", "key2":"value2"} | 自定義的用戶參數(shù)。 |
UserId | String | 3mtjaqebeq4d**** | 用戶ID。 |
ErrorMessage | String | face user not exist | 調(diào)用失敗時,返回的出錯信息。 |
RequestId | String | 0A13279A-5640-45E7-87AA-83750541AD0E | 阿里云為該請求生成的唯一標(biāo)識符。 |
Success | Boolean | true | 是否調(diào)用成功:
|
示例
請求示例
http(s)://linkvisual.cn-shanghai.aliyuncs.com/?Action=QueryFaceUser
&IsolationId=ZheJiangHZ
&UserId=3mtjaqebeq4d****
&<公共請求參數(shù)>
正常返回示例
XML
格式
<QueryFaceUserResponse>
<RequestId>0A13279A-5640-45E7-87AA-83750541AD0E</RequestId>
<Data>
<UserId>3mtjaqebeq4d****</UserId>
<Params>{"key1":"value1", "key2":"value2"}</Params>
<CustomUserId>1234567890</CustomUserId>
<FacePicList>
<FaceMd5>TestFaceMd5</FaceMd5>
<FaceUrl>https://example.com/test.jpeg</FaceUrl>
</FacePicList>
<FacePicList>
<FeatureDTOList>
<AlgorithmVersion>TestAlgorithmVersion</AlgorithmVersion>
<ErrorCode>200</ErrorCode>
<AlgorithmProvider>TestAlgorithmProvider</AlgorithmProvider>
<FaceMd5>TestFaceMd5</FaceMd5>
<AlgorithmName>TestAlgorithmName</AlgorithmName>
</FeatureDTOList>
</FacePicList>
<Name>TestName</Name>
</Data>
<Code>200</Code>
<Success>true</Success>
</QueryFaceUserResponse>
JSON
格式
{
"RequestId": "0A13279A-5640-45E7-87AA-83750541AD0E",
"Data": {
"UserId": "3mtjaqebeq4d****",
"Params":"{\"key1\":\"value1\", \"key2\":\"value2\"}",
"CustomUserId": "1234567890",
"FacePicList": [
{
"FaceMd5": "TestFaceMd5",
"FaceUrl": "https://example.com/test.jpeg"
},
{
"FeatureDTOList": {
"AlgorithmVersion": "TestAlgorithmVersion",
"ErrorCode": "200",
"AlgorithmProvider": "TestAlgorithmProvider",
"FaceMd5": "TestFaceMd5",
"AlgorithmName": "TestAlgorithmName"
}
}
],
"Name": "TestName"
},
"Code": "200",
"Success": true
}
文檔內(nèi)容是否對您有幫助?