調(diào)用該接口查詢動(dòng)態(tài)分組下的設(shè)備列表。

限制說(shuō)明

  • 目前僅華東2（上海）地域下，企業(yè)版實(shí)例和新版公共實(shí)例，支持動(dòng)態(tài)分組功能。實(shí)例詳細(xì)說(shuō)明，請(qǐng)參見實(shí)例管理。
  • 單個(gè)阿里云賬號(hào)調(diào)用該接口的每秒請(qǐng)求數(shù)（QPS）最大限制為50。
    說(shuō)明 RAM用戶共享阿里云賬號(hào)配額。

調(diào)試

您可以在OpenAPI Explorer中直接運(yùn)行該接口，免去您計(jì)算簽名的困擾。運(yùn)行成功后，OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。

請(qǐng)求參數(shù)

名稱 類型 是否必選 示例值 描述
Action String 是 QueryDynamicGroupDevices

系統(tǒng)規(guī)定參數(shù)。取值：QueryDynamicGroupDevices。
GroupId String 是 tDQvBJqbUyHs***

分組ID，分組的全局唯一標(biāo)識(shí)符。

您可調(diào)用QueryDeviceGroupList接口查詢分組ID（GroupId）。

IotInstanceId String 是 iot-***-v6***

實(shí)例ID。

您可在物聯(lián)網(wǎng)平臺(tái)控制臺(tái)的實(shí)例概覽頁(yè)面，查看當(dāng)前實(shí)例的ID。

PageSize Integer 否 10

每頁(yè)記錄數(shù)，最大值是200，默認(rèn)值是10。
ProductKey String 否 a1BwAGV***

設(shè)備所屬產(chǎn)品的ProductKey。

DeviceName String 否 light

設(shè)備名稱。

傳入此參數(shù)時(shí)，若FuzzyName同時(shí)傳入true，會(huì)模糊搜索設(shè)備，DeviceName值為設(shè)備名稱的前綴字符串，長(zhǎng)度必須大于4個(gè)字符。

NextToken String 否 TGlzdFJlc291***

下一頁(yè)標(biāo)識(shí)，首次查詢無(wú)需傳入。
CurrentPage Integer 否 2

指定從返回結(jié)果中的第幾頁(yè)開始顯示。默認(rèn)值是1。
Status String 否 OFFLINE

設(shè)備狀態(tài)。取值：

  • ONLINE：設(shè)備在線。
  • OFFLINE：設(shè)備離線。
  • UNACTIVE：設(shè)備未激活。
  • DISABLE：設(shè)備已禁用。
FuzzyName Boolean 否 true

是否根據(jù)DeviceName值，模糊搜索設(shè)備。

  • true：模糊搜索。
  • false（默認(rèn)）：不模糊搜索。

調(diào)用API時(shí)，除了本文介紹的該API的特有請(qǐng)求參數(shù)，還需傳入公共請(qǐng)求參數(shù)。公共請(qǐng)求參數(shù)說(shuō)明，請(qǐng)參見公共參數(shù)文檔。

返回?cái)?shù)據(jù)

名稱 類型 示例值 描述
Code String iot.system.SystemException

調(diào)用失敗時(shí)，返回的錯(cuò)誤碼。更多信息，請(qǐng)參見錯(cuò)誤碼。

Data Array of SimpleDeviceInfo

調(diào)用成功后，返回的設(shè)備列表，詳情參見SimpleDeviceInfo下信息。

SimpleDeviceInfo
ActiveTime String 2018-08-06 10:48:41

設(shè)備的激活時(shí)間。
CategoryKey String Lighting

產(chǎn)品所屬品類的標(biāo)識(shí)符。

產(chǎn)品使用了物聯(lián)網(wǎng)平臺(tái)預(yù)定義的標(biāo)準(zhǔn)品類物模型會(huì)返回此參數(shù)。
DeviceName String light

設(shè)備名稱。
IotId String Q7uOhVRdZRRlDnTLv****00100

物聯(lián)網(wǎng)平臺(tái)為該設(shè)備頒發(fā)的ID，作為該設(shè)備的唯一標(biāo)識(shí)符。
LastOnlineTime String 2018-08-06 13:43:12

設(shè)備最近一次上線時(shí)間。
Nickname String detectors_in_beijing

設(shè)備的備注名稱。
NodeType Integer 0

產(chǎn)品的節(jié)點(diǎn)類型。取值：

  • 0：設(shè)備。設(shè)備不能掛載子設(shè)備，可以直連物聯(lián)網(wǎng)平臺(tái)，也可以作為網(wǎng)關(guān)的子設(shè)備連接物聯(lián)網(wǎng)平臺(tái)。
  • 1：網(wǎng)關(guān)。網(wǎng)關(guān)可以掛載子設(shè)備，具有子設(shè)備管理模塊，維持子設(shè)備的拓?fù)潢P(guān)系，和將拓?fù)潢P(guān)系同步到物聯(lián)網(wǎng)平臺(tái)。
ProductKey String a1rYuVF***

設(shè)備所屬產(chǎn)品的ProductKey。

ProductName String test

設(shè)備所屬產(chǎn)品的名稱。
Status String ONLINE

設(shè)備狀態(tài)。取值：

  • ONLINE：設(shè)備在線。
  • OFFLINE：設(shè)備離線。
  • UNACTIVE：設(shè)備未激活。
  • DISABLE：設(shè)備已禁用。
UtcActiveTime String 2018-08-06T02:48:41.000Z

設(shè)備的激活時(shí)間，UTC格式。
UtcLastOnlineTime String 2018-08-06T05:43:12.000Z

設(shè)備最近一次上線的時(shí)間，UTC格式。
ErrorMessage String 系統(tǒng)異常

調(diào)用失敗時(shí)，返回的出錯(cuò)信息。
NextToken String TGlzdFJlc291***

下一頁(yè)標(biāo)識(shí)?？稍谙麓握?qǐng)求時(shí)傳入，來(lái)獲取下一頁(yè)數(shù)據(jù)。

如果返回值為空，則表示沒有下一頁(yè)數(shù)據(jù)。
Page Integer 1

當(dāng)前頁(yè)碼。
PageCount Integer 2

總頁(yè)數(shù)。
PageSize Integer 10

每頁(yè)所顯示的設(shè)備數(shù)量。
RequestId String E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565

阿里云為該請(qǐng)求生成的唯一標(biāo)識(shí)符。
Success Boolean true

表示是否調(diào)用成功。

  • true：調(diào)用成功。
  • false：調(diào)用失敗。
Total Integer 24

設(shè)備總數(shù)。

示例

請(qǐng)求示例

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=QueryDynamicGroupDevices
&GroupId=tDQvBJqbUyHs***
&IotInstanceId=iot-***-v6***
&<公共請(qǐng)求參數(shù)>

正常返回示例

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
}