All Products
Search

This Product

    Cloud Enterprise Network:UpdateTransitRouterVpcAttachmentZones

    Document Center

    Cloud Enterprise Network:UpdateTransitRouterVpcAttachmentZones

    Last Updated:Mar 25, 2024

    Modifies the zones and vSwitches that are associated with a virtual private cloud (VPC) connection.

    Operation description

    • When you add a zone and a vSwitch for a VPC connection, make sure that the vSwitch has at least one idle IP address. When you modify the zones and vSwitches of a VPC connection, the Enterprise Edition transit router creates an elastic network interface (ENI) in the vSwitch. The ENI occupies one IP address in the vSwitch. The ENI forwards traffic between the VPC and the Enterprise Edition transit router.

    • UpdateTransitRouterVpcAttachmentZones is an asynchronous operation. After you send a request, the system returns a request ID and runs the task in the background. You can call the ListTransitRouterVpcAttachments operation to query the status of a VPC connection.

      • If a VPC connection is in the Modifying state, the VPC connection is being modified. You can query the VPC connection but cannot perform other operations.
      • If a VPC connection is in the Attached state, the VPC connection is modified.

    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:UpdateTransitRouterVpcAttachmentZonesWrite
    • TransitRouterVpcAttachment
      acs:cen:*:{#accountId}:centransitrouterattachment/{#centransitrouterattachmentId}
      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 token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters.

    Note If you do not set this parameter, ClientToken is set to the value of RequestId. The value of RequestId for each API request may be different.
    		123e4567-e89b-12d3-a456-42665544****
    DryRunbooleanNo

    Specifies whether to perform a dry run. Valid values:

    • true: performs a dry run. The system checks the required parameters, request syntax, and limits. If the request fails the dry run, an error message 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
    TransitRouterAttachmentIdstringYes

    The ID of the VPC connection.

    		tr-attach-9bbqyygouv4cpn****
    AddZoneMappingsobject []No

    The zones and vSwitches that you want to add to the VPC connection.

    VSwitchIdstringNo

    The ID of the vSwitch that you want to add to the VPC connection.

    You can specify at most 10 vSwitches in each call.

    • If the VPC connection belongs to the current Alibaba Cloud account, you can call the DescribeVSwitches operation to query the IDs of the vSwitches and zones of the VPC.
    • If the VPC connection belongs to another Alibaba Cloud account, you can call the ListGrantVSwitchesToCen operation to query the IDs of the vSwitches and zones of the VPC.
    		vsw-wz988dda8ldm4uvmx****
    ZoneIdstringNo

    The ID of the zone where the vSwitch that you want to add to the VPC connection is deployed.

    You can specify at most 10 vSwitches in each call.

    		cn-hangzhou-h
    RemoveZoneMappingsobject []No

    The zones and vSwitches that you want to remove from the VPC connection.

    VSwitchIdstringNo

    The ID of the vSwitch that you want to remove from the VPC connection.

    You can remove at most 10 vSwitches from a VPC in each call.

    		vsw-wz9f5izl6wshndmta****
    ZoneIdstringNo

    The ID of the zone where the vSwitch that you want to remove from the VPC connection is deployed.

    		cn-hangzhou-i

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response.

    RequestIdstring

    The ID of the request.

    		595AE52F-49FF-5788-A677-0DD1467941A1

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "595AE52F-49FF-5788-A677-0DD1467941A1"
}

    Error codes

    HTTP status codeError codeError messageDescription
    400IllegalParam.ZoneIdThe specified ZoneId is illegal.The error message returned because the specified zone is invalid.
    400IncorrectStatus.TransitRouterAttachmentThe status of TransitRouterAttachment is incorrect.The error message returned because the status of the transit router attachment does not support this operation. Try again later.
    400IllegalParam.VSwitchIdVSwitchId is illegal.The error message returned because the specified vSwitch ID is invalid.
    400InvalidTransitRouterAttachmentId.NotFoundTransitRouterAttachmentId is not found.The error message returned because the ID of the network instance does not exist.
    400OperationUnsupported.ServiceModeThe specified TransitRouter does not support the operation.The error message returned because the transit router mode does not support this operation.
    400IllegalParam.AddOrRemoveZoneMappingsThe specified AddZoneMappings or RemoveZoneMappings are illegal.The error message returned because the AddZoneMappings or RemoveZoneMappings parameter is set to an invalid value.
    400IncorrectStatus.VpcThe resource is not in a valid state for the attachment operation.The error message returned because the status of the VPC does not support this operation. Try again later.
    400OperationDenied.RouteEntryOnEniOperation is failed because there is at least one route entry which next hop is the specified eni.The error message returned because this operation is not supported when a route points to an ENI.
    400IncorrectStatus.VpcRouteEntryThe resource is not in a valid state for the attachment operation.The error message returned because the status of the VPC route entry does not support this operation. Try again later.
    400IncorrectStatus.VpcSwitchThe resource is not in a valid state for the attachment operation.The error message returned because the status of the vSwitch does not support this operation. Try again later.
    400OperationUnsupported.TransitRouterTypeThe specified TransitRouterType does not support the operation.The error message returned because this operation is not supported by the specified type of transit router.
    400InsufficientIpAddr.vswInsufficient available IP addresses in the vSwitch.The error message returned because the number of available IP addresses in the vSwitch is insufficient.
    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.
    404InvalidVSwitchId.NotFoundThe specified VSwitchId is not found.The error message returned because the specified vSwitch ID does not exist.

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    2023-09-08The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
      delete Error Codes: 404
      Added Error Codes: 409
    2023-03-27The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      Error Codes 404 change
    2023-03-14The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      delete Error Codes: 404