UpdateTransitRouterVpcAttachmentAttribute - Cloud Enterprise Network

Call the UpdateTransitRouterVpcAttachmentAttribute operation to modify the name and description of a VPC connection on an Enterprise Edition transit router. You can also use this operation to specify whether the Enterprise Edition transit router automatically advertises routes to the VPC.

Operation description

UpdateTransitRouterVpcAttachmentAttribute is an asynchronous operation. After you send a request, the system returns a request ID, but the VPC connection is not modified immediately. The system modifies the VPC connection 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, you can only query the VPC connection and cannot perform other operations.
If a VPC connection is in the Attached state, the VPC connection has been modified.

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:UpdateTransitRouterVpcAttachmentAttribute

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 token can contain only ASCII characters. Note If you do not specify this parameter, the system automatically uses the RequestId of the request as the ClientToken. The RequestId of each request is different.	02fb3da4-130e-11e9-8e44-001****
TransitRouterAttachmentId	string	Yes	The ID of the VPC connection.	tr-attach-nls9fzkfat8934****
TransitRouterAttachmentName	string	No	The name of the VPC connection. The name can be empty or 1 to 128 characters in length. The name cannot start with http:// or https://.	testname
TransitRouterAttachmentDescription	string	No	The description of the VPC connection. The description can be empty or 1 to 256 characters in length. The description cannot start with http:// or https://.	testdesc
DryRun	boolean	No	Specifies whether to perform a dry run, which checks the permissions and the status of the instances. Valid values: false (default): sends a normal request. If the request passes the check, the name and description of the VPC connection are modified. true: sends a check request. The system checks the required parameters and the request format. If the request fails the check, an error is returned. If the request passes the check, the corresponding request ID is returned. The name and description of the VPC connection are not modified.	false
TransitRouterVPCAttachmentOptions	object	No	The feature properties of the VPC connection.
	string	No	The feature property of the VPC connection. ipv6Support: specifies whether to enable the IPv6 feature. enable: enables the IPv6 feature. disable: disables the IPv6 feature. Note Before you enable the IPv6 feature for a VPC connection, make sure that IPv6 is enabled for the VPC and its associated vSwitches. For more information, see AllocateVpcIpv6Cidr and CreateVSwitchCidrReservation.	ipv6Support:enable
AutoPublishRouteEnabled	boolean	No	Specifies whether to allow the Enterprise Edition transit router to automatically advertise routes to the VPC. false: No. true: Yes.	true

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	7E61D334-4025-41EF-9145-FC327B35301D

Examples

Success response

JSON format

{
  "RequestId": "7E61D334-4025-41EF-9145-FC327B35301D"
}

Error codes

HTTP status code	Error code	Error message	Description
400	IncorrectStatus.TransitRouterAttachmentId	TransitRouterAttachmentId status is invalid.	The error message returned because the status of the transit router attachment does not support this operation. Try again later.
400	InvalidTransitRouterAttachmentId.NotFound	TransitRouterAttachmentId is not found.	The error message returned because the ID of the network instance does not exist.
400	InvalidOperation.RegionNotSupport	The operation is not supported in this region.	The error message returned because this operation is not supported in the specified region.
400	InvalidOperation.VpcAutoRoutesPublishInOtherCEN	The operation is not supported because the VPC is already set autoRoutesPublish in other CEN.
400	QuotaExceeded.VpcAutoRoutesPublishPerTransitRouter	The count of VPC instance which set autoRoutesPublish in transitRouter is over limit.
400	InvalidOperation.VpnAssociated	The operation is not supported because the VPC is associated with VPN.	The error message returned because the specified VPC is associated with a VPN.
400	IllegalParam.Ipv6Support	Ipv6Support is illegal. Valid Values are [enable, disable].	The Ipv6Support value of the request parameter is invalid. The valid value is enable or disable.
400	OperationFailed.VSwitchNotFound	The specified vswitch not found.	The specified vswitch not found.
400	OperationFailed.VSwitchIpv6CidrNotAllocated	The specified vswitch does not have IPv6 address allocated.	The specified vswitch does not have IPv6 address allocated.
400	OperationInvalid.AttachmentReferencedIPv6RouteEntryExisted	Operation is failed because there is at least one route entry(IPv6) which next hop is the specified attachment.	Operation is failed because there is at least one route entry(IPv6) which next hop is the specified attachment.
400	OperationInvalid.AttachmentReferencedVpcIPv6RouteEntryExisted	The specified attachment is referenced by vpc route entry(IPv6).	The specified attachment is referenced by vpc route entry(IPv6).
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	OperationUnsupported.VpcRoutePropagationSource	The operation on this VPC route propagation source is not supported.	The operation on this VPC route propagation source is not supported.
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	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	INVALID_OPERATION_RESOURCE_NOT_SUPPORT_APPLIANCE_MODE	Only VPC attachment support appliance mode.	Only VPC attachment support appliance mode.
400	InvalidParameter.Ipv6Support	The specified parameter Ipv6Support is invalid.	The parameter Ipv6Support entered is illegal.
400	InvalidParameter.ApplianceModeSupport	The specified parameter ApplianceModeSupport is invalid.	The parameter ApplianceModeSupport entered is illegal.
400	ParamExclusive.TransitRouterVPCAttachmentOptionsAndOptions	When creating or modifying a VPC attachment, the input parameter TransitRouterVPCAttachmentOptions and Options cannot be used at the same time.	When creating or modifying a VPC attachment, the input parameter TransitRouterVPCAttachmentOptions and Options cannot be used at the same time.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.