Docs

Transit Router

Multicast

AssociateTransitRouterMulticastDomain - Attaching multicast domain to subnet

Call the AssociateTransitRouterMulticastDomain API to associate a multicast domain with the specified subnet.

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 value: AssociateTransitRouterMulticastDomain

The interface name. The current API name is AssociateTransitRouterMulticastDomain.

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

TransitRouterAttachmentId String required Example: tr-attach-12w7hruhlhlrd****

The ID of the network instance attachment. You can call the DescribeTransitRouterVpcAttachments API to obtain the ID of the Virtual Private Cloud (VPC) attachment.

SubnetId String requiredExample value: subnet-p0w9alkte4w2htrqe****

ID of the subnet.

Response parameters

This API does not have specific response parameters. For more information, see Response structure.

Request examples

GET /?Action=AssociateTransitRouterMulticastDomain&Version=2020-04-01&TransitRouterMulticastDomainId=tr-md-hy13n2l4c6c0v****&TransitRouterAttachmentId=tr-attach-12w7hruhlhlrd****&SubnetId=subnet-p0w9alkte4w2htrqe**** HTTP/1.1​
Host: transitrouter.cn-beijing.volcengineapi.com​
X-Date: 20250721T122315Z​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20250721/cn-beijing/transitrouter/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​

Response examples

{​
    "ResponseMetadata": {​
        "RequestId": "2025050917291215112303520182****",​
        "Action": "AssociateTransitRouterMulticastDomain",​
        "Version": "2020-04-01",​
        "Service": "transitrouter",​
        "Region": "cn-beijing"​
    },​
    "Result": {}​
}​

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	InvalidSubnet.InvalidStatus	The specified subnet is not in the correct status for the request.	The specified subnet is in a state that cannot respond to the request.
400	InvalidTransitRouter.InvalidBusinessStatus	The request is denied because the specified Transit Router is shut down due to arrears.	The specified Transit Router (TR) is suspended due to overdue payments. Action unsupported.
400	InvalidTransitRouter.InvalidStatus	The specified Transit Router is not in the correct status for the request.	The specified Transit Router (TR) is in a status that cannot respond to the request.
400	InvalidTransitRouterMulticastDomain.InvalidStatus	The specified Transit Router multicast domain is not in the correct status for the request.	The specified multicast domain cannot respond to this request due to its status.
400	InvalidTransitRouterMulticastDomainAssociation.AttachmentTypeNotSupport	The specified Transit Router attachment type does not support to be associated to multicast domain.	The specified Intra-Region Attachment type does not support attaching multicast domains.
400	InvalidTransitRouterMulticastDomainAssociation.TransitRouterMismatch	The specified attachment and multicast domain do not belong to the same Transit Router.	The specified network instance attachment and the multicast domain do not belong to the same Transit Router (TR).
400	QuotaExceeded.TransitRouterMulticastDomainAssociation	You've reached the limit on the number of subnets that you can associated to one multicast domain.	The maximum number of subnets that can be attached to a single multicast domain has been reached.
403	Forbidden.NoPermissionToOperate	You are not authorized to operate the specified resource.	No permission to manage the specified resource.
404	InvalidTransitRouterAttachment.NotFound	The specified Transit Router attachment does not exist.	The specified network instance attachment does not exist.
404	InvalidTransitRouterAttachment.SubnetNotFound	The specified subnet does not exist.	The specified subnet does not exist.
404	InvalidTransitRouterMulticastDomain.NotFound	The specified Transit Router multicast domain does not exist.	The specified multicast domain does not exist.
409	InvalidTransitRouterMulticastDomainAssociation.Conflict	The specified subnet has already been associated to a multicast domain.	The specified subnet has been attached to the multicast domain, please do not repeat the configuration.

Last updated: 2026.01.06 11:56:32