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

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 No UpdateTransitRouterPeerAttachmentAttribute

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

TransitRouterAttachmentId String Yes tr-attach-ft94dcrbc3e5taun3x

The ID of the cross-region connection.

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 ensure that it is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.

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 digits, underscores (_), and hyphens (-). It 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 Enterprise Edition transit router to automatically advertise the routes of the cross-region connection to the peer transit router. Valid values:

  • false (default): disables automatic route advertisement.
  • true: enables automatic route advertisement.
DryRun Boolean No false

Specifies whether to only precheck the request. Check items include permissions and the status of the specified instances. Valid values:

  • false (default): sends a normal request. If the request passes the precheck, the cross-region connection is modified.
  • true: sends a request for precheck only. The cross-region connection is not modified after the request passes the precheck. If you select this option, the system checks whether the required parameters are set, and whether the request syntax is valid. If the request fails to pass the precheck, the system returns an error. If the request passes the precheck, the system returns the ID of the request.
Bandwidth Integer No 2

The bandwidth that you want to allocate to the cross-region connection. Unit: Mbit/s.

CenBandwidthPackageId String No cenbwp-3xrxupouolw5ou****

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

If this parameter is not set, the system allocates bandwidth that is used for testing purposes to the cross-region connection. The default bandwidth is 1 Kbit/s, which is used only to verify network connectivity.

Response parameters

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

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=UpdateTransitRouterPeerAttachmentAttribute
&TransitRouterAttachmentId=tr-m5eq27g6bndum7e88****
&<Common request parameters>

Sample success responses

XML format

<UpdateTransitRouterPeerAttachmentAttributeResponse>
  <RequestId>A01FEDD7-7D69-4EB3-996D-CF79F6F885CA</RequestId>
</UpdateTransitRouterPeerAttachmentAttributeResponse>

JSON format

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

Error codes

HttpCode Error code 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.