OnsGroupConsumerUpdate を介した RocketMQ コンシューションの一時停止または再開 - ApsaraMQ for RocketMQ

指定されたグループ ID に対応するコンシューマークラスターのメッセージ読み取り権限を設定します。この操作は通常、特定の使用者グループによるメッセージの読み取りを禁止するために使用されます。

操作説明

重要 Alibaba Cloud OpenAPI は、Alibaba Cloud サービスリソースの管理とクエリに使用されるコントロールプレーン API です。OpenAPI はコントロールプレーン上でのみ統合してください。メッセージの送受信を行うコアデータリンクでは OpenAPI に依存しないでください。データリンクに脅威をもたらす可能性があります。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

mq:UpdateGroupConsumer

Group

acs:mq:{#regionId}:{#accountId}:{#GroupName}

Group

acs:mq:{#regionId}:{#accountId}:{#InstanceId}%{#GroupName}

なし

mq:OnsInstanceBaseInfo

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
GroupId	string	必須	設定するグループ ID。	GID_test_groupId
ReadEnable	boolean	必須	グループ ID のコンシューマークラスターがメッセージを読み取る権限を持つかどうかを指定します。有効な値： true：コンシューマークラスターはメッセージを読み取る権限を持ちます。 false：コンシューマークラスターはメッセージを読み取る権限を持ちません。デフォルト値：true。	true
InstanceId	string	任意	グループ ID が属するインスタンスの ID。	MQ_INST_111111111111_DOxxxxxx

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエストの ID。これは共通パラメーターです。各リクエストには一意の ID があります。この ID を使用して、問題のトラブルシューティングと特定ができます。	A07E3902-B92E-44A6-B6C5-6AA111111****

例

成功レスポンス

JSONJSON

{
  "RequestId": "A07E3902-B92E-44A6-B6C5-6AA111111****"
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。