文档

QueryFaceAllDeviceGroup

更新时间:

调用该接口,查询指定业务隔离ID下的所有设备组。

限制条件

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

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

调试

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

请求参数

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

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

IsolationId String ZheJiangHZ

业务隔离ID。

PageNo Integer 1

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

PageSize Integer 20

返回结果中,每页显示的记录数量。最大取值100,最小取值1,默认取值为20。

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

实例ID。

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

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

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

返回数据

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

接口返回码:

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

调用成功时,返回的数据。

DeviceGroupList Array of deviceGroupList

设备组列表。

DeviceGroupId String jvkv****

设备组ID。

DeviceGroupName String TestDeviceGroup

设备组名称。

ModifiedTime String 2020-05-12 17:19:29

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

PageNo Integer 1

当前页码。

PageSize Integer 20

返回结果中,每页显示的记录数量。

Total Integer 100

设备组总数。

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=QueryFaceAllDeviceGroup
&IsolationId=ZheJiangHZ
&PageNo=1
&PageSize=20
&<公共请求参数>

正常返回示例

XML格式

<QueryFaceAllDeviceGroupResponse>
	  <RequestId>0A13279A-5640-45E7-87AA-83750541AD0E</RequestId>
	  <Data>
		    <PageSize>20</PageSize>
		    <Total>100</Total>
		    <DeviceGroupList>
			      <ModifiedTime>2020-05-12 17:19:29</ModifiedTime>
			      <DeviceGroupName>TestDeviceGroup</DeviceGroupName>
			      <DeviceGroupId>jvkv****</DeviceGroupId>
		    </DeviceGroupList>
		    <PageNo>1</PageNo>
	  </Data>
	  <Code>200</Code>
	  <Success>true</Success>
</QueryFaceAllDeviceGroupResponse>

JSON格式

{
    "RequestId": "0A13279A-5640-45E7-87AA-83750541AD0E",
    "Data": {
        "PageSize": 20,
        "Total": 100,
        "DeviceGroupList": {
            "ModifiedTime": "2020-05-12 17:19:29",
            "DeviceGroupName": "TestDeviceGroup",
            "DeviceGroupId": "jvkv****"
        },
        "PageNo": 1
    },
    "Code": "200",
    "Success": true
}
  • 本页导读 (1)