OnsConsumerGetConnection によるコンシューマ接続取得 - ApsaraMQ for RocketMQ

操作説明

重要 Alibaba Cloud OpenAPI は、Alibaba Cloud サービスリソースの管理と照会に使用される管理 API です。この API は管理目的でのみ統合してください。メッセージの送受信を行うコアデータリンクでこの 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:QueryConsumerConnection

get

Group

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

Group

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

なし

mq:OnsInstanceBaseInfo

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
GroupId	string	必須	照会するグループ ID。	GID_test_consumer_id
InstanceId	string	任意	グループが属するインスタンスの ID。	MQ_INST_111111111111_DOxxxxxx

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。これは共通パラメーターです。各リクエストには一意の ID があります。この ID を使用して問題のトラブルシューティングを行います。	DE4140C7-F42D-473D-A5FF-B1E31692****
Data	object	返されるデータ。
ConnectionList	object
ConnectionDo	array<object>	指定されたグループ ID の接続情報。
	object
Version	string	コンシューマークライアントのバージョン。	V4_3_6
ClientAddr	string	コンシューマーインスタンスのアドレスとポート。	30.5.121.**
Language	string	コンシューマーアプリケーションのプログラミング言語。	JAVA
ClientId	string	コンシューマーインスタンスの ID。	30.5.121.**@24813#-1999745829#-1737591554#453111174894656
MessageModel	string

例

成功レスポンス

JSONJSON

{
  "RequestId": "DE4140C7-F42D-473D-A5FF-B1E31692****",
  "Data": {
    "ConnectionList": {
      "ConnectionDo": [
        {
          "Version": "V4_3_6",
          "ClientAddr": "30.5.121.**",
          "Language": "JAVA",
          "ClientId": "30.5.121.**@24813#-1999745829#-1737591554#453111174894656"
        }
      ]
    },
    "MessageModel": ""
  }
}

エラーコード

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

変更履歴

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