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

AMQP サーバー側サブスクリプションを使用する場合、コンシューマーグループ ID に基づいてコンシューマーグループの詳細情報をクエリします。

制限

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

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

デバッグ

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

リクエストパラメーター

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

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

レスポンスパラメーター

パラメーター	タイプ	例	説明
Code	String	iot.system.SystemException	呼び出しが失敗した場合に返されるエラーコード。詳細については、「エラーコード」をご参照ください。
Data	Struct		コンシューマーグループの詳細。このパラメーターは、呼び出しが成功した場合に返されます。
CreateTime	String	2020-05-20T00:05:20.000Z	コンシューマーグループが作成された時刻。時刻は、ISO 8601 標準の yyyy-MM-ddTHH:mm:ss.SSSZ 形式に従います。時刻は UTC で表示され、ミリ秒単位まで正確です。
GroupId	String	nJRaJPn5U1JITGf******	コンシューマーグループの ID。
GroupName	String	Consumer group 1	コンシューマーグループの名前。
ErrorMessage	String	A system exception occurred.	呼び出しが失敗した場合に返されるエラーメッセージ。
RequestId	String	73B9DF43-7780-47DE-8BED-077729D28BD2	リクエストの ID。
Success	Boolean	true	呼び出しが成功したかどうかを示します。 true: 呼び出しは成功しました。 false: 呼び出しは失敗しました。

例

リクエストの例

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

成功レスポンスの例

XML 形式

<QueryConsumerGroupByGroupIdResponse>
    <Data>
        <GroupId>nJRaJPn5U1JITGf******</GroupId>
        <GroupName>Consumer group 1</GroupName>
        <CreateTime>2019-11-12T11:19:13.000Z</CreateTime>
    </Data>
    <RequestId>73B9DF43-7780-47DE-8BED-077729D28BD2</RequestId>
    <Success>true</Success>
</QueryConsumerGroupByGroupIdResponse>

JSON 形式

{
  "Data": {
        "GroupId": "nJRaJPn5U1JITGf******",
        "GroupName": "Consumer Group 1",
        "CreateTime": "2019-11-12T11:19:13.000Z"
    },
  "RequestId": "73B9DF43-7780-47DE-8BED-077729D28BD2",
  "Success": true
}

エラーコード

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