QueryConsumerGroupStatus - IoT Platform

QPS限制

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

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

調試

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

請求參數

名稱	類型	是否必選	樣本值	描述
Action	String	是	QueryConsumerGroupStatus	系統規定參數。取值：QueryConsumerGroupStatus。
GroupId	String	是	nJRaJPn5U1JITGf******	消費組ID。調用CreateConsumerGroup建立消費組成功後，會返回消費組ID。您可以調用QueryConsumerGroupList按消費組名稱查詢消費組ID，也可以在物聯網平台控制台，選擇規則引擎>服務端訂閱>消費組列表，查看消費組ID。
IotInstanceId	String	否	iot-cn-0pp1n8t****	執行個體ID。您可在物聯網平台控制台的執行個體概覽頁面，查看當前執行個體的ID。重要若有ID值，必須傳入該ID值，否則調用會失敗。若無執行個體概覽頁面或ID值，則無需傳入。執行個體的更多資訊，請參見執行個體概述。

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

返回資料

名稱	類型	樣本值	描述
AccumulatedConsumeCountPerMinute	Integer	10	消費組堆積訊息消費速率，單位：條/分鐘。
AccumulationCount	Integer	13	消費組訊息堆積數。
ClientConnectionStatusList	Array of ConsumerGroupClientConnectionInfo		消費組的線上用戶端資訊，請參見ConsumerGroupClientConnectionInfo。
ConsumerGroupClientConnectionInfo
AccumulatedConsumeCountPerMinute	Integer	10	消費組的單個用戶端堆積訊息消費速率，單位：條/分鐘。
ClientId	String	868575026******	線上用戶端ID。
ClientIpPort	String	192.168.1.2:36918	線上用戶端IP和連接埠。
OnlineTime	Long	1591240546649	線上用戶端的最後上線時間。取值為1970年01月01日00時00分00秒000毫秒以來的毫秒數。
RealTimeConsumeCountPerMinute	Integer	5	消費組的單個用戶端即時訊息消費速率，單位：條/分鐘。
Code	String	iot.system.SystemException	調用失敗時，返回的錯誤碼。更多資訊，請參見錯誤碼。
ConsumerSpeed	Integer	14	消費組訊息消費速率，單位：條/分鐘。
ErrorMessage	String	系統異常	調用失敗時，返回的出錯資訊。
LastConsumerTime	String	2020-05-29T03:37:56.000Z	最近訊息消費時間。為UTC時間，以毫秒計，格式為“yyyy-MM-dd'T'HH:mm:ss.SSSZ”。
RealTimeConsumeCountPerMinute	Integer	14	消費組即時訊息消費速率，單位：條/分鐘。
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	阿里雲為該請求產生的唯一識別碼。
Success	Boolean	true	表示是否調用成功。 true：調用成功。 false：調用失敗。

樣本

請求樣本

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryConsumerGroupStatus
&GroupId=nJRaJPn5U1JITGf******
&<公用請求參數>

正常返回樣本

XML格式

<QueryConsumerGroupStatusResponse>
  <ClientConnectionStatusList>
        <ConsumerGroupClientConnectionInfo>
              <ClientId>12345-1</ClientId>
              <AccumulatedConsumeCountPerMinute>8</AccumulatedConsumeCountPerMinute>
              <OnlineTime>1627624830193</OnlineTime>
              <ClientIpPort>192.168.1.2:55545</ClientIpPort>
              <RealTimeConsumeCountPerMinute>16</RealTimeConsumeCountPerMinute>
        </ConsumerGroupClientConnectionInfo>
        <ConsumerGroupClientConnectionInfo>
              <ClientId>12345-0</ClientId>
              <AccumulatedConsumeCountPerMinute>10</AccumulatedConsumeCountPerMinute>
              <OnlineTime>1627624829763</OnlineTime>
              <ClientIpPort>192.168.1.2:55526</ClientIpPort>
              <RealTimeConsumeCountPerMinute>14</RealTimeConsumeCountPerMinute>
        </ConsumerGroupClientConnectionInfo>
  </ClientConnectionStatusList>
  <RequestId>4EC250E4-70CE-546E-9D4A-31D06E04EAD8</RequestId>
  <AccumulatedConsumeCountPerMinute>10</AccumulatedConsumeCountPerMinute>
  <Success>true</Success>
  <RealTimeConsumeCountPerMinute>14</RealTimeConsumeCountPerMinute>
  <AccumulationCount>26</AccumulationCount>
  <ConsumerSpeed>14</ConsumerSpeed>
</QueryConsumerGroupStatusResponse>

JSON格式

{
    "ClientConnectionStatusList": {
        "ConsumerGroupClientConnectionInfo": [
            {
                "ClientId": "12345-1",
                "AccumulatedConsumeCountPerMinute": 8,
                "OnlineTime": 1627624830193,
                "ClientIpPort": "192.168.1.2:55545",
                "RealTimeConsumeCountPerMinute": 16
            },
            {
                "ClientId": "12345-0",
                "AccumulatedConsumeCountPerMinute": 10,
                "OnlineTime": 1627624829763,
                "ClientIpPort": "192.168.1.2:55526",
                "RealTimeConsumeCountPerMinute": 14
            }
        ]
    },
    "RequestId": "4EC250E4-70CE-546E-9D4A-31D06E04EAD8",
    "AccumulatedConsumeCountPerMinute": 10,
    "Success": true,
    "RealTimeConsumeCountPerMinute": 14,
    "AccumulationCount": 26,
    "ConsumerSpeed": 14
}

錯誤碼

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