Call UpdateTransitRouterVpcAttachmentZones to modify zones and vSwitches for a VPC connection - Cloud Enterprise Network - Alibaba Cloud - Cloud Enterprise Network

Modifies the zones and vSwitches associated with a virtual private cloud (VPC) connection by calling the UpdateTransitRouterVpcAttachmentZones operation.

Operation description

When adding zones and vSwitches to a VPC connection, make sure that the vSwitch has an idle IP address. During the modification procedure, the Enterprise Edition transit router creates an elastic network interface (ENI) in the vSwitch (which occupies one IP address in the vSwitch) as the interface for routing traffic between the VPC-connected instance and the Enterprise Edition transit router.
The UpdateTransitRouterVpcAttachmentZones operation is asynchronous. After you send a request, the system returns a RequestId but the VPC connection is not yet modified. The modification task continues to run in the background. You can invoke the ListTransitRouterVpcAttachments operation to query the status of the VPC connection.
- If the VPC connection is in the Modifying state, the VPC connection is being modified. In this state, you can only query the VPC connection but cannot perform other operations on it.
- If the VPC connection is in the Attached state, the VPC connection is modified.
You cannot delete all zones and vSwitches under a VPC connection ID. At least one zone and vSwitch must be retained.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cen:UpdateTransitRouterVpcAttachmentZones

update

*TransitRouterVpcAttachment

acs:cen:*:{#accountId}:centransitrouterattachment/{#centransitrouterattachmentId}

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 token, but you must make sure that the token is unique among different requests. The client token can contain only ASCII characters. Note If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId may be different for each API request.	123e4567-e89b-12d3-a456-42665544****
DryRun	boolean	No	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. If the request passes the dry run, the zones and vSwitches of the VPC connection are modified.	false
TransitRouterAttachmentId	string	Yes	The ID of the VPC connection.	tr-attach-9bbqyygouv4cpn****
AddZoneMappings	array<object>	No	The list of zones and vSwitches to add to the VPC connection.
	object	No	The vSwitch ID to add to the VPC connection. You can add up to 10 vSwitches at a time.
VSwitchId	string	No	The ID of the vSwitch to add to the VPC connection. You can add up to 10 vSwitches at a time. If the Alibaba Cloud account that you use to log on and the VPC-connected instance belong to the same account, you can invoke the DescribeVSwitches operation to query the vSwitch IDs and the IDs of the zones to which the vSwitches belong. If the Alibaba Cloud account that you use to log on and the VPC-connected instance belong to different accounts, you can invoke the ListGrantVSwitchesToCen operation to query the vSwitch IDs and the IDs of the zones to which the vSwitches belong. ZoneId is required when VSwitchId is specified.	vsw-wz988dda8ldm4uvmx****
ZoneId	string	No	The ID of the zone to which the vSwitch to add to the VPC connection belongs. You can add up to 10 vSwitches at a time. VSwitchId is required when ZoneId is specified.	cn-hangzhou-h
RemoveZoneMappings	array<object>	No	The list of zones and vSwitches to remove from the VPC connection.
	object	No	The list of zones and vSwitches to remove from the VPC connection. You can specify up to 10 zone and vSwitch pairs at a time.
VSwitchId	string	No	The ID of the vSwitch to remove from the VPC connection. You can remove up to 10 vSwitches at a time. ZoneId is required when VSwitchId is specified.	vsw-wz9f5izl6wshndmta****
ZoneId	string	No	The ID of the zone to which the vSwitch to remove from the VPC connection belongs. You can remove up to 10 vSwitches at a time. VSwitchId is required when ZoneId is specified.	cn-hangzhou-i

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	595AE52F-49FF-5788-A677-0DD1467941A1

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalParam.ZoneId	The specified ZoneId is illegal.	The error message returned because the specified zone is invalid.
400	IncorrectStatus.TransitRouterAttachment	The 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.
400	IllegalParam.VSwitchId	VSwitchId is illegal.	The error message returned because the specified vSwitch ID is invalid.
400	InvalidTransitRouterAttachmentId.NotFound	TransitRouterAttachmentId is not found.	The error message returned because the ID of the network instance does not exist.
400	OperationUnsupported.ServiceMode	The specified TransitRouter does not support the operation.	The error message returned because the transit router mode does not support this operation.
400	IllegalParam.AddOrRemoveZoneMappings	The specified AddZoneMappings or RemoveZoneMappings are illegal.	The error message returned because the AddZoneMappings or RemoveZoneMappings parameter is set to an invalid value.
400	IncorrectStatus.Vpc	The 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.
400	OperationDenied.RouteEntryOnEni	Operation 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.
400	IncorrectStatus.VpcRouteEntry	The 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.
400	IncorrectStatus.VpcSwitch	The 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.
400	OperationUnsupported.TransitRouterType	The specified TransitRouterType does not support the operation.	The error message returned because this operation is not supported by the specified type of transit router.
400	InsufficientIpAddr.vsw	Insufficient available IP addresses in the vSwitch.	The error message returned because the number of available IP addresses in the vSwitch is insufficient.
400	OperationFailed.VSwitchIpv6CidrNotAllocated	The specified vswitch does not have IPv6 address allocated.	The specified vswitch does not have IPv6 address allocated.
400	InvalidTransitRouterMode.NeedUpgrade	TransitRouter need to upgrade.	The error message returned because the specified transit router mode is not supported.
400	OperationInvalid.EniReferencedIPv6RouteEntryExisted	Operation is failed because there is at least one route entry(IPv6) which next hop is network interface that the specified attachment referenced.	Operation is failed because there is at least one route entry(IPv6) which next hop is network interface that the specified attachment referenced.
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.
400	InvalidParameter.TransitRouterAttachmentId	The specified parameter TransitRouterAttachmentId is invalid.
404	IllegalParam.ZoneId	The specified ZoneId is illegal.
404	InvalidVSwitchId.NotFound	The specified VSwitchId is not found.	The error message returned because the specified vSwitch ID does not exist.
409	IncorrectStatus.VpcSwitch	The resource is not in a valid state for the attachment operation.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.