调用该接口,根据用户身份识别ID,查询用户ID。

限制条件

单个阿里云账号调用该接口的每秒请求数(QPS)最大限制为100。

说明 RAM用户共享阿里云账号配额。

调试

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

请求参数

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

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

CustomUserId String 1234567890

用户身份识别ID。请与调用AddFaceUser接口添加用户时设置的CustomUserId保持一致。

IsolationId String ZheJiangHZ

业务隔离ID,用于隔离同一个阿里云账号下不同业务应用之间的数据。请与调用AddFaceUser接口添加用户时设置的IsolationId保持一致。

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

返回数据

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

接口返回码:

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

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

CustomUserId String 1234567890

用户身份识别ID。

Name String TestName

用户名。

Params String selfKey

自定义参数。

UserId String 3mtjaqebeq4d****

用户ID。

ErrorMessage String customuserid not exist

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

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

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

Success Boolean true

是否调用成功:

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

示例

请求示例

http(s)://linkvisual.cn-shanghai.aliyuncs.com/?Action=QueryFaceUserIdByCustomUserId
&CustomUserId=1234567890
&IsolationId=ZheJiangHZ
&<公共请求参数>

正常返回示例

XML格式

<QueryFaceUserIdByCustomUserIdResponse>
	  <RequestId>0A13279A-5640-45E7-87AA-83750541AD0E</RequestId>
	  <Data>
		    <UserId>3mtjaqebeq4d****</UserId>
		    <Params>{selfKey}</Params>
		    <CustomUserId>1234567890</CustomUserId>
		    <Name>TestName</Name>
	  </Data>
	  <Code>200</Code>
	  <Success>true</Success>
</QueryFaceUserIdByCustomUserIdResponse>

JSON格式

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