Docs

Transit Router

Multicast

DescribeTransitRouterMulticastDomainAssociations - Querying multicast domain association

Call the DescribeTransitRouterMulticastDomainAssociations API to query the association information about multicast domains that meet 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.

Go to debug

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: DescribeTransitRouterMulticastDomainAssociations

The interface name. The current API name is DescribeTransitRouterMulticastDomainAssociations.

Version String requiredExample: 2020-04-01

The interface version. The current API version is 2020-04-01.

TransitRouterMulticastDomainId String required Example: tr-md-hy13n2l4c6c0v****

The ID of the multicast domain. You can call DescribeTransitRouterMulticastDomains to obtain the ID of the multicast domain.

tip

You must specify at least one of: this parameter, TransitRouterAttachmentId, or ResourceId.

TransitRouterAttachmentId String required Example: 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.

tip

You must specify at least one of: this parameter, TransitRouterMulticastDomainId or ResourceId.

SubnetIds.N String required Example: subnet-123456

ID of the subnet.

N represents the sequence number of a subnet ID, ranging from 1 to 100.

Separate multiple subnet IDs with ampersands (&).

ResourceType String required Example: VPC

The network instance type. Values:

VPC: Virtual Private Cloud.

ResourceId String required Example: vpc-bp1aevy8sofi8mh1****

The network instance ID. You can call the DescribeVpcs API to get the ID of the VPC instance.

tip

You must specify at least one of: this parameter, TransitRouterAttachmentId, or TransitRouterMulticastDomainId.

PageNumber Integer required Example: 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.

TransitRouterMulticastDomainAssociations Object[] Example: -

Detailed association of multicast domains that meet the conditions.

TransitRouterMulticastDomainId String Example: tr-md-3t6b1n60vg4jks0txrs8****

The ID of the multicast domain.

TransitRouterAttachmentId String Example: tr-attach-13n2l4c****

The ID of the network instance attachment.

SubnetId String Example: subnet-at6avgks2l454****

Subnet ID.

ResourceType String Example: VPC

Type of the network instance attachment.

VPC: Virtual Private Cloud.

CreationTime String Example: 2021-04-09T08:36:47+08:00

The time when the multicast domain is created.

UpdateTime String Example: 2021-04-10T09:18:28+08:00

The time when the multicast domain is last modified.

Status String Example: Available

Status of the multicast domain.

Creating

Deleting

Pending: Configuration in progress.

Available

ResourceId String Example: vpc-bp15zckdt37pq72zv****

The ID of the multicast resource.

PageSize Integer Example: 20

Number of entries per page in the current pagination.

PageNumber Integer Example: 1

The current page number.

TotalCount Integer Example: 1

Total number of multicast domains that meet the condition.

Request examples

GET /?Action=DescribeTransitRouterMulticastDomainAssociations&Version=2020-04-01 HTTP/1.1​
Host: transitrouter.cn-beijing.volcengineapi.com​
X-Date: 20250721T122234Z​
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": "DescribeTransitRouterMulticastDomainAssociations",​
        "Version": "2020-04-01",​
        "Service": "transitrouter",​
        "Region": "cn-beijing"​
    },​
    "Result": {​
        "PageNumber": 1,​
        "PageSize": 20,​
        "TotalCount": 1,​
        "TransitRouterMulticastDomainAssociations": [​
            {​
                "Status": "Available",​
                "SubnetId": "subnet-at6avgks2l454****",​
                "ResourceId": "vpc-bp15zckdt37pq72zv****",​
                "UpdateTime": "2021-04-10T09:18:28+08:00",​
                "CreationTime": "2021-04-09T08:36:47+08:00",​
                "ResourceType": "VPC",​
                "TransitRouterAttachmentId": "tr-attach-13n2l4c****",​
                "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.

Status code	Error codes	Error message	Explanation
400	InvalidPage.Malformed	The specified page is malformed.	The specified pagination parameter is invalid.
400	LimitExceeded.ResourceIds	You've reached the limit of 100 resource IDs that can be specified in this request.	The request contains invalid or unsupported parameters. The maximum number of resource query results is 100.

Last updated: 2026.03.11 11:24:56