全部產品
Search

搜尋本產品

    ：ListTransitRouterMulticastGroups - 查詢組播域下組播成員和組播源的資訊

    文件中心

    ：ListTransitRouterMulticastGroups - 查詢組播域下組播成員和組播源的資訊

    更新時間：Aug 08, 2025

    調用ListTransitRouterMulticastGroups介面查詢組播域下組播成員和組播源的詳細資料。

    介面說明

    您可以調用ListTransitRouterMulticastGroups介面查詢組播域下組播成員和組播源（以下簡稱為組播資源）的資訊。

    • 如果您指定 GroupIpAddress 參數的值，則您可以查詢組播域下指定組播組下的組播資源的資訊。

    • 如果您指定 VSwitchIds 參數的值，則您可以查詢組播域下指定交換器下的組播資源的資訊。

    • 如果您指定 PeerTransitRouterMulticastDomains 參數的值，則您可以查詢組播域下跨地區組播資源的資訊。

    • 如果您指定 ResourceType 參數的值，則您可以查詢組播域下屬於某一資源類型的組播資源的資訊。

    • 如果您指定 ResourceId 參數的值，則您可以查詢某一資源下組播資源的資訊。

    • 如果您僅指定 TransitRouterMulticastDomainId 參數的值，則您可以查詢組播域下所有組播資源的資訊。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    cen:ListTransitRouterMulticastGroups

    get

    *TransitRouterMulticastDomain

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

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    ClientToken

    string

    否

    用戶端 Token，用於保證請求的等冪性。

    從您的用戶端產生一個參數值，確保不同請求間該參數值唯一。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

    否

    交換器 ID 列表。

    string

    否

    交換器 ID。

    最多支援輸入 20 個交換器 ID。

    vsw-p0w9s2ig1jnwgrbzl****
    PeerTransitRouterMulticastDomains

    array

    否

    跨地區組播域 ID 列表。

    string

    否

    跨地區組播域 ID。

    最多支援輸入 20 個跨地區組播域 ID。

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

    string

    否

    組播資源的類型。

    • VPC：表示查詢Virtual Private Cloud（Virtual Private Cloud）下的組播資源資訊。

    • TR：表示查詢跨地區的組播資源的資訊。

    VPC
    ResourceId

    string

    否

    組播資源關聯的資源 ID。

    vpc-p0w9alkte4w2htrqe****
    MaxResults

    integer

    否

    分批次查詢時每次顯示的條目數。預設值：20。

    20
    NextToken

    string

    否

    是否擁有下一次查詢的令牌（Token）。取值：

    • 第一次查詢和沒有下一次查詢時，均無需填寫。

    • 如果有下一次查詢，取值為上一次 API 呼叫返回的 NextToken 值。

    FFmyTO70tTpLG6I3FmYAXGKPd****
    IsGroupSource

    boolean

    否

    是否查詢組播源。

    • false：否。

    • true：是。

    說明

    和 IsGroupMember 配合使用。

    • 若兩者均不配置，則預設查詢組播源和成員。

    • 若只配置其一或兩者均配置，則以配置參數為準。

    true
    IsGroupMember

    boolean

    否

    是否查詢組播成員。

    • false：否。

    • true：是。

    說明

    和 IsGroupMember 配合使用。

    • 若兩者均不配置，則預設查詢組播源和成員。

    • 若只配置其一或兩者均配置，則以配置參數為準。

    false
    NetworkInterfaceIds

    array

    否

    彈性網卡 ID 列表。

    string

    否

    彈性網卡 ID。

    最多支援輸入 20 個彈性網卡 ID。

    eni-p0weuda3lszwzjly****

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    返回結果。

    RequestId

    string

    請求 ID。

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

    integer

    列表條目數。

    1
    MaxResults

    integer

    分批次查詢時每次顯示的條目數。

    20
    NextToken

    string

    是否擁有下一次查詢的令牌（Token）。取值：

    • 如果 NextToken 為空白表示沒有下一次查詢。

    • 如果 NextToken 有傳回值，該取值表示下一次查詢開始的令牌。

    FFmyTO70tTpLG6I3FmYAXGKPd****
    TransitRouterMulticastGroups

    array<object>

    組播組資訊列表。

    object

    組播組的資訊。

    GroupIpAddress

    string

    組播資源所屬的組播組的 IP 位址。

    239.XX.XX.2
    TransitRouterAttachmentId

    string

    網路執行個體串連 ID。

    tr-attach-g3kz2k3u76amsk****
    VSwitchId

    string

    組播資源所屬交換器的 ID。

    vsw-p0w9s2ig1jnwgrbzl****
    NetworkInterfaceId

    string

    彈性網卡 ID（即組播資源 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

    組播資源所屬的阿里雲帳號（主帳號）ID。

    11081188765****
    ResourceId

    string

    組播資源關聯的資源 ID。

    vpc-p0w9alkte4w2htrqe****
    TransitRouterMulticastDomainId

    string

    組播域 ID。

    tr-mcast-domain-kx0vk0v7fz8kx4****

    樣本

    正常返回樣本

    JSON格式

    {
  "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 status code

    錯誤碼

    錯誤資訊

    描述
    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. 帳號無許可權操作。

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。