Modifies an inter-region connection on an Enterprise Edition transit router.

Usage notes

UpdateTransitRouterPeerAttachmentAttribute 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 ListTransitRouterPeerAttachments to query the status of an inter-region connection.

  • If an inter-region connection is in the Modifying state, the inter-region connection is being modified. You can query the inter-region connection but cannot perform other operations.
  • If an inter-region connection is in the Attached state, the inter-region 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 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 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 for each API request may be different.
TransitRouterAttachmentId String Yes tr-attach-ft94dcrbc3e5taun3x

The ID of the inter-region connection.

TransitRouterAttachmentName String No testname

The new name of the inter-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 inter-region connection to the peer transit router. Valid values:

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

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

  • false (default): checks the request. If the request passes the check, the inter-region connection is modified.
  • true: prechecks the request but does not perform the operation. The cross-region connection is 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 to pass the precheck, an error message is returned. If the request passes the check, the system returns the ID of the request.
Bandwidth Integer No 2

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

  • This parameter specifies the maximum bandwidth value for the inter-region connection if you set BandwidthType to BandwidthPackage.

  • This parameter specifies the bandwidth throttling threshold for the inter-region connection if you set BandwidthType to DataTransfer.
CenBandwidthPackageId String No cenbwp-3xrxupouolw5ou****

The ID of the bandwidth plan that is used to allocate bandwidth to the inter-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: bandwidth is billed based on the pay-by-data-transfer metering method.

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
&ClientToken=02fb3da4-130e-11e9-8e44-001****
&TransitRouterAttachmentId=tr-attach-ft94dcrbc3e5taun3x
&TransitRouterAttachmentName=testname
&TransitRouterAttachmentDescription=testdesc
&AutoPublishRouteEnabled=false
&DryRun=false
&Bandwidth=2
&CenBandwidthPackageId=cenbwp-3xrxupouolw5ou****
&BandwidthType=BandwidthPackage
&<Common request parameters>

Sample success responses

XML format 

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

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

JSON format 

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

{
  "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 does not exist.

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