OnsGroupList - - Alibaba Cloud ドキュメントセンター

指定されたインスタンス内のすべてのグループ 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:ListGroup

list

Group

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

なし

mq:QueryInstanceBaseInfo

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceId	string	任意	グループ ID が属するインスタンスの ID。	MQ_INST_111111111111_DOxxxxxx
GroupId	string	任意	あいまい検索を実行するためにグループ ID を指定します。このパラメーターを空のままにすると、すべてのグループ ID が照会されます。 GID_ABC を入力すると、プレフィックスとサフィックスを照合してあいまい検索が実行されます。GID_test_GID_ABC_123 や GID_ABC_356 など、GID_ABC を含むすべてのグループ ID が返されます。	GID_test_group_id
GroupType	string	任意	照会するグループ ID がサポートするプロトコル。TCP プロトコルと HTTP プロトコルのグループ ID は共有できません。別途作成する必要があります。有効な値： tcp：デフォルト値です。グループ ID が TCP プロトコル経由のメッセージの送受信にのみ適用されることを示します。 http：グループ ID が HTTP プロトコル経由のメッセージの送受信にのみ適用されることを示します。	tcp
Tag	array<object>	任意	グループ ID にアタッチされているタグのリスト。リスト内の要素数は 20 を超えることはできません。
	object	任意
Key	string	必須	グループ ID のタグキー。Key と Value の両方を指定するか、両方を空のままにします。両方を指定した場合、システムは一致するグループ ID をフィルターします。両方を空のままにすると、すべてのグループ ID が照会されます。このパラメーターを指定する場合、その値を空の文字列にすることはできません。値の長さは最大 128 文字です。`aliyun` または `acs:` で始めることはできず、`http://` または `https://` を含めることはできません。	CartService
Value	string	必須	グループ ID のタグ値。Key と Value の両方を指定するか、両方を空のままにします。両方を指定した場合、システムは一致するグループ ID をフィルターします。両方を空のままにすると、すべてのグループ ID が照会されます。このパラメーターを指定する場合、その値を空の文字列にすることができます。値の長さは最大 128 文字です。`aliyun` または `acs:` で始めることはできず、`http://` または `https://` を含めることはできません。	ServiceA

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエストの ID。これは共通パラメーターです。各リクエストには一意の ID があります。この ID を使用して、問題のトラブルシューティングを行うことができます。	16996623-AC4A-43AF-9248-FD9D2D75****
Data	object
SubscribeInfoDo	array<object>	返されるサブスクリプション関係のセット。
	array<object>
Owner	string	発行情報のオーナー。	138015630679****
UpdateTime	integer	グループ ID が更新された時間。	1570700979000
IndependentNaming	boolean	インスタンスに名前空間があるかどうかを示します。有効な値： true：インスタンスには独立した名前空間があります。リソース名はインスタンス内で一意である必要があります。リソース名はインスタンス間で同じにすることができます。 false：インスタンスには独立した名前空間がありません。リソース名は、インスタンス内またはインスタンス間でグローバルに一意である必要があります。	true
GroupId	string	グループ ID。使用者グループの ID です。	GID_test_group_id
Remark	string	備考。	test
CreateTime	integer	グループ ID が作成された時間。	1568896605000
Tags	object
Tag	array<object>	グループ ID にアタッチされているタグ。
	object
Key	string	タグキー。	CartService
Value	string	タグ値。	ServiceA
InstanceId	string	インスタンス ID。	MQ_INST_111111111111_DOxxxxxx
GroupType	string	照会するグループ ID がサポートするプロトコル。TCP プロトコルと HTTP プロトコルのグループ ID は共有できません。別途作成する必要があります。有効な値： tcp：グループ ID が TCP プロトコル経由のメッセージの送受信にのみ適用されることを示します。 http：グループ ID が HTTP プロトコル経由のメッセージの送受信にのみ適用されることを示します。	tcp

例

成功レスポンス

JSONJSON

{
  "RequestId": "16996623-AC4A-43AF-9248-FD9D2D75****",
  "Data": {
    "SubscribeInfoDo": [
      {
        "Owner": "138015630679****",
        "UpdateTime": 1570700979000,
        "IndependentNaming": true,
        "GroupId": "GID_test_group_id",
        "Remark": "test",
        "CreateTime": 1568896605000,
        "Tags": {
          "Tag": [
            {
              "Key": "CartService",
              "Value": "ServiceA"
            }
          ]
        },
        "InstanceId": "MQ_INST_111111111111_DOxxxxxx",
        "GroupType": "tcp"
      }
    ]
  }
}

エラーコード

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

変更履歴

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