QueryDeviceGroupByDevice - IoT Platform

使用說明

一個裝置最多能被添加到10個分組中。

QPS限制

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

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

調試

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

請求參數

名稱	類型	是否必選	樣本值	描述
Action	String	是	QueryDeviceGroupByDevice	系統規定參數。取值：QueryDeviceGroupByDevice。
DeviceName	String	是	test456	裝置名稱。
ProductKey	String	是	a1SKk9K****	裝置所屬產品的ProductKey。
IotInstanceId	String	否	iot_instc_pu***_c-v64********	執行個體ID。您可在物聯網平台控制台的執行個體概覽頁面，查看當前執行個體的ID。重要若有ID值，必須傳入該ID值，否則調用會失敗。若無執行個體概覽頁面或ID值，則無需傳入。執行個體的更多資訊，請參見執行個體概述。

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

返回資料

名稱	類型	樣本值	描述
Code	String	iot.system.SystemException	調用失敗時，返回的錯誤碼。更多資訊，請參見錯誤碼。
ErrorMessage	String	系統異常	調用失敗時，返回的出錯資訊。
GroupInfos	Array of GroupInfo		調用成功時，返回的分組資訊。詳情請參見以下GroupInfo。
GroupInfo
GroupDesc	String	father desc	分組描述。
GroupId	String	6a3FF2XE2BKa****	分組ID。
GroupName	String	father1543152336554	分組名稱。
GroupType	String	LINK_PLATFORM_DYNAMIC	分組類型。
UtcCreate	String	2018-11-25T13:25:37.000Z	分組的建立時間。
RequestId	String	7941C8CD-7764-4A94-8CD9-E2762D4A73AC	阿里雲為該請求產生的唯一識別碼。
Success	Boolean	true	是否調用成功。 true：調用成功。 false：調用失敗。

樣本

請求樣本

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryDeviceGroupByDevice
&DeviceName=test456
&ProductKey=a1SKk9K****
&<公用請求參數>

正常返回樣本

XML格式

<QueryDeviceGroupByDeviceResponse>
  <RequestId>7941C8CD-7764-4A94-8CD9-E2762D4A73AC</RequestId>
  <GroupInfos>
        <GroupInfo>
              <GroupDesc>father desc</GroupDesc>
              <GroupName>father1543152336554</GroupName>
              <UtcCreate>2018-11-25T13:25:37.000Z</UtcCreate>
              <GroupId>6a3FF2XE2BKa***</GroupId>
              <GroupType>LINK_PLATFORM_DYNAMIC</GroupType>
        </GroupInfo>
  </GroupInfos>
  <Success>true</Success>
</QueryDeviceGroupByDeviceResponse>

JSON格式

{
  "RequestId": "7941C8CD-7764-4A94-8CD9-E2762D4A73AC",
  "GroupInfos": {
    "GroupInfo": [
      {
        "GroupDesc": "father desc",
        "GroupName": "father1543152336554",
        "UtcCreate": "2018-11-25T13:25:37.000Z",
        "GroupId": "6a3FF2XE2BKa***",
        "GroupType":"LINK_PLATFORM_DYNAMIC"
      }
    ]
  },
  "Success": true
}

錯誤碼

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