调用该接口查询指定用户信息。
限制条件
单个阿里云账号调用该接口的每秒请求数(QPS)最大限制为100。
说明 RAM用户共享阿里云账号配额。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
Action | String | 是 | QueryFaceUser | 系统规定参数。取值:QueryFaceUser。 |
IsolationId | String | 是 | ZheJiangHZ | 业务隔离ID,用于隔离同一个阿里云账号下不同业务应用之间的数据。请与调用AddFaceUser接口添加用户时设置的IsolationId保持一致。 |
UserId | String | 是 | 3mtjaqebeq4d**** | 用户ID。请传入在调用AddFaceUser接口添加用户后,获取并保存到本地的用户ID。 |
调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数文档。
返回数据
名称 | 类型 | 示例值 | 描述 |
Code | String | 200 | 接口返回码:
|
Data | Struct | 调用成功时,返回的数据。 |
|
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值。 |
Name | String | Tony | 用户名。 |
Params | String | {"key1":"value1", "key2":"value2"} | 自定义的用户参数。 |
UserId | String | 3mtjaqebeq4d**** | 用户ID。 |
ErrorMessage | String | face user not exist | 调用失败时,返回的出错信息。 |
RequestId | String | 0A13279A-5640-45E7-87AA-83750541AD0E | 阿里云为该请求生成的唯一标识符。 |
Success | Boolean | true | 是否调用成功:
|
示例
请求示例
http(s)://linkvisual.cn-shanghai.aliyuncs.com/?Action=QueryFaceUser
&IsolationId=ZheJiangHZ
&UserId=3mtjaqebeq4d****
&<公共请求参数>
正常返回示例
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
}
文档内容是否对您有帮助?