すべてのプロダクト
Search

このプロダクト

    Cloud Enterprise Network:ListTransitRouterMulticastGroups

    ドキュメントセンター

    Cloud Enterprise Network:ListTransitRouterMulticastGroups

    最終更新日:Sep 02, 2026

    マルチキャストドメイン内のマルチキャストメンバーおよびマルチキャストソースの詳細を照会します。

    操作説明

    ListTransitRouterMulticastGroups 操作を呼び出して、マルチキャストドメイン内のマルチキャストメンバーおよびマルチキャストソース (以下、マルチキャストリソース) に関する情報をクエリできます。

    • GroupIpAddress パラメーターを指定すると、マルチキャストドメイン内の指定されたマルチキャストグループのマルチキャストリソースをクエリできます。

    • VSwitchIds パラメーターを指定すると、マルチキャストドメイン内の指定された vSwitch 配下のマルチキャストリソースをクエリできます。

    • PeerTransitRouterMulticastDomains パラメーターを指定すると、マルチキャストドメイン内のクロスリージョンマルチキャストリソースをクエリできます。

    • ResourceType パラメーターを指定すると、マルチキャストドメイン内の指定されたリソースタイプのマルチキャストリソースをクエリできます。

    • ResourceId パラメーターを指定すると、指定されたリソースに関連付けられたマルチキャストリソースをクエリできます。

    • TransitRouterMulticastDomainId パラメーターのみを指定すると、マルチキャストドメイン内のすべてのマルチキャストリソースをクエリできます。

    今すぐお試しください

    この 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    cen:ListTransitRouterMulticastGroups

    get

    *TransitRouterMulticastDomain

    acs:cen:*:{#accountId}:centransitroutermulticast/{#centransitroutermulticastId}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    ClientToken

    string

    任意

    リクエストのべき等性を確保するために使用されるクライアントトークン。

    クライアントを使用してトークンを生成できますが、異なるリクエスト間でトークンが一意であることを確認する必要があります。クライアントトークンには ASCII 文字のみを使用できます。

    123e4567-e89b-12d3-a456-426655440000
    TransitRouterMulticastDomainId

    string

    任意

    マルチキャストドメインの ID。

    TransitRouterMulticastDomainId と TransitRouterAttachmentId のうち、少なくとも一方を指定する必要があります。

    tr-mcast-domain-5mjb5gjb6dgu98****
    GroupIpAddress

    string

    任意

    マルチキャストグループの IP アドレス。

    各マルチキャストグループは、マルチキャスト IP アドレスによって識別されます。

    239.XX.XX.2
    TransitRouterAttachmentId

    string

    任意

    ネットワークインスタンス接続の ID。

    TransitRouterMulticastDomainId と TransitRouterAttachmentId のうち、少なくとも一方を指定する必要があります。

    tr-attach-g3kz2k3u76amsk****
    VSwitchIds

    array

    任意

    vSwitch ID のリスト。

    string

    任意

    vSwitch の ID。

    最大 20 個の vSwitch ID を指定できます。

    vsw-p0w9s2ig1jnwgrbzl****
    PeerTransitRouterMulticastDomains

    array

    任意

    クロスリージョンマルチキャストドメイン ID のリスト。

    string

    任意

    クロスリージョンマルチキャストドメインの ID。

    最大 20 個のクロスリージョンマルチキャストドメイン ID を指定できます。

    tr-mcast-domain-91wpg6wbhchjeq****
    ResourceType

    string

    任意

    マルチキャストリソースのタイプ。有効な値:

    • VPC: 仮想非公開クラウド (VPC) 内のマルチキャストリソースをクエリします。

    • TR: クロスリージョンマルチキャストリソースをクエリします。

    VPC
    ResourceId

    string

    任意

    マルチキャストリソースに関連付けられたリソースの ID。

    vpc-p0w9alkte4w2htrqe****
    MaxResults

    integer

    任意

    ページングクエリの 1 ページあたりのエントリ数。デフォルト値: 20。

    20
    NextToken

    string

    任意

    次のリクエストで新しい結果ページを取得するために使用されるページネーショントークン。有効な値:

    • 最初のリクエストの場合、または次のクエリが存在しない場合は、このパラメーターを指定する必要はありません。

    • 次のクエリが存在する場合は、前の API 呼び出しで返された NextToken の値を設定します。

    FFmyTO70tTpLG6I3FmYAXGKPd****
    IsGroupSource

    boolean

    任意

    マルチキャストソースを照会するかどうかを指定します。有効な値:

    • false: いいえ。

    • true: はい。

    説明

    このパラメーターは IsGroupMember と併用します。

    • どちらのパラメーターも設定されていない場合、デフォルトでマルチキャストソースとメンバーの両方が照会されます。

    • 一方のパラメーターのみが設定されている場合、または両方が設定されている場合は、設定されたパラメーターに基づいてクエリが実行されます。

    true
    IsGroupMember

    boolean

    任意

    マルチキャストメンバーを照会するかどうかを指定します。有効な値:

    • false: いいえ。

    • true: はい。

    説明

    このパラメーターは IsGroupSource と併用します。

    • どちらのパラメーターも設定されていない場合、デフォルトでマルチキャストソースとメンバーの両方が照会されます。

    • 一方のパラメーターのみが設定されている場合、または両方が設定されている場合は、設定されたパラメーターに基づいてクエリが実行されます。

    false
    NetworkInterfaceIds

    array

    任意

    Elastic Network Interface (ENI) ID のリスト。

    string

    任意

    Elastic Network Interface (ENI) の ID。

    最大 20 個の Elastic Network Interface (ENI) ID を指定できます。

    eni-p0weuda3lszwzjly****

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答パラメーター。

    RequestId

    string

    リクエスト ID。

    FB3C4A16-0933-5850-9D43-0C3EA37BCBFB
    TotalCount

    integer

    返されたエントリの総数。

    1
    MaxResults

    integer

    1 ページあたりのエントリ数。

    20
    NextToken

    string

    次のリクエストで新しい結果ページを取得するために使用されるページネーショントークン。有効な値:

    • NextToken が空の場合、次のクエリは存在しません。

    • NextToken が返された場合、その値は次のクエリのトークンを示します。

    FFmyTO70tTpLG6I3FmYAXGKPd****
    TransitRouterMulticastGroups

    array<object>

    マルチキャストグループ情報のリスト。

    object

    マルチキャストグループ情報。

    GroupIpAddress

    string

    マルチキャストリソースが属するマルチキャストグループの IP アドレス。

    239.XX.XX.2
    TransitRouterAttachmentId

    string

    ネットワークインスタンス接続の ID。

    tr-attach-g3kz2k3u76amsk****
    VSwitchId

    string

    マルチキャストリソースが属する vSwitch の ID。

    vsw-p0w9s2ig1jnwgrbzl****
    NetworkInterfaceId

    string

    マルチキャストリソース ID である Elastic Network Interface (ENI) の ID。

    eni-p0weuda3lszwzjly****
    PeerTransitRouterMulticastDomainId

    string

    クロスリージョンマルチキャストリソースに関連付けられたマルチキャストドメインの ID。

    tr-mcast-domain-91wpg6wbhchjeq****
    Status

    string

    マルチキャストリソースのステータス。有効な値:

    • Registering: 作成中。

    • Registered: 利用可能。

    • Deregistering: 削除中。

    Registered
    GroupSource

    boolean

    現在のマルチキャストリソースがマルチキャストソースであるかどうかを示します。有効な値:

    • true: マルチキャストリソースはマルチキャストソースです。

    • false: マルチキャストリソースはマルチキャストソースではありません。

    false
    GroupMember

    boolean

    現在のマルチキャストリソースがマルチキャストメンバーであるかどうかを示します。有効な値:

    • true: マルチキャストリソースはマルチキャストメンバーです。

    • false: マルチキャストリソースはマルチキャストメンバーではありません。

    true
    MemberType

    string

    マルチキャストメンバーのタイプ。有効な値:

    • Static: マルチキャストメンバーは手動で指定されています。

    • IGMPv2: マルチキャストメンバーは IGMP プロトコルを通じてマルチキャストグループに動的に参加しました。

    Static
    SourceType

    string

    マルチキャストソースのタイプ。有効な値:

    • Static: マルチキャストソースは手動で指定されています。

    • IGMPv2: マルチキャストソースは IGMP プロトコルを通じてマルチキャストグループに動的に参加しました。

    Static
    ResourceType

    string

    マルチキャストリソースのタイプ。有効な値:

    • VPC: マルチキャストリソースは VPC 内のリソースです。

    • TR: マルチキャストリソースはクロスリージョンリソースです。

    VPC
    ResourceOwnerId

    integer

    マルチキャストリソースが属する Alibaba Cloud アカウントの ID。

    11081188765****
    ResourceId

    string

    マルチキャストリソースに関連付けられたリソースの ID。

    vpc-p0w9alkte4w2htrqe****
    TransitRouterMulticastDomainId

    string

    マルチキャストドメインの ID。

    tr-mcast-domain-kx0vk0v7fz8kx4****

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "FB3C4A16-0933-5850-9D43-0C3EA37BCBFB",
  "TotalCount": 1,
  "MaxResults": 20,
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "TransitRouterMulticastGroups": [
    {
      "GroupIpAddress": "239.XX.XX.2",
      "TransitRouterAttachmentId": "tr-attach-g3kz2k3u76amsk****",
      "VSwitchId": "vsw-p0w9s2ig1jnwgrbzl****",
      "NetworkInterfaceId": "eni-p0weuda3lszwzjly****",
      "PeerTransitRouterMulticastDomainId": "tr-mcast-domain-91wpg6wbhchjeq****",
      "Status": "Registered",
      "GroupSource": false,
      "GroupMember": true,
      "MemberType": "Static",
      "SourceType": "Static",
      "ResourceType": "VPC",
      "ResourceOwnerId": 0,
      "ResourceId": "vpc-p0w9alkte4w2htrqe****",
      "TransitRouterMulticastDomainId": "tr-mcast-domain-kx0vk0v7fz8kx4****"
    }
  ]
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 IllegalParam.NextToken The specified NextToken is illegal. リクエストで指定された NextToken が無効です。
    400 IllegalParam.TransitRouterMulticastDomainId The specified TransitRouterMulticastDomainId is illegal. リクエストに指定された TransitRouterMulticastDomainId が無効です。
    400 IllegalParam.MaxResults The specified MaxResults is illegal. MaxResults の値が無効です。
    400 IllegalParam.TransitRouterAttachmentId TransitRouterAttachmentId is illegal. リクエストに指定された TrInstance が無効です。
    400 InvalidParameter Invalid parameter. パラメーターが無効です。
    400 Unauthorized The AccessKeyId is unauthorized. アカウントにこの操作を実行する権限がありません。

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

    変更履歴

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