OnsGroupCreate API を使用した RocketMQ コンシューマーグループの作成 - ApsaraMQ for RocketMQ

操作説明

重要 Alibaba Cloud OpenAPI は管理 API であり、Alibaba Cloud サービスリソースの管理とクエリに使用できます。この API は管理目的でのみ統合してください。セキュリティ上の脅威を引き起こす可能性があるため、メッセージの送受信を行うコアデータリンクにこの API を使用しないでください。

この操作は通常、新しいアプリケーションのデプロイやビジネスロジックの実装のために新しいグループを作成するために使用されます。

今すぐお試しください

この 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:CreateGroup

create

*Instance

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

なし

mq:QueryInstanceBaseInfo

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
GroupId	string	必須	作成するコンシューマーグループの ID です。この値は、次の要件を満たす必要があります。長さが 2～64 文字で、使用できる文字は英字、数字、ハイフン (-)、アンダースコア (_) のみです。グループを作成するインスタンスに名前空間が存在する場合、グループ ID はそのインスタンス内で一意である必要があります。インスタンス内の既存のグループ ID やトピック名と同じ名前は使用できません。異なるインスタンス間では、同じグループ ID を使用できます。例えば、インスタンス A のグループ ID は、インスタンス B のグループ ID やトピック名と同じにすることが可能です。グループを作成するインスタンスに名前空間が存在しない場合、グループ ID はすべてのインスタンスおよびリージョンにおいて、グローバルに一意である必要があります。既存のグループ ID やトピック名と同じ名前は使用できません。説明グループの作成後にグループ ID を変更することはできません。インスタンスに名前空間があるかどうかは、ApsaraMQ for RocketMQ コンソールの [インスタンス詳細] ページにある [基本情報] セクションで確認できます。	GID_test_groupId
Remark	string	任意	グループに関する備考。	test
InstanceId	string	任意	グループが属するインスタンスの ID。	MQ_INST_111111111111_DOxxxxxx
GroupType	string	任意	グループ ID が適用されるプロトコルです。TCP プロトコルと HTTP プロトコルのグループ ID は相互に利用できません。プロトコルごとに個別のグループ ID を作成する必要があります。有効な値は次のとおりです。 tcp：デフォルト値です。作成されたグループ ID は、TCP プロトコル経由のメッセージの送受信にのみ適用されます。 http：作成されたグループ ID は、HTTP プロトコル経由のメッセージの送受信にのみ適用されます。	tcp

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
RequestId	string	共通パラメーターです。リクエストを特定するための ID で、リクエストごとに一意です。問題が発生した際のトラブルシューティングや特定にこの ID を使用します。	A07E3902-B92E-44A6-B6C5-6AA111111****

例

成功レスポンス

JSONJSON

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

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	%s	%s, please check and retry later
400	Group.NumLimited	group count exceed limit.

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

変更履歴

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