文档

AddFaceDeviceToDeviceGroup

更新时间:

调用该接口添加V系列边缘一体机到设备组。

限制条件

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

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

调试

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

请求参数

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

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

DeviceGroupId String jykv****

设备组ID。请传入在调用AddFaceDeviceGroup接口创建设备组后,获取并保存到本地的设备组ID。

DeviceName String TestDevice

V系列边缘一体机对应的设备名称。请在边缘计算控制台V系列边缘一体机的主机详情页面基本信息页签,找到视频网关信息,获取DeviceName值。

IsolationId String ZheJiangHZ

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

ProductKey String a1Tp7KY****

V系列边缘一体机对应的设备所属产品唯一标识。请在边缘计算控制台V系列边缘一体机的主机详情页面基本信息页签,找到视频网关信息,获取ProductKey值。

IotInstanceId String iot_instc_pu****_c*-v64********

实例ID。

您可在物联网平台控制台的实例概览页面,查看当前实例的ID。若有ID值,必须传入该ID值,否则调用会失败。

说明 如果公共实例没有ID值,请参见如何获取实例ID

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

返回数据

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

接口返回码:

  • 200:表示成功。
  • 其它:表示错误码。错误码详情,请参见错误码
ErrorMessage String device not exist

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

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

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

Success Boolean true

是否调用成功:

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

示例

请求示例

http(s)://linkvisual.cn-shanghai.aliyuncs.com/?Action=AddFaceDeviceToDeviceGroup
&DeviceGroupId=jykv****
&DeviceName=TestDevice
&IsolationId=ZheJiangHZ
&ProductKey=a1Tp7KY****
&<公共请求参数>

正常返回示例

XML格式

<AddFaceDeviceToDeviceGroupResponse>
      <RequestId>0A13279A-5640-45E7-87AA-83750541AD0E</RequestId>
      <Code>200</Code>
      <Success>true</Success>
</AddFaceDeviceToDeviceGroupResponse>

JSON格式

{
    "RequestId": "0A13279A-5640-45E7-87AA-83750541AD0E",
    "Code": "200",
    "Success": true
}
  • 本页导读 (1)