All Products
Search

This Product

    Cloud Enterprise Network:ListTransitRouterMulticastGroups

    Document Center

    Cloud Enterprise Network:ListTransitRouterMulticastGroups

    Last Updated:Sep 02, 2026

    Queries the details of multicast members and multicast sources in a multicast domain.

    Operation description

    You can call the ListTransitRouterMulticastGroups operation to query information about multicast members and multicast sources (hereinafter referred to as multicast resources) in a multicast domain.

    • If you specify the GroupIpAddress parameter, you can query multicast resources in a specified multicast group within the multicast domain.

    • If you specify the VSwitchIds parameter, you can query multicast resources under a specified vSwitch within the multicast domain.

    • If you specify the PeerTransitRouterMulticastDomains parameter, you can query cross-region multicast resources within the multicast domain.

    • If you specify the ResourceType parameter, you can query multicast resources of a specified resource type within the multicast domain.

    • If you specify the ResourceId parameter, you can query multicast resources associated with a specified resource.

    • If you specify only the TransitRouterMulticastDomainId parameter, you can query all multicast resources within the multicast domain.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    cen:ListTransitRouterMulticastGroups

    get

    *TransitRouterMulticastDomain

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

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    ClientToken

    string

    No

    The client token that is used to ensure the idempotence of the request.

    You can use the client to generate the token, but you must make sure that the token is unique among different requests. The client token can contain only ASCII characters.

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

    string

    No

    The multicast domain ID.

    You must specify at least one of TransitRouterMulticastDomainId and TransitRouterAttachmentId.

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

    string

    No

    The IP address of the multicast group.

    Each multicast group is identified by a multicast IP address.

    239.XX.XX.2
    TransitRouterAttachmentId

    string

    No

    The network instance connection ID.

    You must specify at least one of TransitRouterMulticastDomainId and TransitRouterAttachmentId.

    tr-attach-g3kz2k3u76amsk****
    VSwitchIds

    array

    No

    The list of vSwitch IDs.

    string

    No

    The vSwitch ID.

    You can specify up to 20 vSwitch IDs.

    vsw-p0w9s2ig1jnwgrbzl****
    PeerTransitRouterMulticastDomains

    array

    No

    The list of cross-region multicast domain IDs.

    string

    No

    The cross-region multicast domain ID.

    You can specify up to 20 cross-region multicast domain IDs.

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

    string

    No

    The type of the multicast resource. Valid values:

    • VPC: queries multicast resources in a virtual private cloud (VPC).

    • TR: queries cross-region multicast resources.

    VPC
    ResourceId

    string

    No

    The resource ID associated with the multicast resource.

    vpc-p0w9alkte4w2htrqe****
    MaxResults

    integer

    No

    The number of entries per page for a paged query. Default value: 20.

    20
    NextToken

    string

    No

    The pagination token that is used in the next request to retrieve a new page of results. Valid values:

    • You do not need to specify this parameter for the first request or if no next query exists.

    • If a next query exists, set the value to the NextToken value returned by the previous API call.

    FFmyTO70tTpLG6I3FmYAXGKPd****
    IsGroupSource

    boolean

    No

    Specifies whether to query multicast sources. Valid values:

    • false: no.

    • true: yes.

    Note

    This parameter is used together with IsGroupMember.

    • If neither parameter is configured, both multicast sources and members are queried by default.

    • If only one parameter is configured or both are configured, the query is based on the configured parameters.

    true
    IsGroupMember

    boolean

    No

    Specifies whether to query multicast members. Valid values:

    • false: no.

    • true: yes.

    Note

    This parameter is used together with IsGroupSource.

    • If neither parameter is configured, both multicast sources and members are queried by default.

    • If only one parameter is configured or both are configured, the query is based on the configured parameters.

    false
    NetworkInterfaceIds

    array

    No

    The list of elastic network interface (ENI) IDs.

    string

    No

    The elastic network interface (ENI) ID.

    You can specify up to 20 elastic network interface (ENI) IDs.

    eni-p0weuda3lszwzjly****

    Response elements

    Element

    Type

    Description

    Example

    object

    The response parameters.

    RequestId

    string

    The request ID.

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

    integer

    The total number of entries returned.

    1
    MaxResults

    integer

    The number of entries per page.

    20
    NextToken

    string

    The pagination token that is used in the next request to retrieve a new page of results. Valid values:

    • If NextToken is empty, no next query exists.

    • If NextToken is returned, the value indicates the token for the next query.

    FFmyTO70tTpLG6I3FmYAXGKPd****
    TransitRouterMulticastGroups

    array<object>

    The list of multicast group information.

    object

    The multicast group information.

    GroupIpAddress

    string

    The IP address of the multicast group to which the multicast resource belongs.

    239.XX.XX.2
    TransitRouterAttachmentId

    string

    The network instance connection ID.

    tr-attach-g3kz2k3u76amsk****
    VSwitchId

    string

    The ID of the vSwitch to which the multicast resource belongs.

    vsw-p0w9s2ig1jnwgrbzl****
    NetworkInterfaceId

    string

    The elastic network interface (ENI) ID, which is the multicast resource ID.

    eni-p0weuda3lszwzjly****
    PeerTransitRouterMulticastDomainId

    string

    The ID of the multicast domain associated with the cross-region multicast resource.

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

    string

    The status of the multicast resource. Valid values:

    • Registering: being created.

    • Registered: available.

    • Deregistering: being deleted.

    Registered
    GroupSource

    boolean

    Indicates whether the current multicast resource is a multicast source. Valid values:

    • true: The multicast resource is a multicast source.

    • false: The multicast resource is not a multicast source.

    false
    GroupMember

    boolean

    Indicates whether the current multicast resource is a multicast member. Valid values:

    • true: The multicast resource is a multicast member.

    • false: The multicast resource is not a multicast member.

    true
    MemberType

    string

    The type of the multicast member. Valid values:

    • Static: The multicast member is manually specified.

    • IGMPv2: The multicast member dynamically joined the multicast group through the IGMP protocol.

    Static
    SourceType

    string

    The type of the multicast source. Valid values:

    • Static: The multicast source is manually specified.

    • IGMPv2: The multicast source dynamically joined the multicast group through the IGMP protocol.

    Static
    ResourceType

    string

    The type of the multicast resource. Valid values:

    • VPC: The multicast resource is a resource in a VPC.

    • TR: The multicast resource is a cross-region resource.

    VPC
    ResourceOwnerId

    integer

    The ID of the Alibaba Cloud account to which the multicast resource belongs.

    11081188765****
    ResourceId

    string

    The resource ID associated with the multicast resource.

    vpc-p0w9alkte4w2htrqe****
    TransitRouterMulticastDomainId

    string

    The multicast domain ID.

    tr-mcast-domain-kx0vk0v7fz8kx4****

    Examples

    Success response

    JSON format

    {
  "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****"
    }
  ]
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 IllegalParam.NextToken The specified NextToken is illegal. The error message returned because the NextToken parameter is set to an invalid value.
    400 IllegalParam.TransitRouterMulticastDomainId The specified TransitRouterMulticastDomainId is illegal. The error message returned because the specified multicast domain ID specified for the transit router (TransitRouterMulticastDomainId) is invalid.
    400 IllegalParam.MaxResults The specified MaxResults is illegal. MaxResults illegal.
    400 IllegalParam.TransitRouterAttachmentId TransitRouterAttachmentId is illegal. The error message returned because the specified transit router is invalid.
    400 InvalidParameter Invalid parameter. The error message returned because the parameter is set to an invalid value.
    400 Unauthorized The AccessKeyId is unauthorized. The error message returned because you do not have the permissions to perform this operation.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.