全部產品
Search
文件中心

IoT Platform:QueryDeviceListByDeviceGroup

更新時間:Feb 12, 2025

調用該介面查詢分組中的裝置列表。

QPS限制

單個阿里雲帳號調用該介面的每秒請求數(QPS)最大限制為5。

說明 RAM使用者共用阿里雲帳號配額。

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

請求參數

名稱 類型 是否必選 樣本值 描述
Action String QueryDeviceListByDeviceGroup

系統規定參數。取值:QueryDeviceListByDeviceGroup。

GroupId String 7DIgqIl1Ijnh****

分組ID,分組的通用唯一識別碼。

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

執行個體ID。您可在物聯網平台控制台的執行個體概覽頁面,查看當前執行個體的ID

重要
  • 若有ID值,必須傳入該ID值,否則調用會失敗。
  • 若無執行個體概覽頁面或ID值,則無需傳入。

執行個體的更多資訊,請參見執行個體概述

PageSize Integer 10

指定返回結果中,每頁顯示的裝置數量。

CurrentPage Integer 1

指定顯示查詢結果中的第幾頁。

調用API時,除了本文介紹的該API的特有請求參數,還需傳入公用請求參數。公用請求參數說明,請參見公用參數文檔

返回資料

名稱 類型 樣本值 描述
Code String iot.system.SystemException

調用失敗時,返回的錯誤碼。更多資訊,請參見錯誤碼

Data Array of SimpleDeviceInfo

調用成功時,返回的裝置列表資訊資料。詳情請參見以下SimpleDeviceInfo

SimpleDeviceInfo
DeviceName String ios_1207_08

裝置名稱。

IotId String TfmUAeJjQQhCPH84UVNn0010c6****

物聯網平台為該裝置頒發的ID,作為該裝置的唯一識別碼。

ProductKey String a1hWjHD****

裝置所屬的產品Key。

ProductName String WIFIdevice

裝置所屬的產品名稱。

ErrorMessage String 系統異常

調用失敗時,返回的出錯資訊。

Page Integer 1

當前頁碼。

PageCount Integer 1

總頁數。

PageSize Integer 10

每頁所顯示的裝置數量。

RequestId String B1A921D9-1061-4D45-9F12-EA6B0FDEDE30

阿里雲為該請求產生的唯一識別碼。

Success Boolean true

是否調用成功。

  • true:調用成功。
  • false:調用失敗。
Total Integer 3

裝置總數。

樣本

請求樣本

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryDeviceListByDeviceGroup
&GroupId=7DIgqIl1Ijnh****
&CurrentPage=1
&PageSize=10
&<公用請求參數>

正常返回樣本

XML格式

<QueryDeviceListByDeviceGroupResponse>
      <PageCount>1</PageCount>
      <Data>
            <SimpleDeviceInfo>
                  <DeviceName>ios_1207_08</DeviceName>
                  <ProductKey>a1hWjHD****</ProductKey>
                  <ProductName>WIFIdevice</ProductName>
                  <IotId>TfmUAeJjQQhCPH84UVNn0010c6****</IotId>
            </SimpleDeviceInfo>
            <SimpleDeviceInfo>
                  <DeviceName>ios_1207_07</DeviceName>
                  <ProductKey>a1hWjHD****</ProductKey>
                  <ProductName>WIFIgateway</ProductName>
                  <IotId>wVPeAksaboXBlRgvZNHQ001031****</IotId>
            </SimpleDeviceInfo>
            <SimpleDeviceInfo>
                  <DeviceName>E1IPK25iL4CTOwnuI2yt</DeviceName>
                  <ProductKey>a1mV8bK****</ProductKey>
                  <ProductName>yanlv</ProductName>
                  <IotId>E1IPK25iL4CTOwnuI2yt001059****</IotId>
            </SimpleDeviceInfo>
      </Data>
      <PageSize>10</PageSize>
      <Page>1</Page>
      <RequestId>B1A921D9-1061-4D45-9F12-EA6B0FDEDE30</RequestId>
      <Success>true</Success>
      <Total>3</Total>
</QueryDeviceListByDeviceGroupResponse>

JSON格式

{
  "PageCount": 1,
  "Data": {
    "SimpleDeviceInfo": [
      {
        "DeviceName": "ios_1207_08",
        "ProductKey": "a1hWjHD****",
        "ProductName": "WIFIdevice",
        "IotId": "TfmUAeJjQQhCPH84UVNn0010c6****"
      },
      {
        "DeviceName": "ios_1207_07",
        "ProductKey": "a1hWjHD****",
        "ProductName": "WIFIgateway",
        "IotId": "wVPeAksaboXBlRgvZNHQ001031****"
      },
      {
        "DeviceName": "E1IPK25iL4CTOwnuI2yt",
        "ProductKey": "a1mV8bK****",
        "ProductName": "yanlv",
        "IotId": "E1IPK25iL4CTOwnuI2yt001059****"
      }
    ]
  },
  "PageSize": 10,
  "Page": 1,
  "RequestId": "B1A921D9-1061-4D45-9F12-EA6B0FDEDE30",
  "Success": true,
  "Total": 3
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。