すべてのプロダクト
Search

このプロダクト

    Cloud Enterprise Network:ListTransitRouterMulticastGroups

    ドキュメントセンター

    Cloud Enterprise Network:ListTransitRouterMulticastGroups

    最終更新日:Aug 08, 2025

    マルチキャストドメイン内のマルチキャストメンバーとソースに関する詳細をクエリします。

    操作説明

    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

    任意

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

    リクエストごとにクライアントから一意の値を生成します。ClientToken パラメーターには 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

    任意

    各ページに戻すエントリの数。デフォルト値: 20。

    20
    NextToken

    string

    任意

    次の結果ページのトークン。

    • これが最初のクエリである場合、または次のページが存在しない場合は、このパラメーターを指定しないでください。

    • 次のページが存在する場合は、このパラメーターを前の呼び出しから返された NextToken 値に設定します。

    FFmyTO70tTpLG6I3FmYAXGKPd****
    IsGroupSource

    boolean

    任意

    マルチキャストソースをクエリするかどうかを指定します。

    • [false]: いいえ。

    • [true]: はい。

    説明

    このパラメーターは IsGroupMember と連携して動作します。

    • IsGroupSource または IsGroupMember を指定しない場合、システムはマルチキャストソースとメンバーの両方をクエリします。

    • 1 つまたは両方のパラメーターを指定した場合、システムは指定されたパラメーターに基づいてリソースをクエリします。

    true
    IsGroupMember

    boolean

    任意

    マルチキャストメンバーをクエリするかどうかを指定します。

    • [false]: いいえ。

    • [true]: はい。

    説明

    このパラメーターは IsGroupSource と連携して動作します。

    • IsGroupMember または IsGroupSource を指定しない場合、システムはマルチキャストメンバーとソースの両方をクエリします。

    • 1 つまたは両方のパラメーターを指定した場合、システムは指定されたパラメーターに基づいてリソースをクエリします。

    false
    NetworkInterfaceIds

    array

    任意

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

    string

    任意

    ENI の ID。

    最大 20 個の 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

    ENI の ID。ENI はマルチキャストリソースです。

    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]: マルチキャストメンバーは、Internet Group Management Protocol Version 2 ( IGMPv2 ) に基づいて動的にマルチキャストグループに参加します。

    Static
    SourceType

    string

    マルチキャストソースのタイプ。

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

    • [IGMPv2]: マルチキャストソースは、IGMPv2 に基づいて動的にマルチキャストグループに参加します。

    Static
    ResourceType

    string

    マルチキャストリソースのタイプ。

    • [VPC]: マルチキャストリソースは VPC 内にあります。

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

    VPC
    ResourceOwnerId

    integer

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

    253460731706911258
    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": 253460731706911260,
      "ResourceId": "vpc-p0w9alkte4w2htrqe****",
      "TransitRouterMulticastDomainId": "tr-mcast-domain-kx0vk0v7fz8kx4****"
    }
  ]
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 IllegalParam.NextToken The specified NextToken is illegal.
    400 IllegalParam.TransitRouterMulticastDomainId The specified TransitRouterMulticastDomainId is illegal.
    400 IllegalParam.MaxResults The specified MaxResults is illegal.
    400 IllegalParam.TransitRouterAttachmentId TransitRouterAttachmentId is illegal.
    400 InvalidParameter Invalid parameter.
    400 Unauthorized The AccessKeyId is unauthorized.

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

    変更履歴

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