API 標準および多言語対応の SDK
本製品 (RocketMQ/2022-08-01) の API は、ROA 標準に準拠した OpenAPI 仕様を採用しています。Alibaba Cloud には主要なプログラミング言語に対応した SDK が用意され、リクエスト署名のような手間がかかる手順を省略できます。そのため、開発者は HTTP 通信の詳細を意識することなく、各言語の構文で API を呼び出すことが可能になります。
カスタム署名
署名のカスタマイズが必要な場合、「署名メカニズム」を参照してリクエストに手動で署名できます。手動署名プロセスは非常に煩雑で、通常はおよそ 5 営業日かかります。詳細については、DingTalk サポート窓口 (グループチャット ID：147535001692) までお問い合わせください。
はじめに
Alibaba Cloud アカウント (root ユーザー) は最高レベルの管理権限を持ち、その AccessKey ペアが悪用されると、関連するすべてのリソースが不正にアクセスされ、重大なセキュリティリスクを引き起こす可能性があります。そのため、必要な場合以外は、Alibaba Cloud アカウントを使用しないでください。その代わりに、API のみでのアクセスを許可された Resource Access Management (RAM) ユーザーを作成し、RAM ポリシーを設定することで、最小権限の原則 (PoLP) を徹底してください。
API セキュリティを確保するには、以下を作成し、設定する必要があります。
RAM ユーザー
RAM ユーザー用の AccessKey ペア
インスタンス
|
API |
タイトル |
説明 |
| CreateTopic | CreateTopic | ApsaraMQ for RocketMQ で Topic を作成します。Topic は、メッセージの転送とストレージのプライマリコンテナーです。同じビジネスロジックを共有するメッセージを分類するために使用されます。プロデューサー/コンシューマーモデルでは、プロデューサーは Topic にメッセージを送信し、コンシューマーはこれらの Topic をサブスクライブしてメッセージを消費します。 |
| UpdateTopic | UpdateTopic | Topic の備考を更新します。 |
| DeleteTopic | DeleteTopic | 指定された Topic を削除します。 |
Topic
|
API |
タイトル |
説明 |
| ListConsumerGroups | ListConsumerGroups | 指定されたインスタンス内の使用者グループを一覧表示します。 |
| GetConsumerGroup | GetConsumerGroup | 指定のコンシューマーグループの詳細を取得します。 |
コンシューマーグループ
|
API |
タイトル |
説明 |
| ListTopicSubscriptions | ListTopicSubscriptions | 特定の Topic のサブスクリプションを照会します。 |
| ListConsumerGroupSubscriptions | ListConsumerGroupSubscriptions | 使用者グループのサブスクリプション関係を一覧表示します。 |
| GetConsumerGroupSubscription | GetConsumerGroupSubscription | コンシューマーグループのサブスクリプションをクエリします。 |
| DeleteConsumerGroupSubscription | DeleteConsumerGroupSubscription | 使用者グループのサブスクリプションを削除します。 |
サブスクリプション
|
API |
タイトル |
説明 |
| ListConsumerConnections | ListConsumerConnections | 指定されたコンシューマーグループ内のクライアントの接続情報を取得します。 |
| GetConsumerGroupLag | GetConsumerGroupLag | 使用者グループのメッセージ蓄積量を照会します。 |
| GetConsumerStack | GetConsumerStack | コンシューマーのスタック情報を照会します。 |
| ResetConsumeOffset | ResetConsumeOffset | 使用者グループのコンシューマオフセットをリセットします。コンシューマオフセットをリセットすると、コンシューマーがメッセージの消費を開始するオフセットが変更されます。メッセージの消費中にエラーが発生した場合や、誤ったメッセージが消費された場合は、コンシューマオフセットをリセットして、消費を特定のオフセットにロールバックし、再消費することができます。また、コンシューマオフセットを最新のオフセットにリセットして、蓄積されたメッセージを一時的に未処理のままにすることもできます。 |
消費
|
API |
タイトル |
説明 |
| ListMessages | ListMessages | メッセージのリストをクエリします。 |
| GetMessageDetail | GetMessageDetail | 特定のメッセージの詳細を取得します。 |
| VerifySendMessage | VerifySendMessage | 指定されたインスタンス内のトピックにメッセージを送信できるかどうかをテストします。 |
| VerifyConsumeMessage | VerifyConsumeMessage | 特定のインスタンス上の特定の Topic にあるメッセージの消費ステータスを検証します。 |
メッセージ
|
API |
タイトル |
説明 |
| CreateInstanceAccount | CreateInstanceAccount | インスタンスのアクセスアカウントを作成します。 |
| UpdateInstanceAccount | UpdateInstanceAccount | 指定されたインスタンス内の指定されたアカウントの情報を更新します。 |
| DeleteInstanceAccount | DeleteInstanceAccount | アクセス制御の ACL ユーザーを削除します。 |
| ListInstanceAccount | ListInstanceAccount | 指定されたインスタンスのアクセスアカウントを取得します。 |
| GetInstanceAccount | GetInstanceAccount | 指定されたインスタンスのアカウント詳細を取得します。 |
| CreateInstanceAcl | CreateInstanceAcl | 特定のインスタンスにアクセス制御リスト (ACL) を作成します。 |
| UpdateInstanceAcl | UpdateInstanceAcl | 特定のユーザーに対して、特定のインスタンスのリソースに対する権限を更新します。 |
| DeleteInstanceAcl | DeleteInstanceAcl | インスタンスの特定のアカウントの権限を削除します。 |
| ListInstanceAcl | ListInstanceAcl | インスタンスのアクセス制御リスト (ACL) を照会します。 |
| GetInstanceAcl | GetInstanceAcl | インスタンスのアクセス制御リスト (ACL) に関する情報を照会します。 |
| CreateInstanceIpWhitelist | CreateInstanceIpWhitelist | IP アドレスホワイトリストを作成します。 |
| DeleteInstanceIpWhitelist | DeleteInstanceIpWhitelist | インスタンスから特定の IP アドレスホワイトリストを削除します。 |
| ListInstanceIpWhitelist | ListInstanceIpWhitelist | インスタンスの IP アドレスホワイトリストを照会します。 |
| GetInstanceIpWhitelist | GetInstanceIpWhitelist | インスタンスの IP アドレスホワイトリストに関する情報を照会します。 |
トレース
|
API |
タイトル |
説明 |
| ListMigrations | ListMigrations | 移行タスクをクエリします。 |
| ListMigrationOperations | ListMigrationOperations | 移行操作を一覧表示します。 |
| ExecuteMigrationOperation | ExecuteMigrationOperation | 移行タスクに対して指定された操作を実行します。 |
| FinishMigrationStage | FinishMigrationStage | 指定された移行タスクの現在の移行ステージを完了します。 |
ACL
|
API |
タイトル |
説明 |
| CreateDisasterRecoveryPlan | CreateDisasterRecoveryPlan | ディザスタリカバリプランを作成します。 |
| DeleteDisasterRecoveryPlan | DeleteDisasterRecoveryPlan | グローバルメッセージバックアッププランを削除します。 |
| UpdateDisasterRecoveryPlan | UpdateDisasterRecoveryPlan | グローバルメッセージバックアッププランを変更します。 |
| ListDisasterRecoveryPlans | ListDisasterRecoveryPlans | グローバルレプリケータータスクを照会します。 |
| GetDisasterRecoveryPlan | GetDisasterRecoveryPlan | グローバルレプリケータータスクの詳細を照会します。 |
| AddDisasterRecoveryItem | AddDisasterRecoveryItem | グローバルレプリケータータスクに Topic マッピングを追加します。 |
| UpdateDisasterRecoveryItem | UpdateDisasterRecoveryItem | グローバルメッセージバックアッププラン内のトピックマッピングを更新します。 |
| DeleteDisasterRecoveryItem | DeleteDisasterRecoveryItem | グローバルレプリケータータスクの Topic マッピングを削除します。 |
| StartDisasterRecoveryItem | StartDisasterRecoveryItem | Global Replicator タスクの Topic マッピングを開始します。 |
| StopDisasterRecoveryItem | StopDisasterRecoveryItem | グローバルレプリケータータスクのトピックマッピングを停止します。 |
| ListDisasterRecoveryItems | ListDisasterRecoveryItems | インスタンスのグローバルレプリケータータスクをクエリします。 |
| GetDisasterRecoveryItem | GetDisasterRecoveryItem | グローバルレプリケータータスク内の Topic マッピングの詳細を照会します。 |
| ListDisasterRecoveryCheckpoints | ListDisasterRecoveryCheckpoints | コンシューマーの進捗同期タスクを照会します。 |
| SyncDisasterRecoveryCheckpoint | SyncDisasterRecoveryCheckpoint | ディザスタリカバリープランの消費の進捗を同期します。 |
クラウド移行
|
API |
タイトル |
説明 |
| GetConsumeTimespan | GetConsumeTimespan | Topic のコンシューマオフセットをリセットできる時間範囲を照会します。 |
| ListMetricMeta | ListMetricMeta | モニタリング項目リストを照会します。 |
Global Replicator
|
API |
タイトル |
説明 |
| ChangeResourceGroup | ChangeResourceGroup | ApsaraMQ for RocketMQ インスタンスが属するリソースグループを変更します。 |
| CreateConsumerGroup | CreateConsumerGroup | ApsaraMQ for RocketMQ のコンシューマーグループを作成します。コンシューマーグループとは、同じ消費動作をする複数のコンシューマーを含む負荷分散グループです。コンシューマーは、メッセージをサブスクライブするために、コンシューマーグループと関連するトピックを指定する必要があります。 |
| CreateInstance | CreateInstance | ApsaraMQ for RocketMQ 5.x インスタンスを作成します。 |
| DeleteConsumerGroup | DeleteConsumerGroup | 指定された使用者グループを削除します。 |
| DeleteInstance | DeleteInstance | インスタンスをリリースします。 |
| GetInstance | 指定されたインスタンスの詳細を取得します。 | 指定されたインスタンスの詳細情報を取得します。 |
| GetTopic | GetTopic | 指定された Topic の詳細を取得します。 |
| GetTrace | GetTrace | 指定されたトピック内の指定されたメッセージのトレースを取得します。 |
| ListAvailableZones | ListAvailableZones | サポートされているゾーンを照会します。 |
| ListInstances | ListInstances | 指定されたリージョン内の ApsaraMQ for RocketMQ インスタンスをクエリします。 |
| ListRegions | ListRegions | ApsaraMQ for RocketMQ が利用可能なリージョンを照会します。 |
| ListTagResources | ListTagResources | リソースに追加されたタグを照会します。 |
| ListTopics | ListTopics | 指定されたインスタンス内の Topic をクエリします。 |
| ListTraces | ListTraces | 指定された Topic のメッセージトレースをクエリします。 |
| TagResources | TagResources | リソースタグを作成します。 |
| UntagResources | UntagResources | リソースからタグを削除します。 |
| UpdateConsumerGroup | UpdateConsumerGroup | 使用者グループの基本情報とコンシューマーリトライポリシーを更新します。 |
| UpdateInstance | UpdateInstance | Message Queue for Apache RocketMQ インスタンスの基本情報および仕様を更新します。 |