Modifies the name and description of a virtual private cloud (VPC) connection on an Enterprise Edition transit router.

Usage notes

UpdateTransitRouterVpcAttachmentAttribute is an asynchronous operation. After you send a request, the system returns the request ID but the operation is still being performed in the system background. You can call ListTransitRouterVpcAttachments 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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes UpdateTransitRouterVpcAttachmentAttribute

The operation that you want to perform. Set the value to UpdateTransitRouterVpcAttachmentAttribute.

ClientToken String No 02fb3da4-130e-11e9-8e44-001****

The client token that is used to ensure the idempotence of the request.

You can use the client to generate the value, but you must make sure that it is unique among different requests. ClientToken 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 may be different for each API request.
TransitRouterAttachmentId String Yes tr-attach-nls9fzkfat8934****

The ID of the VPC connection.

TransitRouterAttachmentName String No testname

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.

TransitRouterAttachmentDescription String No testdesc

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://.

DryRun Boolean No false

Specifies whether to perform a precheck to check information such as the permissions and instance status. Valid values:

  • false (default): sends a request. If the request passes the precheck, the name and description of the VPC connection are modified.
  • true: sends a request for precheck only. The name and description of the VPC connection are not modified after the request passes the precheck. If you use this value, the system checks the required parameters and the request syntax. If the request fails the precheck, an error message is returned. If the request passes the check, the system returns the ID of the request.

Response parameters

Parameter Type Example Description
RequestId String 7E61D334-4025-41EF-9145-FC327B35301D

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=UpdateTransitRouterVpcAttachmentAttribute
&ClientToken=02fb3da4-130e-11e9-8e44-001****
&TransitRouterAttachmentId=tr-attach-nls9fzkfat8934****
&TransitRouterAttachmentName=testname
&TransitRouterAttachmentDescription=testdesc
&DryRun=false
&Common request parameters

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<UpdateTransitRouterVpcAttachmentAttributeResponse>
    <RequestId>7E61D334-4025-41EF-9145-FC327B35301D</RequestId>
</UpdateTransitRouterVpcAttachmentAttributeResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

HttpCode Error codes Error message Description
400 InvalidTransitRouterAttachmentId.NotFound TransitRouterAttachmentId is not found. The error message returned because the ID of the network connection does not exist.

For a list of error codes, visit the API Error Center.