QuerySubscribeRelation - IoT Platform

QPS限制

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

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

調試

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

請求參數

名稱	類型	是否必選	樣本值	描述
Action	String	是	QuerySubscribeRelation	系統規定參數。取值：QuerySubscribeRelation。
ProductKey	String	是	a1fyXVF****	該訂閱中的產品的ProductKey。
Type	String	是	AMQP	訂閱類型： MNS AMQP
IotInstanceId	String	否	iot-cn-0pp1n8t****	執行個體ID。您可在物聯網平台控制台的執行個體概覽頁面，查看當前執行個體的ID。重要若有ID值，必須傳入該ID值，否則調用會失敗。若無執行個體概覽頁面或ID值，則無需傳入。執行個體的更多資訊，請參見執行個體概述。

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

返回資料

名稱	類型	樣本值	描述
Code	String	iot.system.SystemException	調用失敗時，返回的錯誤碼。更多資訊，請參見錯誤碼。
ErrorMessage	String	系統異常	調用失敗時，返回的出錯資訊。
DeviceDataFlag	Boolean	true	推送訊息類型是否選擇裝置上報訊息。 true：是。 false：否。
DeviceStatusChangeFlag	Boolean	true	推送訊息類型是否選擇裝置狀態變化通知。 true：是。 false：否。
FoundDeviceListFlag	Boolean	true	推送訊息類型是否選擇網關子裝置發現上報。 true：是。僅網關產品會返回true。 false：否。
DeviceTopoLifeCycleFlag	Boolean	true	推送訊息類型是否選擇裝置拓撲關係變更。 true：是。僅網關產品會返回true。 false：否。
DeviceLifeCycleFlag	Boolean	true	推送訊息類型是否選擇裝置生命週期變更。 true：是。 false：否。
ThingHistoryFlag	Boolean	true	推送訊息類型是否選擇物模型歷史資料上報。 true：是。 false：否。
OtaEventFlag	Boolean	true	推送訊息類型是否選擇OTA升級狀態通知。 true：是。 false：否。
DeviceTagFlag	Boolean	true	推送訊息類型是否選擇裝置標籤變更。可選值： true：是。僅當Type為AMQP時有效。 false：否。預設值為false。
OtaVersionFlag	Boolean	true	推送訊息類型是否選擇OTA模組版本號碼上報。可選值： true：是。僅當Type為AMQP時有效。 false：否。預設值為false。
OtaJobFlag	Boolean	true	推送訊息類型是否選擇OTA升級批次狀態通知。可選值： true：是。僅當Type為AMQP時有效。 false：否。預設值為false。
ProductKey	String	a1fyXVF****	該訂閱中的產品的ProductKey。
Success	Boolean	true	是否調用成功。 true：調用成功。 false：調用失敗。
ConsumerGroupIds	List	[DEFAULT_GROUP,br45A6A1amoRFGN7x1zP00****]	Type為AMQP時，返回AMQP訂閱中的消費組ID。
Type	String	AMQP	訂閱類型。傳回值： MNS AMQP
RequestId	String	21D327AF-A7DE-4E59-B5D1-ACAC8C024555	阿里雲為該請求產生的唯一識別碼。
MnsConfiguration	String	{ "queueName": "mns-test-topic1", "regionName": "cn-shanghai", "role": { "roleArn": "acs:ram::5645***:role/aliyuniotaccessingmnsrole", "roleName": "AliyunIOTAccessingMNSRole" } }	Type為MNS時，返回MNS隊列的配置資訊。具體組成和樣本，請參見下文的“MnsConfiguration定義和樣本”。

MnsConfiguration定義

名稱	描述
queueName	Message Service中用來接收資訊的隊列名稱。
regionName	目標Message Service所在的阿里雲地區代碼，例如cn-shanghai。
role	授權角色資訊。通過授予物聯網平台指定的系統服務角色，您可以授權物聯網平台訪問您的Message Service。授權角色資訊如下： `{"roleArn":"acs:ram::5645*:role/aliyuniotaccessingmnsrole","roleName": "AliyunIOTAccessingMNSRole"}` 請將`5645*`替換成您的阿里雲帳號ID。您可以登入控制台，在帳號安全設定頁面查看您的帳號ID。 `AliyunIOTAccessingMNSRole`是存取控制中定義的服務角色。用於授予物聯網平台訪問Message Service。關於角色的更多資訊，請在存取控制RAM控制台的角色管理頁面進行角色管理。

樣本：


{
    "queueName": "mns-test-topic1",
    "regionName": "cn-shanghai",
    "role": {
        "roleArn": "acs:ram::5645***:role/aliyuniotaccessingmnsrole",
        "roleName": "AliyunIOTAccessingMNSRole"
    }
}

樣本

請求樣本

https://iot.cn-shanghai.aliyuncs.com/?Action=QuerySubscribeRelation
&ProductKey=a1Zkii7****
&Type=AMQP
&<公用請求參數>

正常返回樣本

XML格式

<QuerySubscribeRelationResponse>
       <ConsumerGroupIds>
              <e>Xs95KifeaSKbi8tKkcoD00****</e>
       </ConsumerGroupIds>
       <DeviceDataFlag>false</DeviceDataFlag>
       <DeviceLifeCycleFlag>false</DeviceLifeCycleFlag>
       <DeviceStatusChangeFlag>false</DeviceStatusChangeFlag>
       <DeviceTopoLifeCycleFlag>false</DeviceTopoLifeCycleFlag>
       <FoundDeviceListFlag>false</FoundDeviceListFlag>
       <OtaEventFlag>true</OtaEventFlag>
       <ProductKey>a1Zkii7****</ProductKey>
       <RequestId>73B9DF43-7780-47DE-8BED-077729D28BD2</RequestId>
       <Success>true</Success>
       <ThingHistoryFlag>false</ThingHistoryFlag>
       <Type>AMQP</Type>
</QuerySubscribeRelationResponse>

JSON格式

{
  "DeviceLifeCycleFlag": false,
  "RequestId": "73B9DF43-7780-47DE-8BED-077729D28BD2",
  "DeviceDataFlag": false,
  "DeviceTopoLifeCycleFlag": false,
  "DeviceStatusChangeFlag": false,
  "ConsumerGroupIds": [
    "Xs95KifeaSKbi8tKkcoD00****"
  ],
  "Success": true,
  "ThingHistoryFlag": false,
  "Type": "AMQP",
  "FoundDeviceListFlag": false,
  "OtaEventFlag": true,
  "ProductKey": "a1Zkii7****"
}

錯誤碼

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