文档

AddFaceUserGroupAndDeviceGroupRelation

更新时间:

调用该接口,添加用户组与设备组之间的人脸同步关系。

使用说明

  • 单个阿里云账号调用该接口的每秒请求数(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

接口返回码:

  • 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

是否调用成功:

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

示例

请求示例

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
}
  • 本页导读 (1)