調用該接口,檢查指定的用戶,是否在指定的V系列邊緣一體機上同步人臉成功。
限制條件
單個阿里云賬號調用該接口的每秒請求數(QPS)最大限制為100。
說明 RAM用戶共享阿里云賬號配額。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
請求參數
名稱 | 類型 | 是否必選 | 示例值 | 描述 |
Action | String | 是 | CheckFaceUserDoExistOnDevice | 系統規定參數。取值:CheckFaceUserDoExistOnDevice。 |
DeviceName | String | 是 | TestDevice-1 | V系列邊緣一體機對應的設備名稱。在邊緣計算控制臺V系列邊緣一體機的主機詳情頁面基本信息頁簽,找到視頻網關信息,獲取DeviceName值。 |
IsolationId | String | 是 | ZheJiangHZ | 業務隔離ID,用于隔離同一個阿里云賬號下不同業務應用之間的數據。請與調用AddFaceUser接口添加用戶時設置的IsolationId保持一致。 |
ProductKey | String | 是 | a1Tp7KY**** | V系列邊緣一體機對應的設備所屬產品唯一標識。在邊緣計算控制臺V系列邊緣一體機的主機詳情頁面基本信息頁簽,找到視頻網關信息,獲取ProductKey值。 |
UserId | String | 是 | tibce3fsgqjh**** | 用戶ID。請傳入在調用AddFaceUser接口添加用戶后,獲取并保存到本地的用戶ID。 |
IotInstanceId | String | 否 | iot_instc_pu****_c*-v64******** | 實例ID。 您可在物聯網平臺控制臺的實例概覽頁面,查看當前實例的ID。若有ID值,必須傳入該ID值,否則調用會失敗。 說明 如果公共實例沒有ID值,請參見如何獲取實例ID。 |
調用API時,除了本文介紹的該API的特有請求參數,還需傳入公共請求參數。公共請求參數說明,請參見公共參數文檔。
返回數據
名稱 | 類型 | 示例值 | 描述 |
Code | String | 200 | 接口返回碼:
|
Data | Struct | 調用成功時,返回的數據。 |
|
DoExist | Boolean | true | 指定用戶是否在指定V系列邊緣一體機上同步人臉成功:
|
ErrorMessage | String | face user not exist | 調用失敗時,返回的出錯信息。 |
RequestId | String | 0A13279A-5640-45E7-87AA-83750541AD0E | 阿里云為該請求生成的唯一標識符。 |
Success | Boolean | true | 是否調用成功:
|
示例
請求示例
http(s)://linkvisual.cn-shanghai.aliyuncs.com/?Action=CheckFaceUserDoExistOnDevice
&DeviceName=TestDevice-1
&IsolationId=ZheJiangHZ
&ProductKey=a1Tp7KY****
&UserId=tibce3fsgqjh****
&<公共請求參數>
正常返回示例
XML
格式
<CheckFaceUserDoExistOnDeviceResponse>
<RequestId>0A13279A-5640-45E7-87AA-83750541AD0E</RequestId>
<Data>
<DoExist>true</DoExist>
</Data>
<Code>200</Code>
<Success>true</Success>
</CheckFaceUserDoExistOnDeviceResponse>
JSON
格式
{
"RequestId": "0A13279A-5640-45E7-87AA-83750541AD0E",
"Data": {
"DoExist": true
},
"Code": "200",
"Success": true
}
文檔內容是否對您有幫助?