ListTransitRouterMulticastGroups - Cloud Enterprise Network

Queries the detailed information about the multicast members and sources in a multicast domain.

Operation description

You can call the ListTransitRouterMulticastGroups operation to query the multicast sources and members in a multicast domain. Multicast sources and members are also known as multicast resources.

If you set GroupIpAddress, the system queries multicast resources in the multicast domain by multicast group.
If you set VSwitchIds, the system queries multicast resources in the multicast domain by vSwitch.
If you set PeerTransitRouterMulticastDomains, the system queries multicast resources that are also deployed in a different region.
If you set ResourceType, the system queries the multicast resources of the specified type in the multicast domain.
If you set ResourceId, the system queries multicast resources by resource.
If you set only TransitRouterMulticastDomainId, the system queries all the multicast resources in the multicast domain.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
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 value, but you must make sure that it is unique among all requests. The token can contain only ASCII characters.	123e4567-e89b-12d3-a456-426655440000
TransitRouterMulticastDomainId	string	No	The ID of the multicast domain. You must configure one of the TransitRouterMulticastDomainId and TransitRouterAttachmentId parameters.	tr-mcast-domain-5mjb5gjb6dgu98****
GroupIpAddress	string	No	The IP address of the multicast group. Each multicast group is identified by its IP address.	239.XX.XX.2
TransitRouterAttachmentId	string	No	The ID of the network instance connection You must configure one of the TransitRouterMulticastDomainId and TransitRouterAttachmentId parameters.	tr-attach-g3kz2k3u76amsk****
VSwitchIds	array	No	The vSwitch IDs.
	string	No	The ID of the vSwitch. You can specify at most 20 IDs.	vsw-p0w9s2ig1jnwgrbzl****
PeerTransitRouterMulticastDomains	array	No	The ID of the inter-region multicast domain.
	string	No	The ID of the inter-region multicast domain. You can specify at most 20 inter-region multicast domain IDs.	tr-mcast-domain-91wpg6wbhchjeq****
ResourceType	string	No	The type of the multicast resource. Valid values: VPC: queries multicast resources by VPC. TR: queries multicast resources that are also deployed in a different region.	VPC
ResourceId	string	No	The ID of the resource associated with the multicast resource.	vpc-p0w9alkte4w2htrqe****
MaxResults	long	No	The number of entries to return on each page. Default value: 20.	20
NextToken	string	No	The token that determines the start point of the query. Valid values: If this is your first query and no next queries are to be sent, ignore this parameter. If a subsequent query is to be sent, set the parameter to the value of NextToken that is returned from the last call.	FFmyTO70tTpLG6I3FmYAXGKPd****
IsGroupSource	boolean	No	Specifies whether to query the multicast sources. Valid values: false true Note This parameter must be specified together with the IsGroupMember parameter. If you do not specify IsGroupMember or IsGroupSource, both the multicast sources and members are queried. If you specify only one of them or both of them, the specified values prevail.	true
IsGroupMember	boolean	No	Specified whether to query the multicast members. Valid values: false true Note This parameter must be specified together with the IsGroupMember parameter. If you do not set IsGroupMember or IsGroupSource, both the multicast sources and members are queried. If you set only one of them or both of them, the specified values prevail.	false
NetworkInterfaceIds	array	No	The IDs of ENIs.
	string	No	The ID of the ENI. You can specify up to 20 ENIs.	eni-p0weuda3lszwzjly****

Response parameters

Parameter	Type	Description	Example
	object	The response.
RequestId	string	The ID of the request.	FB3C4A16-0933-5850-9D43-0C3EA37BCBFB
TotalCount	integer	The total number of entries returned.	1
MaxResults	integer	The number of entries returned per page.	20
NextToken	string	The token that determines the start point of the query. Valid values: If NextToken was not returned, it indicates that no additional results exist. If NextToken was returned in the previous query, specify the value to obtain the next set of results.	FFmyTO70tTpLG6I3FmYAXGKPd****
TransitRouterMulticastGroups	array<object>	A list of multicast groups.
TransitRouterMulticastGroup	object	The information about the multicast group.
GroupIpAddress	string	The IP address of the multicast group to which the multicast resource belongs.	239.XX.XX.2
TransitRouterAttachmentId	string	The ID of the network instance connection.	tr-attach-g3kz2k3u76amsk****
VSwitchId	string	The ID of the vSwitch to which the multicast resource belongs.	vsw-p0w9s2ig1jnwgrbzl****
NetworkInterfaceId	string	The ID of the ENI, which is a multicast resource.	eni-p0weuda3lszwzjly****
PeerTransitRouterMulticastDomainId	string	The ID of the multicast domain associated with the multicast resource that is deployed across regions.	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 multicast resource is a multicast source. Valid values: true: yes false: no	false
GroupMember	boolean	Indicates whether the multicast resource is a multicast member. Valid values: true: yes false: no	true
MemberType	string	The type of the multicast source. If the value is Static, the multicast source is manually specified.	Static
SourceType	string	The type of the multicast member. If the value is Static, the multicast member is manually specified.	Static
ResourceType	string	The type of the multicast resource. Valid values: VPC: The multicast resource is in a VPC. TR: The multicast resource is deployed across regions.	VPC
ResourceOwnerId	long	The ID of the Alibaba Cloud account to which the multicast resource belongs.	253460731706911258
ResourceId	string	The ID of the resource associated with the multicast resource.	vpc-p0w9alkte4w2htrqe****
TransitRouterMulticastDomainId	string	The ID of the multicast domain.	tr-mcast-domain-kx0vk0v7fz8kx4****

Examples

Sample success responses

JSONformat

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

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	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.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-08-04	The Error code has changed	View Change Details
2022-12-02	The Error code has changed	View Change Details