All Products
Search
Document Center

Cloud Enterprise Network:UpdateTransitRouterVpcAttachmentAttribute

Last Updated:Jan 19, 2024

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

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

Debug

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:UpdateTransitRouterVpcAttachmentAttributeWrite
  • 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 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****
TransitRouterAttachmentIdstringYes

The ID of the VPC connection.

tr-attach-nls9fzkfat8934****
TransitRouterAttachmentNamestringNo

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
TransitRouterAttachmentDescriptionstringNo

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 http:// or https://.

testdesc
DryRunbooleanNo

Specifies whether to perform a dry run. Default values:

  • false (default): performs a dry run and sends the request.
  • true: performs a dry run. The system checks the required parameters and request syntax. If the request fails the dry run, an error message is returned. If the request passes the dry run, the system returns the ID of the request.
false
AutoPublishRouteEnabledbooleanNo

Specifies whether to allow the Enterprise Edition transit router to advertise routes to the VPC. Valid values:

  • false: (default)
  • true
true

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

7E61D334-4025-41EF-9145-FC327B35301D

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400IncorrectStatus.TransitRouterAttachmentIdTransitRouterAttachmentId status is invalid.The error message returned because the status of the transit router attachment does not support this operation. Try again later.
400InvalidTransitRouterAttachmentId.NotFoundTransitRouterAttachmentId is not found.The error message returned because the ID of the network instance does not exist.
400InvalidOperation.RegionNotSupportThe operation is not supported in this region.The error message returned because this operation is not supported in the specified region.
400InvalidOperation.VpcAutoRoutesPublishInOtherCENThe operation is not supported because the VPC is already set autoRoutesPublish in other CEN.-
400QuotaExceeded.VpcAutoRoutesPublishPerTransitRouterThe count of VPC instance which set autoRoutesPublish in transitRouter is over limit.-
400InvalidOperation.VpnAssociatedThe operation is not supported because the VPC is associated with VPN.The error message returned because the specified VPC is associated with a VPN.
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
2022-10-19The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
Input ParametersThe request parameters of the API has changed.
    delete Input Parameters: AutoPublishRouteEnabled