Modifies the name and description of a 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 No UpdateTransitRouter

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

RegionId String Yes cn-shanghai

The ID of the region where the transit router is deployed.

You can call the DescribeRegions operation to query region IDs.

TransitRouterId String Yes tr-uf654ttymmljlvh2x****

The ID of the transit router.

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.

DryRun Boolean No false

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

  • false(default): sends a normal request. If the request passes the precheck, the information of the transit router is modified.
  • true: sends a request for precheck only. The information of the transit router 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.
TransitRouterName String No testname

The name of the transit router.

The name must be 2 to 128 characters in length, and can contain digits, periods (.), underscores (_), and hyphens (-). It must start with a letter and cannot start with http:// or https://.

TransitRouterDescription String No testdesc

The description of the transit router.

The description must be 2 to 256 characters in length. The description must start with a letter but cannot start with http:// or https://.

Response parameters

Parameter Type Example Description
RequestId String E9963DD7-998B-4F92-892D-8293CB49EE81

The ID of the request.


Sample requests

&<Common request parameters>

Sample success responses

XML format


JSON format

  "RequestId": "E9963DD7-998B-4F92-892D-8293CB49EE81"

Error codes

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