All Products
Search

This Product

    Cloud Enterprise Network:AssociateTransitRouterMulticastDomain

    Document Center

    Cloud Enterprise Network:AssociateTransitRouterMulticastDomain

    Last Updated:Mar 29, 2024

    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

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    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 keyAssociated operation
    cen:AssociateTransitRouterMulticastDomainWrite
    • All Resources
      *
      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 VPC connection.

    		tr-attach-g3kz2k3u76amsk****
    VSwitchIdsarrayNo

    The vSwitch IDs.

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

    stringNo

    The ID of the vSwitch.

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

    		vsw-p0wxk12u6okfkr8xy****
    DryRunbooleanNo

    Specifies whether only to precheck the API request. Valid values:

    • true: prechecks the request but does not associate the vSwitch with 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 associated with the multicast domain after the request passes the precheck.
    		false

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response.

    RequestIdstring

    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 codeError codeError messageDescription
    400InvalidMulticastDomain.NotFoundThe specified MulticastDomain 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.
    400InvalidAttachmentId.NotFoundThe specified AttachmentId is not found.The error message returned because the specified network instance connection ID does not exist.
    400IllegalParam.AttachmentIdThe specified AttachmentId is illegal.The error message returned because the specified attachment ID is invalid.
    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.
    400MissingParam.VSwitchIdsThe parameter VSwitchIds is mandatory.The error message returned because the VSwitchIds parameter is not set.
    400InstanceNotExistThe instance is not exist.The error message returned because the specified instance does not exist.
    400OperationUnsupported.CloudBoxVpcThe specified CloudBoxVpc does not support the operation.The error message returned because the CloudBox VPC does not support this operation.
    400AssociationExist.VSwitchIdsThe association already exists.The error message returned because the specified resource is already associated with the vSwitch.
    400QuotaFull.VswitchPerMulticastDomainThe 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.
    400DryRunOperationRequest validation has been passed with DryRun flag set.The error message returned because the dry run request passed the precheck.
    400OperationUnsupported.VpcRegionThe specified Region is not support for this operation.The error message returned because this operation is not supported in the specified region.
    400OperationUnsupported.AdvancedFeatureThe specified vpc does not support the operation.-
    400InvalidParameterInvalid parameter.The error message returned because the parameter is set to an invalid value.
    400UnauthorizedThe 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 timeSummary of changesOperation
    2023-10-20The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400