QueryConsumerGroupStatus - IoT Platform - Alibaba Cloud ドキュメントセンター

AMQP サーバー側サブスクリプションを使用する場合に、コンシューマーグループのステータスをクエリします。ステータス情報には、オンラインクライアント情報、メッセージ消費率、累積メッセージ数、最後のメッセージ消費時間が含まれます。

制限

各 Alibaba Cloud アカウントは、最大 5 クエリ/秒（QPS）を実行できます。

説明 Alibaba Cloud アカウントの RAM ユーザーは、アカウントのクォータを共有します。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。便宜上、OpenAPI Explorer でこの操作を呼び出すことをお勧めします。 OpenAPI Explorer は、さまざまな SDK の操作のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター	タイプ	必須	例	説明
Action	String	Yes	QueryConsumerGroupStatus	実行する操作。値を QueryConsumerGroupStatus に設定します。
GroupId	String	Yes	nJRaJPn5U1JITGf******	CreateConsumerGroup 操作を呼び出してコンシューマーグループを作成した後、コンシューマーグループ ID が返されます。 QueryConsumerGroupList 操作を呼び出して、グループ名でコンシューマーグループ ID をクエリできます。また、IoT Platform コンソールに移動し、ルール > サーバー側サブスクリプション > コンシューマーグループを選択して、コンシューマーグループ ID を表示することもできます。
IotInstanceId	String	No	iot-cn-0pp1n8t****	インスタンスの ID。IoT Platform コンソールの概要ページでインスタンスの ID を表示できます。重要インスタンスに ID がある場合は、このパラメーターを設定する必要があります。このパラメーターを設定しないと、呼び出しは失敗します。インスタンスに概要ページまたは ID がない場合は、このパラメーターを設定する必要はありません。詳細については、「概要」をご参照ください。

上記の操作固有のリクエストパラメーターに加えて、この操作を呼び出すときは、共通のリクエストパラメーターを指定する必要があります。詳細については、「共通リクエストパラメーター」をご参照ください。

レスポンスパラメーター

パラメーター	タイプ	例	説明
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 年 1 月 1 日 00:00:00 UTC から経過したミリ秒数を表す UNIX タイムスタンプです。
RealTimeConsumeCountPerMinute	Integer	5	コンシューマーグループの単一クライアントでのリアルタイムメッセージの消費率。単位：メッセージ/分。
Code	String	iot.system.SystemException	呼び出しが失敗した場合に返されるエラーコード。詳細については、「エラーコード」をご参照ください。
ConsumerSpeed	Integer	14	コンシューマーグループのメッセージ消費率。単位：メッセージ/分。
ErrorMessage	String	A system exception occurred.	呼び出しが失敗した場合に返されるエラーメッセージ。
LastConsumerTime	String	2020-05-29T03:37:56.000Z	最後のメッセージが消費された時刻。時刻は yyyy-MM-dd'T'HH:mm:ss.SSSZ 形式です。時刻は UTC で表示され、ミリ秒単位まで正確です。
RealTimeConsumeCountPerMinute	Integer	14	コンシューマーグループのリアルタイムメッセージの消費率。単位：メッセージ/分。
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	リクエストの ID。
Success	Boolean	true	呼び出しが成功したかどうかを示します。 true: 呼び出しは成功しました。 false: 呼び出しは失敗しました。

例

リクエストの例

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryConsumerGroupStatus
&GroupId=nJRaJPn5U1JITGf******
&<Common request parameters>

成功レスポンスの例

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
}

エラーコード

エラーコードの一覧については、API エラーセンターをご覧ください。