Modifies a cross-region connection on an Enterprise Edition transit router.


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 UpdateTransitRouterPeerAttachmentAttribute

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

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 a token, but you must make sure that it is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.

TransitRouterAttachmentId String Yes tr-attach-ft94dcrbc3e5taun3x

The ID of the cross-region connection.

TransitRouterAttachmentName String No testname

The new name of the cross-region connection.

The name must be 2 to 128 characters in length, and can contain letters, digits, underscores (_), and hyphens (-). The name must start with a letter.

TransitRouterAttachmentDescription String No testdesc

The new description of the cross-region 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://.

AutoPublishRouteEnabled Boolean No false

Specifies whether to enable the local Enterprise Edition transit router to automatically advertise the routes of the cross-region connection to the peer transit router. Valid values:

  • false (default): no
  • true: yes
DryRun Boolean No false

Specifies whether to check the request but not perform the operation. The system checks the permissions and the status of the specified instances. Valid values:

  • false (default): checks the request. If the request passes the check, the cross-region connection is modified.
  • true: checks the request but does not perform the operation. The cross-region connection is not modified after the request passes the check. If you use this value, the system checks whether the required parameters are set, and whether the request syntax is valid. If the request fails the check, an error message is returned. If the request passes the check, the system returns the ID of the request.
Bandwidth Integer No 2

The bandwidth value of the cross-region connection. Unit: Mbit/s.

  • If you set BandwidthType to BandwidthPackage, this parameter specifies the bandwidth that is available for the cross-region connection.

  • If you set BandwidthType to DataTransfer, this parameter specifies the bandwidth limit of the cross-region connection.
CenBandwidthPackageId String No cenbwp-3xrxupouolw5ou****

The ID of the bandwidth plan that is used to allocate bandwidth to the cross-region connection.

Note If you set BandwidthType to DataTransfer, you do not need to set this parameter.
BandwidthType String No BandwidthPackage

The bandwidth allocation method. Valid values:

BandwidthPackage: allocates bandwidth from a bandwidth plan.

DataTransfer: uses pay-by-data-transfer bandwidth.

Response parameters

Parameter Type Example Description
RequestId String A01FEDD7-7D69-4EB3-996D-CF79F6F885CA

The ID of the request.


Sample requests

&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK


JSON format

HTTP/1.1 200 OK

  "RequestId" : "A01FEDD7-7D69-4EB3-996D-CF79F6F885CA"

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 instance is invalid.

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