Modifies the settings of a virtual border router (VBR) connection on an Enterprise Edition transit router.

Usage notes

UpdateTransitRouterVbrAttachmentAttribute 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 ListTransitRouterVbrAttachments to query the status of a VBR connection.

  • If a VBR connection is in the Modifying state, the VBR connection is being modified. You can query the VBR connection but cannot perform other operations.
  • If the VBR connection is in the Attached state, the VBR 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 UpdateTransitRouterVbrAttachmentAttribute

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

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-oyf70wfuorwx87****

The ID of the VBR connection.

TransitRouterAttachmentName String No testname

The new name of the VBR 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 VBR 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 true

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

  • true: yes
  • false: no
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 VBR connection are modified.
  • true: sends a request for precheck only. The name and description of the VBR 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 to pass the precheck, an error message is returned. If the request passes the precheck, the DryRunOperation error code is returned.

Response parameters

Parameter Type Example Description
RequestId String 91B36DC3-FF8A-45C3-AC1E-456B1789136D

The ID of the request.

Examples

Sample requests

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

Sample success responses

XML format 

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

<UpdateTransitRouterVbrAttachmentAttributeResponse>
    <RequestId>91B36DC3-FF8A-45C3-AC1E-456B1789136D</RequestId>
</UpdateTransitRouterVbrAttachmentAttributeResponse>

JSON format 

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

{
  "RequestId" : "91B36DC3-FF8A-45C3-AC1E-456B1789136D"
}

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.