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

AMQP サーバー側サブスクリプションを設定する際に、コンシューマーグループを変更します。

制限事項

IoT Platform によって提供されるデフォルトのコンシューマーグループは変更できません。
各 Alibaba Cloud アカウントは、最大 5 クエリ/秒（QPS）を実行できます。
説明 Alibaba Cloud アカウントの RAM ユーザーは、アカウントのクォータを共有します。

デバッグ

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

リクエストパラメーター

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

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

レスポンスパラメーター

パラメーター	タイプ	例	説明
Code	String	iot.system.SystemException	呼び出しが失敗した場合に返されるエラーコード。詳細については、「エラーコード」をご参照ください。
ErrorMessage	String	システム例外が発生しました。	呼び出しが失敗した場合に返されるエラーメッセージ。
RequestId	String	73B9DF43-7780-47DE-8BED-077729D28BD2	リクエストの ID。
Success	Boolean	true	呼び出しが成功したかどうかを示します。 true: 呼び出しは成功しました。 false: 呼び出しは失敗しました。

例

リクエストの例

https://iot.cn-shanghai.aliyuncs.com/?Action=UpdateConsumerGroup
&GroupId=nJRaJPn5U1JITGf******
&GroupName=Consumer group 2
&<共通リクエストパラメーター>

成功レスポンスの例

XML 形式

<UpdateConsumerGroupResponse>
    <RequestId>73B9DF43-7780-47DE-8BED-077729D28BD2</RequestId>
    <Success>true</Success>
</UpdateConsumerGroupResponse>

JSON 形式

{
  "RequestId": "73B9DF43-7780-47DE-8BED-077729D28BD2",
  "Success": true
}

エラーコード

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