调用该接口，查询指定V系列边缘一体机已关联的所有设备组。

限制条件

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

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

调试

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

请求参数

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

系统规定参数。取值：QueryFaceDeviceGroupsByDevice。
DeviceName String 是 TestDevice

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

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

实例ID。

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

注意

如果公共实例没有ID，请参见如何获取实例ID。

IsolationId String 是 ZheJiangHZ

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

PageNo Integer 是 1

指定从返回结果中的第几页开始显示。最小取值为1。
PageSize Integer 是 20

返回结果中，每页显示的记录数量。最大取值100，最小取值1，默认取值为20。
ProductKey String 是 a1Tp7KY****

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

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

返回数据

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

接口返回码：

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

调用成功时，返回的数据。
DeviceGroupList Array of deviceGroupList

设备组列表。
DeviceGroupId String jykv****

设备组ID。
DeviceGroupName String TestDeviceGroup

设备组名称。
ModifiedTime String 2020-05-12 17:12:37

最后一次更新设备组信息的时间。
PageNo Integer 1

当前页码。
PageSize Integer 20

返回结果中每页显示的记录数量。
Total Integer 5

设备组总数。
ErrorMessage String request parameter error

调用失败时，返回的出错信息。
RequestId String 0A13279A-5640-45E7-87AA-83750541AD0E

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

是否调用成功：

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

示例

请求示例

http(s)://linkvisual.cn-shanghai.aliyuncs.com/?Action=QueryFaceDeviceGroupsByDevice
&DeviceName=TestDevice
&IotInstanceId=iot_instc_pu****_c*-v64********
&IsolationId=ZheJiangHZ
&PageNo=1
&PageSize=20
&ProductKey=a1Tp7KY****
&<公共请求参数>

正常返回示例

XML格式 

<QueryFaceDeviceGroupsByDeviceResponse>
	  <RequestId>0A13279A-5640-45E7-87AA-83750541AD0E</RequestId>
	  <Data>
		    <PageSize>20</PageSize>
		    <Total>5</Total>
		    <DeviceGroupList>
			      <ModifiedTime>2020-05-12 17:12:37</ModifiedTime>
			      <DeviceGroupName>TestDeviceGroup</DeviceGroupName>
			      <DeviceGroupId>jykv****</DeviceGroupId>
		    </DeviceGroupList>
		    <PageNo>1</PageNo>
	  </Data>
	  <Code>200</Code>
	  <Success>true</Success>
</QueryFaceDeviceGroupsByDeviceResponse>

JSON格式 

{
    "RequestId": "0A13279A-5640-45E7-87AA-83750541AD0E",
    "Data": {
        "PageSize": 20,
        "Total": 5,
        "DeviceGroupList": {
            "ModifiedTime": "2020-05-12 17:12:37",
            "DeviceGroupName": "TestDeviceGroup",
            "DeviceGroupId": "jykv****"
        },
        "PageNo": 1
    },
    "Code": "200",
    "Success": true
}