Disassociates a vSwitch from a multicast domain.

Usage notes

  • After a vSwitch is disassociated from a multicast domain, the multicast sources and members on the vSwitch are also removed from the multicast domain.
  • DisassociateTransitRouterMulticastDomain is an asynchronous operation. After you send a request, the system returns the request ID but the operation is still being performed in the system background. You can call ListTransitRouterMulticastDomainAssociations to query the status between a vSwitch and a multicast domain.
    • The Dissociating indicates that the vSwitch is being disassociated from the multicast domain. You can query the vSwitch but you cannot perform other operations.
    • If the vSwitch cannot be found, the vSwitch is disassociated from the multicast domain.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DisassociateTransitRouterMulticastDomain

The operation that you want to perform. Set the value to DisassociateTransitRouterMulticastDomain.

ClientToken String No 123e4567-e89b-12d3-a456-426655440000

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 different requests. ClientToken can contain only ASCII characters.

TransitRouterMulticastDomainId String Yes tr-mcast-domain-91wpg6wbhchjeq****

The ID of the multicast domain.

TransitRouterAttachmentId String Yes tr-attach-g3kz2k3u76amsk****

The ID of the virtual private cloud (VPC) connection.

A connection ID is generated after a VPC to which the vSwitch belongs is connected to a transit router.

DryRun Boolean No false

Specifies whether only to check the request. Valid values:

  • true: prechecks the request but does not disassociate the vSwitch from the multicast domain. The system checks the required parameters, the request format, and the service limits. If the request fails to pass the precheck, an error message is returned. If the request passes the precheck, the DryRunOperation error code is returned.
  • false (default): sends the request. The vSwitch is disassociated from the multicast domain after the request passes the precheck.
VSwitchIds.N String No vsw-p0w9s2ig1jnwgrbzl****

The ID of the vSwitch.

You can specify at most five vSwitch IDs in each call.

Response parameters

Parameter Type Example Description
RequestId String 6F6B3FF0-45D1-5416-B189-C45A42A0222B

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DisassociateTransitRouterMulticastDomain
&ClientToken=123e4567-e89b-12d3-a456-426655440000
&TransitRouterMulticastDomainId=tr-mcast-domain-91wpg6wbhchjeq****
&TransitRouterAttachmentId=tr-attach-g3kz2k3u76amsk****
&DryRun=false
&VSwitchIds=["vsw-p0w9s2ig1jnwgrbzl****"]
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DisassociateTransitRouterMulticastDomainResponse>
    <RequestId>6F6B3FF0-45D1-5416-B189-C45A42A0222B</RequestId>
</DisassociateTransitRouterMulticastDomainResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "6F6B3FF0-45D1-5416-B189-C45A42A0222B"
}

Error codes

HttpCode Error code Error message Description
400 InvalidAttachmentId.NotFound The specified AttachmentId is not found. The error message returned because the specified network instance ID does not exist.
400 DryRunOperation Request validation has been passed with DryRun flag set. The error message returned because the dry run request passed the precheck.

For a list of error codes, visit the API Error Center.