All Products
Search

This Product

    Cloud Enterprise Network:DisassociateTransitRouterMulticastDomain

    Document Center

    Cloud Enterprise Network:DisassociateTransitRouterMulticastDomain

    Last Updated:Apr 11, 2023

    Disassociates vSwitches from a multicast domain.

    Operation Description

    • 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 a request ID and runs the task in the system background. You can call the ListTransitRouterMulticastDomainAssociations operation to query the association status between a vSwitch and a multicast domain.

      • The Dissociating state 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.

    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.
    OperationAccess levelResource typeCondition keyAssociation operation
    cen:DisassociateTransitRouterMulticastDomainRead
    • CEN
      acs:cen:*:{#accountId}:centransitroutermulticast/{#centransitroutermulticastId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    ClientTokenstringNo

    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
    TransitRouterMulticastDomainIdstringYes

    The ID of the multicast domain.

    		tr-mcast-domain-91wpg6wbhchjeq****
    TransitRouterAttachmentIdstringYes

    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.

    		tr-attach-g3kz2k3u76amsk****
    DryRunbooleanNo

    Specifies whether only to precheck the API 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 the check, an error message is returned. If the request passes the check, 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.
    		false
    VSwitchIdsarrayNo

    A list of vSwitch IDs.

    stringNo

    The ID of the vSwitch.

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

    		vsw-p0w9s2ig1jnwgrbzl****

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response.

    RequestIdstring

    The ID of the request.

    		6F6B3FF0-45D1-5416-B189-C45A42A0222B

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    HTTP status codeError codeError messageDescription
    400InvalidMulticastDomainId.NotFoundThe specified MulticastDomainId is not found.The error message returned because the specified multicast domain does not exist.
    400IncorrectStatus.MulticastDomainThe 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.
    400InstanceStatusNotSupportThe status of instance not support the operation.The error message returned because the operation is not supported while the instance is in the current state.
    400InvalidAttachmentId.NotFoundThe specified AttachmentId is not found.The error message returned because the specified network instance connection ID does not exist.
    400IncorrectStatus.AttachmentThe status of Attachment is incorrect.The error message returned because the status of the attachment does not support this operation. Try again later.
    400IllegalParam.AttachmentIdThe specified AttachmentId is illegal.The error message returned because the specified attachment ID is invalid.
    400InvalidOperation.MulticastGroupExistOperation is invalid because multicast groups exist.The error message returned because this operation is not supported when a multicast domain group exists.
    400DryRunOperationRequest 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 Service error codes.

    Change history

    Change timeSummary of changesOperation
    No change history