OnsInstanceInServiceList の呼び出しによるサービス中インスタンスのクエリ - ApsaraMQ for RocketMQ

指定されたリージョン内のすべての ApsaraMQ for RocketMQ 4.x インスタンスを照会します。

操作説明

重要 Alibaba Cloud が提供する OpenAPI は、管理用のアプリケーションプログラミングインターフェイス (API) です。この 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:QueryInstanceBaseInfo

list

Instance

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Tag	array<object>	任意	インスタンスにアタッチされたタグのリスト。リストには最大 20 個の要素を含めることができます。
	object	任意	インスタンスにアタッチされたタグ。
Key	string	任意	タグキー。Key と Value の両方を指定して、タグでインスタンスをフィルターします。両方を省略すると、すべてのインスタンスが照会されます。このパラメーターは空の文字列にできません。タグキーの長さは最大 128 文字です。`aliyun` または `acs:` で始めることはできません。`http://` または `https://` を含めることはできません。	CartService
Value	string	任意	タグ値。Key と Value の両方を指定して、タグでインスタンスをフィルターします。両方を省略すると、すべてのインスタンスが照会されます。このパラメーターは空の文字列にすることができます。タグ値の長さは最大 128 文字です。`aliyun` または `acs:` で始めることはできません。`http://` または `https://` を含めることはできません。	SericeA
NeedResourceInfo	boolean	任意	リソースの統計情報を返すかどうかを指定します。統計情報には、インスタンス内の Topic 数とグループ数が含まれます。	true

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエストの ID です。これは、各リクエストに一意な共通パラメーターです。問題のトラブルシューティングや特定に、この ID を使用します。	0598E46F-DB06-40E2-AD7B-C45923EE****
Data	object
InstanceVO	array<object>	公開済みのすべてのインスタンスのリスト。
	array<object>	公開済みのすべてのインスタンスのリストです。
IndependentNaming	boolean	インスタンスに名前空間があるかどうかを示します。有効な値は次のとおりです： true：インスタンスには独立した名前空間があります。リソース名はインスタンス内で一意である必要がありますが、他のインスタンスのリソース名と同じにすることができます。 false：インスタンスには独立した名前空間がありません。リソース名は、インスタンス内およびすべてのインスタンス間でグローバルに一意である必要があります。	true
InstanceName	string	インスタンス名。	test1
ReleaseTime	integer	Platinum インスタンスの有効期限です。	1551024000000
InstanceStatus	integer	インスタンスのステータス。有効な値は次のとおりです： 0：Platinum インスタンスはデプロイ中です。 2：Standard インスタンスは支払期限切れです。 5：Standard インスタンスまたは Platinum インスタンスはサービス中です。 7：Platinum インスタンスはスペックアップ中ですが、利用可能です。	5
Tags	object
Tag	array<object>	インスタンスにアタッチされたタグ。
	object	インスタンスにアタッチされたタグ。
Key	string	タグキー。	CartService
Value	string	タグの値。	ServiceA
InstanceId	string	インスタンスの ID です。	MQ_INST_188077086902****_BXSuW61e
InstanceType	integer	インスタンスのタイプ。有効な値は次のとおりです： 1：スタンダードインスタンス 2：プラチナインスタンスインスタンスタイプの仕様と相違点の詳細については、「インスタンスタイプ」をご参照ください。	2
CreateTime	integer	インスタンスが作成された時刻です。この値はミリ秒単位の UNIX タイムスタンプです。	1640847284000
TopicCount	integer	Topic の数。	1
GroupCount	integer	使用者グループの数。	3

例

成功レスポンス

JSONJSON

{
  "RequestId": "0598E46F-DB06-40E2-AD7B-C45923EE****",
  "Data": {
    "InstanceVO": [
      {
        "IndependentNaming": true,
        "InstanceName": "test1",
        "ReleaseTime": 1551024000000,
        "InstanceStatus": 5,
        "Tags": {
          "Tag": [
            {
              "Key": "CartService",
              "Value": "ServiceA"
            }
          ]
        },
        "InstanceId": "MQ_INST_188077086902****_BXSuW61e",
        "InstanceType": 2,
        "CreateTime": 1640847284000,
        "TopicCount": 1,
        "GroupCount": 3
      }
    ]
  }
}

エラーコード

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

変更履歴

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