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

AMQP サーバー側サブスクリプションを使用する場合、現在のアカウントのすべてのコンシューマーグループをクエリします。この操作を呼び出して、コンシューマーグループ名であいまい検索を実行することもできます。

制限

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

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

デバッグ

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

リクエストパラメーター

パラメーター	タイプ	必須	例	説明
Action	String	はい	QueryConsumerGroupList	実行する操作。値を QueryConsumerGroupList に設定します。
CurrentPage	Integer	はい	1	返すページ番号。ページは 1 ページ目から始まります。
PageSize	Integer	いいえ	2	各ページに返すエントリの数。有効な値：1 ～ 1000。
IotInstanceId	String	いいえ	iot-cn-0pp1n8t****	インスタンスの ID。インスタンス ID は、IoT Platform コンソールの概要ページで確認できます。重要インスタンスに ID がある場合は、このパラメーターを設定する必要があります。このパラメーターを設定しないと、呼び出しは失敗します。インスタンスに概要ページまたは ID がない場合は、このパラメーターを設定する必要はありません。詳細については、「概要」をご参照ください。
Fuzzy	Boolean	いいえ	false	あいまい検索を実行するかどうかを指定します。有効な値： true: あいまい検索を実行します。 GroupName パラメーターを指定する必要があります。 false: 現在のアカウントのすべてのコンシューマーグループをクエリします。デフォルト値：false。
GroupName	String	いいえ	Aタイプのコンシューマーグループ	クエリ対象のコンシューマーグループの名前。 Fuzzy パラメーターが true に設定されている場合、このパラメーターは必須です。

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

レスポンスパラメーター

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

例

リクエストの例

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryConsumerGroupList
&CurrentPage=1
&PageSize=2
&Fuzzy=true
&GroupName=Consumer groups of the A type
&<共通リクエストパラメーター>

成功レスポンスの例

XML 形式

<QueryConsumerGroupListResponse>
    <PageSize>2</PageSize>
    <PageCount>4</PageCount>
    <CurrentPage>1</CurrentPage>
    <Total>8</Total>
    <Data>
        <ConsumerGroupDTO>
            <GroupId>nJRaJPn5U1JITGf******</GroupId>
            <GroupName>Consumer Group 1</GroupName>
            <CreateTime>2020-05-29T03:37:56.000Z</CreateTime>
        </ConsumerGroupDTO>
        <ConsumerGroupDTO>
            <GroupId>qJRaJPndeefwgef******</GroupId>
            <GroupName>Consumer Group 2</GroupName>
            <CreateTime>2020-01-17T07:27:01.000Z</CreateTime>
        </ConsumerGroupDTO>
    </Data>
    <RequestId>73B9DF43-7780-47DE-8BED-077729D28BD2</RequestId>
    <Success>true</Success>
</QueryConsumerGroupListResponse>

JSON 形式

{
    "PageSize": 2,
    "PageCount": 4,
    "CurrentPage": 1,
    "Total": 8,
    "Data": {
        "ConsumerGroupDTO": [
            {
                "GroupId": "nJRaJPn5U1JITGf******",
                "GroupName": "Consumer Group 1",
                "CreateTime": "2020-05-29T03:37:56.000Z"
            },
            {
                "GroupId": "qJRaJPndeefwgef******",
                "GroupName": "Consumer Group 2",
                "CreateTime": "2020-01-17T07:27:01.000Z"
            }
        ]
    },
  "RequestId": "73B9DF43-7780-47DE-8BED-077729D28BD2",
  "Success": true
}

エラーコード

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