AssociateTransitRouterMulticastDomain - Cloud Enterprise Network

Associates the vSwitch of a virtual private cloud (VPC) with a multicast domain.

Operation description

A vSwitch can be associated with only one multicast domain. Make sure that the vSwitch is not associated with other multicast domains. For more information about how to disassociate a vSwitch from a multicast domain, see DisassociateTransitRouterMulticastDomain .
AssociateTransitRouterMulticastDomain is an asynchronous operation. After a request is sent, the system returns a request ID and runs the task in the background. You can call the ListTransitRouterMulticastDomainAssociations operation to query whether a vSwitch is associated with the specified multicast domain.
- If the status is Associating, it indicates that the vSwitch is being associated with the specified multicast domain. You can query the vSwitch but cannot perform other operations on the vSwitch.
- If the status is Associated, the vSwitch is associated with the specified multicast domain.
The VPC of the vSwitch must be associated with an Enterprise Edition transit router. For more information about how to associate a VPC with an Enterprise Edition transit router, see CreateTransitRouterVpcAttachment .

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:AssociateTransitRouterMulticastDomain	update	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 client token can contain only ASCII characters.	123e4567-e89b-12d3-a456-426655440000
TransitRouterMulticastDomainId	string	Yes	The ID of the multicast domain.	tr-mcast-domain-91wpg6wbhchjeq****
TransitRouterAttachmentId	string	Yes	The ID of the VPC connection.	tr-attach-g3kz2k3u76amsk****
VSwitchIds	array	Yes	The IDs of vSwitches.
	string	Yes	The vSwitch IDs. You can specify at most five vSwitches in each call. A multicast domain can be associated with at most 10 vSwitches.	vsw-p0wxk12u6okfkr8xy****
DryRun	boolean	No	Specifies whether to perform a dry run, without sending the actual request. Valid values: true: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and service limits. If the request fails the dry run, an error code is returned. If the request passes the dry run, the `DryRunOperation` error code is returned. false (default): performs a dry run and sends the request.	false

Response parameters

Parameter	Type	Description	Example
	object	The response.
RequestId	string	The ID of the request.	F88AC12C-943B-50E9-A344-4F8820BB07A7

Examples

Sample success responses

JSONformat

{
  "RequestId": "F88AC12C-943B-50E9-A344-4F8820BB07A7"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidMulticastDomain.NotFound	The specified MulticastDomain is not found.	The error message returned because the specified multicast domain does not exist.
400	IncorrectStatus.MulticastDomain	The status of MulticastDomain is incorrect.	The error message returned because the status of the specified multicast domain does not support this operation. Try again later.
400	InvalidAttachmentId.NotFound	The specified AttachmentId is not found.	The error message returned because the specified network instance connection ID does not exist.
400	IllegalParam.AttachmentId	The specified AttachmentId is illegal.	The error message returned because the specified attachment ID is invalid.
400	IncorrectStatus.Attachment	The status of Attachment is incorrect.	The error message returned because the status of the attachment does not support this operation. Try again later.
400	MissingParam.VSwitchIds	The parameter VSwitchIds is mandatory.	The error message returned because the VSwitchIds parameter is not set.
400	InstanceNotExist	The instance is not exist.	The error message returned because the specified instance does not exist.
400	OperationUnsupported.CloudBoxVpc	The specified CloudBoxVpc does not support the operation.	The error message returned because the CloudBox VPC does not support this operation.
400	AssociationExist.VSwitchIds	The association already exists.	The error message returned because the specified resource is already associated with the vSwitch.
400	QuotaFull.VswitchPerMulticastDomain	The number of vswitch associated with multicast domain has exceed the maximum value that can be created.	The error message returned because the number of vSwitches associated with the multicast domain has reached the upper limit.
400	DryRunOperation	Request validation has been passed with DryRun flag set.	The error message returned because the dry run request passed the precheck.
400	OperationUnsupported.VpcRegion	The specified Region is not support for this operation.	The error message returned because this operation is not supported in the specified region.
400	OperationUnsupported.AdvancedFeature	The specified vpc does not support the operation.	-
400	QuotaFull.MulticastDomainPerVpc	The number of multicast domain that vpc associated has exceed the maximum value that can be associated.	The number of multicast domain that vpc associated has exceed the maximum value that can be associated.
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
2024-10-17	The Error code has changed	View Change Details
2023-10-20	The Error code has changed	View Change Details