調用該接口,添加用戶組與設備組之間的人臉同步關系。
使用說明
- 單個阿里云賬號調用該接口的每秒請求數(QPS)最大限制為100。說明 RAM用戶共享阿里云賬號配額。
- 調用該接口后,系統會返回用戶組與設備組同步關系控制ID(ControlId),建議保存該值到本地,以便后續調用其它接口時使用。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
請求參數
名稱 | 類型 | 是否必選 | 示例值 | 描述 |
Action | String | 是 | AddFaceUserGroupAndDeviceGroupRelation | 系統規定參數。取值:AddFaceUserGroupAndDeviceGroupRelation。 |
DeviceGroupId | String | 是 | jykv**** | 設備組ID。請傳入在調用AddFaceDeviceGroup接口創建設備組后,獲取并保存到本地的設備組ID。 |
IsolationId | String | 是 | ZheJiangHZ | 業務隔離ID,用于隔離同一個阿里云賬號下不同業務應用之間的數據。 重要 用戶組和設備組,必須在同一個隔離ID下。請與調用AddFaceUserGroup接口創建用戶組,和調用AddFaceDeviceGroup接口創建設備組時設置的IsolationId保持一致。 |
Relation | String | 是 | SYNC_INFO_PICTURE | 人臉同步關系。當前僅支持設置為SYNC_INFO_PICTURE,表示同步用戶照片和用戶信息。 |
UserGroupId | String | 是 | kvjy**** | 用戶組ID。請傳入在調用AddFaceUserGroup接口創建用戶組后,獲取并保存到本地的用戶組ID。 |
IotInstanceId | String | 否 | iot_instc_pu****_c*-v64******** | 實例ID。 您可在物聯網平臺控制臺的實例概覽頁面,查看當前實例的ID。若有ID值,必須傳入該ID值,否則調用會失敗。 說明 如果公共實例沒有ID值,請參見如何獲取實例ID。 |
調用API時,除了本文介紹的該API的特有請求參數,還需傳入公共請求參數。公共請求參數說明,請參見公共參數文檔。
返回數據
名稱 | 類型 | 示例值 | 描述 |
Code | String | 200 | 接口返回碼:
|
Data | Struct | 調用成功時,返回的數據。 |
|
ControlId | String | qcb2yea4ha4d**** | 用戶組與設備組同步關系控制ID。 說明 在人臉底庫服務的其它接口調用中,會使用ControlId,請妥善保存。 |
ModifiedTime | String | 2020-11-20 18:59:01 | 添加用戶組與設備組之間的人臉同步關系時間。 |
ErrorMessage | String | face group not exist | 調用失敗時,返回的出錯信息。 |
RequestId | String | 0A13279A-5640-45E7-87AA-83750541AD0E | 阿里云為該請求生成的唯一標識符。 |
Success | Boolean | true | 是否調用成功:
|
示例
請求示例
http(s)://linkvisual.cn-shanghai.aliyuncs.com/?Action=AddFaceUserGroupAndDeviceGroupRelation
&DeviceGroupId=jykv****
&IsolationId=ZheJiangHZ
&Relation=SYNC_INFO_PICTURE
&UserGroupId=kvjy****
&<公共請求參數>
正常返回示例
XML
格式
<AddFaceUserGroupAndDeviceGroupRelationResponse>
<RequestId>0A13279A-5640-45E7-87AA-83750541AD0E</RequestId>
<Data>
<ModifiedTime>2020-11-20 18:59:01</ModifiedTime>
<ControlId>qcb2yea4ha4d****</ControlId>
</Data>
<Code>200</Code>
<Success>true</Success>
</AddFaceUserGroupAndDeviceGroupRelationResponse>
JSON
格式
{
"RequestId": "0A13279A-5640-45E7-87AA-83750541AD0E",
"Data": {
"ModifiedTime": "2020-11-20 18:59:01",
"ControlId": "qcb2yea4ha4d****"
},
"Code": "200",
"Success": true
}
文檔內容是否對您有幫助?