Transit Router
Transit Router
Document
- Documentation
Transit RouterAPI referenceMulticastDescribeTransitRouterMulticastGroups - Query multicast group list
Copy page
Download PDFMulticast
DescribeTransitRouterMulticastGroups - Query multicast group list
Copy pageDownload PDFDescribeTransitRouterMulticastGroups - Query multicast group list
Call the DescribeTransitRouterMulticastGroups API to query the multicast sources and multicast members in the specified multicast domain.
Debug
API Explorer
You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.
Request parameters
The following only details request parameters specific to this API and key common parameters. For more information, see Common parameters.
Action String required Example: DescribeTransitRouterMulticastGroups
The interface name. The current API name is DescribeTransitRouterMulticastGroups.
Version String required Example value: 2020-04-01
The interface version. The current API version is 2020-04-01.
TransitRouterMulticastDomainId String required Example value: tr-md-hy13n2l4c6c0v****
The ID of the multicast domain. You can call DescribeTransitRouterMulticastDomains to obtain the multicast domain ID.
tip
You must specify at least one of: this parameter, TransitRouterMulticastDomainId or ResourceId.
GroupIpAddress String required Example: 224.0.1.0
IP address of the multicast group. Value range: 224.0.1.0-239.255.255.254.
TransitRouterAttachmentId String required Example value: tr-attach-a*******
The ID of the network instance attachment. You can call the DescribeTransitRouterVpcAttachments API to obtain the ID of the Virtual Private Cloud (VPC) attachment.
ResourceType String required Example value: VPC
The type of the multicast resource.
- VPC: Virtual Private Cloud.
ResourceId String required Example value: vpc-bp1aevy8sofi8mh1****
SubnetIds.N String required Example value: subnet-123456
ID of the subnet.
- N represents the serial number of the subnet ID, ranging from 1 to 100.
- Separate multiple subnet IDs with ampersands (&).
NetworkInterfaceIds.N String required Example value: eni-123456
Network Interface ID.
- N represents the serial number of the network interface ID, with a value range of 1 to 100.
- Separate multiple network interface IDs with ampersands (&).
IsGroupSource Boolean required Example value: true
Whether to query the multicast source.
- true: Yes.
- false: No.
IsGroupMember Boolean required Example value: true
Describe whether to query multicast members.
- true: Yes.
- false: No.
SourceType String required Example value: Static
The type of the multicast source.
- Static: Static multicast source, indicating to specify the multicast source manually.
MemberType String required Example value: Static
The type of the multicast member.
- Static: Static multicast member, indicating that multicast member is manually specified.
PageNumber Integer required Example value: 1
The page number of the list. Default: 1.
PageSize Integer required Example: 20
The number of entries on each page in a pagination query. Valid values: 1–100. Default: 20.
Response parameters
The following only details response parameters specific to this API. For more information, see Response structure.
TransitRouterMulticastGroups Object[] Example value: -
Resource information about qualified multicast groups.
CreationTime String Example value: 2021-04-09T08:36:47+08:00
The time when the multicast group is created.
UpdateTime String Example value: 2021-04-10T09:18:28+08:00
The time when the multicast group is last operated.
Status String Example value: Available
Status of the multicast resource.
- Creating
- Deleting
- Pending: Configuration in progress.
- Available
TransitRouterMulticastDomainId String Example: tr-md-3t6b1n60vg4jks0txrs8****
The ID of the multicast domain.
GroupIpAddress String Example value: 224.0.1.0
IP address of the multicast group.
TransitRouterAttachmentId String Example: tr-attach-16b4ks6wd****
The ID of the network instance attachment.
ResourceType String Example value: VPC
The network instance type.
- VPC: Virtual Private Cloud.
ResourceId String Example value: vpc-bp1aevy8sofi8mh1****
The network instance ID.
SubnetId String Example value: subnet-1wdfv3tfh6****
ID of the subnet.
NetworkInterfaceId String Example value: eni-wsdfgg5wrf****
Network Interface ID.
GroupSource Boolean Example value: true
Describe whether the current multicast resource is a multicast source.
- true: Yes.
- false: No.
GroupMember Boolean Example value: true
Describe whether the current multicast resource is a multicast member.
- true: Yes.
- false: No.
SourceType String Example value: Static
The type of the multicast source.
- Static: Static multicast source, indicating to specify the multicast source manually.
MemberType String Example value: Static
The type of the multicast member.
- Static: Static multicast member, indicating that multicast member is manually specified.
TransitRouterId String Example value: tr-1aadrf4cgh****
The ID of the Transit Router (TR) instance.
PageNumber Integer Example value: 1
The page number of the current multicast group list returned, indicating pagination information of the query results.
PageSize Integer Example value: 10
Number of multicast groups displayed per page.
TotalCount Integer Example value: 2
The total number of qualified multicast group resources.
Request examples
GET /?Action=DescribeTransitRouterMulticastGroups&Version=2020-04-01 HTTP/1.1
Host: transitrouter.cn-beijing.volcengineapi.com
X-Date: 20250721T122158Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20250721/cn-beijing/transitrouter/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f
Response examples
{
"ResponseMetadata": {
"RequestId": "20230604110420****100232280022D31",
"Action": "DescribeTransitRouterMulticastGroups",
"Version": "2020-04-01",
"Service": "transitrouter",
"Region": "cn-beijing"
},
"Result": {
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 2,
"TransitRouterMulticastGroups": [
{
"Status": "Available",
"SubnetId": "subnet-1wdfv3tfh6****",
"MemberType": "Static",
"ResourceId": "vpc-bp1aevy8sofi8mh1****",
"SourceType": "Static",
"UpdateTime": "2021-04-10T09:18:28+08:00",
"GroupMember": true,
"GroupSource": true,
"CreationTime": "2021-04-09T08:36:47+08:00",
"ResourceType": "VPC",
"GroupIpAddress": "224.0.1.0",
"TransitRouterId": "tr-1aadrf4cgh****",
"NetworkInterfaceId": "eni-wsdfgg5wrf****",
"TransitRouterAttachmentId": "tr-attach-16b4ks6wd****",
"TransitRouterMulticastDomainId": "tr-md-3t6b1n60vg4jks0txrs8****"
}
]
}
}
Error codes
The table below describes the error codes for this API that are associated with business logic. For more information, see Common error codes.
Last updated: 2025.12.29 19:35:42
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
