Modifies the name and description of a virtual private cloud (VPC) connection on an Enterprise Edition transit router.
Operation description
UpdateTransitRouterVpcAttachmentAttribute 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
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 Resourcesis 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.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| 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 all 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.
| 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 must be 2 to 128 characters in length, and can contain letters, digits, underscores (_), and hyphens (-). It must start with a letter. | testname |
| TransitRouterAttachmentDescription | string | No | The description of the VPC connection. The description must be 2 to 256 characters in length. The description must start with a letter but cannot start with | testdesc |
| DryRun | boolean | No | Specifies whether to perform a dry run. Default values:
| false |
| TransitRouterVPCAttachmentOptions | object | No | The features of the VPC connection. | |
| string | No | The features of the VPC connection. ipv6Support: specifies whether to enable IPv6.
Note
Before you enable IPv6 for a VPC connection, make sure that IPv6 is enabled for the VPC and the vSwitches of the VPC. For more information, see AllocateVpcIpv6Cidr and CreateVSwitchCidrReservation .
| ipv6Support:enable | |
| AutoPublishRouteEnabled | boolean | No | Specifies whether to allow the Enterprise Edition transit router to advertise routes to the VPC. Valid values:
| true |
Response parameters
Examples
Sample success responses
JSONformat
{
"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. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-09-10 | The Error code has changed. The request parameters of the API has changed | View Change Details |
| 2024-07-10 | The Error code has changed | View Change Details |
| 2024-04-19 | The Error code has changed | View Change Details |
| 2022-10-19 | The Error code has changed. The request parameters of the API has changed | View Change Details |