QueryDynamicGroupDevices调用该接口查询动态分组下的设备列表

限制说明

目前仅华东2（上海）地域下，企业版实例和新版公共实例，支持动态分组功能。实例详细说明，请参见实例管理。
单个阿里云账号调用该接口的每秒请求数（QPS）最大限制为50。

说明

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

调试

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

调试

请求参数

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


名称	类型	是否必选	示例值	描述
Action	String	是	QueryDynamicGroupDevices	系统规定参数。取值：QueryDynamicGroupDevices。
GroupId	String	是	tDQvBJqbUyHs***	分组ID，分组的全局唯一标识符。您可调用QueryDeviceGroupList接口查询分组ID（GroupId）。
IotInstanceId	String	是	iot-*-v6*	实例ID。您可在物联网平台控制台的实例概览页面，查看当前实例的ID。
PageSize	Integer	否	10	每页记录数，最大值是200，默认值是10。
ProductKey	String	否	a1BwAGV***	设备所属产品的ProductKey。
DeviceName	String	否	light	设备名称。传入此参数时，若FuzzyName同时传入true，会模糊搜索设备，DeviceName值为设备名称的前缀字符串，长度必须大于4个字符。
NextToken	String	否	TGlzdFJlc291***	下一页标识，首次查询无需传入。
CurrentPage	Integer	否	2	指定从返回结果中的第几页开始显示。默认值是1。
Status	String	否	OFFLINE	设备状态。取值： ONLINE：设备在线。 OFFLINE：设备离线。 UNACTIVE：设备未激活。 DISABLE：设备已禁用。
FuzzyName	Boolean	否	true	是否根据DeviceName值，模糊搜索设备。 true：模糊搜索。 false（默认）：不模糊搜索。

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

返回数据

名称	类型	示例值	描述


名称	类型	示例值	描述
Code	String	iot.system.SystemException	调用失败时，返回的错误码。更多信息，请参见错误码。
Data	Array of SimpleDeviceInfo		调用成功后，返回的设备列表，详情参见SimpleDeviceInfo下信息。
SimpleDeviceInfo
ActiveTime	String	2018-08-06 10:48:41	设备的激活时间。
CategoryKey	String	Lighting	产品所属品类的标识符。产品使用了物联网平台预定义的标准品类物模型会返回此参数。
DeviceName	String	light	设备名称。
IotId	String	Q7uOhVRdZRRlDnTLv****00100	物联网平台为该设备颁发的ID，作为该设备的唯一标识符。
LastOnlineTime	String	2018-08-06 13:43:12	设备最近一次上线时间。
Nickname	String	detectors_in_beijing	设备的备注名称。
NodeType	Integer	0	产品的节点类型。取值： 0：设备。设备不能挂载子设备，可以直连物联网平台，也可以作为网关的子设备连接物联网平台。 1：网关。网关可以挂载子设备，具有子设备管理模块，维持子设备的拓扑关系，和将拓扑关系同步到物联网平台。
ProductKey	String	a1rYuVF***	设备所属产品的ProductKey。
ProductName	String	test	设备所属产品的名称。
Status	String	ONLINE	设备状态。取值： ONLINE：设备在线。 OFFLINE：设备离线。 UNACTIVE：设备未激活。 DISABLE：设备已禁用。
UtcActiveTime	String	2018-08-06T02:48:41.000Z	设备的激活时间，UTC格式。
UtcLastOnlineTime	String	2018-08-06T05:43:12.000Z	设备最近一次上线的时间，UTC格式。
ErrorMessage	String	系统异常	调用失败时，返回的出错信息。
NextToken	String	TGlzdFJlc291***	下一页标识。可在下次请求时传入，来获取下一页数据。如果返回值为空，则表示没有下一页数据。
Page	Integer	1	当前页码。
PageCount	Integer	2	总页数。
PageSize	Integer	10	每页所显示的设备数量。
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	阿里云为该请求生成的唯一标识符。
Success	Boolean	true	表示是否调用成功。 true：调用成功。 false：调用失败。
Total	Integer	24	设备总数。

示例

请求示例

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=QueryDynamicGroupDevices
&GroupId=tDQvBJqbUyHs***
&IotInstanceId=iot-***-v6***
&<公共请求参数>

正常返回示例

XML格式

<QueryDynamicGroupDevicesResponse>
  <NextToken>TGlzdFJlc291***</NextToken>
  <PageCount>2</PageCount>
  <PageSize>10</PageSize>
  <RequestId>E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565</RequestId>
  <Total>24</Total>
  <Page>1</Page>
  <Data>
        <SimpleDeviceInfo>
              <LastOnlineTime>2018-08-06 13:43:12</LastOnlineTime>
              <UtcActiveTime>2018-08-06T02:48:41.000Z</UtcActiveTime>
              <Status>ONLINE</Status>
              <IotId>Q7uOhVRdZRRlDnTLv****00100</IotId>
              <CategoryKey>Lighting</CategoryKey>
              <ProductName>test</ProductName>
              <UtcLastOnlineTime>2018-08-06T05:43:12.000Z</UtcLastOnlineTime>
              <ActiveTime>2018-08-06 10:48:41</ActiveTime>
              <NodeType>0</NodeType>
              <ProductKey>a1rYuVF***</ProductKey>
              <Nickname>detectors_in_beijing</Nickname>
              <DeviceName>light</DeviceName>
        </SimpleDeviceInfo>
  </Data>
  <Success>true</Success>
</QueryDynamicGroupDevicesResponse>

JSON格式

{
    "NextToken": "TGlzdFJlc291***",
    "PageCount": 2,
    "PageSize": 10,
    "RequestId": "E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565",
    "Total": 24,
    "Page": 1,
    "Data": {
        "SimpleDeviceInfo": {
            "LastOnlineTime": "2018-08-06 13:43:12",
            "UtcActiveTime": "2018-08-06T02:48:41.000Z",
            "Status": "ONLINE",
            "IotId": "Q7uOhVRdZRRlDnTLv****00100",
            "CategoryKey": "Lighting",
            "ProductName": "test",
            "UtcLastOnlineTime": "2018-08-06T05:43:12.000Z",
            "ActiveTime": "2018-08-06 10:48:41",
            "NodeType": 0,
            "ProductKey": "a1rYuVF***",
            "Nickname": "detectors_in_beijing",
            "DeviceName": "light"
        }
    },
    "Success": true
}