Transit Router
Transit Router
Document
- Documentation
Transit RouterAPI referenceMulticastDescribeTransitRouterMulticastDomains - Querying the list of multicast domains
Copy page
Download PDFMulticast
DescribeTransitRouterMulticastDomains - Querying the list of multicast domains
Copy pageDownload PDFDescribeTransitRouterMulticastDomains - Querying the list of multicast domains
Call the DescribeTransitRouterMulticastDomains API to query the list of multicast domains that meet the specified conditions.
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 value: DescribeTransitRouterMulticastDomains
The interface name. The current API name is DescribeTransitRouterMulticastDomains.
Version String required Example value: 2020-04-01
The interface version. The current API version is 2020-04-01.
TransitRouterId String required Example value: tr-7qthudw0ll6jmc****
The ID of the Transit Router (TR) instance. You can call the DescribeTransitRouters API to obtain the TR instance ID.
TransitRouterMulticastDomainName String optional example value: tr-multicast-name
The name of the multicast domain.
- Must start with a letter, number, or Chinese character. May include letters, numbers, Chinese characters, and the following symbols: periods (.), underscores (_), and hyphens (-).
- Must be 1 to 128 characters.
- If you do not provide this parameter or leave it unset, it defaults to the ID of the multicast domain.
TagFilters.N.Key String Optional Example value: k1
The tag key of the tag.
- N represents the serial number of the tag key, ranging from 1 to 10. Separate multiple tag keys with ampersands (&).
- If multiple tag keys are specified, this action queries the multicast domain associated with all the specified tag keys.
TagFilters.N.Values.N String Optional Example: v1
The tag value.
- The first N represents the serial number of the tag key, ranging from 1 to 10.
- The second N represents the serial number of the tag value, ranging from 1 to 3. The relationship between multiple tag values for the same tag key is a logical "OR". That is, the query returns resources tagged with any one of the specified values for that key.
- Separate multiple tags with ampersands (&).
tip
- To provide this parameter, you must first provide TagFilters.N.Key.
- When an empty value is set for this parameter, it means querying resources where the tag value is empty under the specified tag key.
PageNumber Integer Optional Example: 1
The page number of the list. Default: 1.
PageSize Integer Optional Example value: 20
The number of entries on each page in a pagination query. Valid values: 1–100. Default: 20.
TransitRouterMulticastDomainIds.N String optional example value: tr-md-hy13n2l4c6c0v****
ID list of the transit router multicast domain.
- N: indicates the serial number of the multicast domain, ranging from 1 to 100.
- Use & to separate multiple multicast domain IDs.
Response parameters
The following only details response parameters specific to this API. For more information, see Response structure.
TransitRouterMulticastDomains Object[] Example value: -
Details of qualified multicast domains.
CreationTime String Example value: 2021-04-09T08:36:47+08:00
The time when the multicast domain is created.
Description String Example value: description
Description of the multicast domain.
UpdateTime String Example: 2021-04-10T09:18:28+08:00
The time when the multicast domain is last modified.
TransitRouterMulticastDomainName String Example: name
The name of the multicast domain.
TransitRouterMulticastDomainId String Example value: tr-md-hy13n2l4c6c0v****
The ID of the multicast domain.
Status String Example value: Available
Status of the multicast domain.
- Creating
- Deleting
- Pending: Configuration in progress.
- Available
Tags Object[] Example value: -
The tag information of the multicast domain.
Key String Example: k1
The tag key of the tag.
Value String Example value: v1
The tag value.
PageSize Integer Example value: 20
Number of entries per page in the current pagination.
PageNumber Integer Example value: 1
The current page number.
TotalCount Integer Example value: 1
Total number of multicast domains that meet the condition.
Request examples
GET /?Action=DescribeTransitRouterMulticastDomains&Version=2020-04-01&TransitRouterId=tr-7qthudw0ll6jmc**** HTTP/1.1
Host: transitrouter.cn-beijing.volcengineapi.com
X-Date: 20250721T122038Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20250721/cn-beijing/transitrouter/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f
Response examples
{
"ResponseMetadata": {
"RequestId": "20250721202048196216228017B62AE2",
"Action": "DescribeTransitRouterMulticastDomains",
"Version": "2020-04-01",
"Service": "transitrouter",
"Region": "cn-beijing"
},
"Result": {
"TransitRouterMulticastDomains": {
"CreationTime": "2021-04-09T08:36:47+08:00",
"Description": "description",
"UpdateTime": "2021-04-10T09:18:28+08:00",
"TransitRouterMulticastDomainName": "name",
"TransitRouterMulticastDomainId": "tr-md-hy13n2l4c6c0v****",
"Status": "Available",
"Tags": [
{
"Key": "k1",
"Value": "v1"
}
]
},
"PageSize": 20,
"PageNumber": 1,
"TotalCount": 1
}
}
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: 2026.01.06 11:56:32
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
