Modifies the name and description of a transit router.

Usage notes

UpdateTransitRouter 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 ListTransitRouters to query the status of a transit router.

  • If a transit router is in the Modifying state, the configuration of the transit router is being modified. You can query the transit router but cannot perform other operations.
  • If a transit router is in the Active state, the configuration of the transit router 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 UpdateTransitRouter

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

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 may be different for each API request.
DryRun Boolean No false

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

  • false: sends the 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 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.
RegionId String Yes cn-shanghai

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

You can call the DescribeRegions operation to query the most recent region list.

TransitRouterId String Yes tr-uf654ttymmljlvh2x****

The ID of the transit router.

TransitRouterName String No testname

The name of the transit router.

The name must be 2 to 128 characters in length and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter but 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.

Examples

Sample requests

http(s)://[Endpoint]/?Action=UpdateTransitRouter
&ClientToken=02fb3da4-130e-11e9-8e44-001****
&DryRun=false
&RegionId=cn-shanghai
&TransitRouterId=tr-uf654ttymmljlvh2x****
&TransitRouterName=testname
&TransitRouterDescription=testdesc
&Common request parameters

Sample success responses

XML format 

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

<UpdateTransitRouterResponse>
    <RequestId>E9963DD7-998B-4F92-892D-8293CB49EE81</RequestId>
</UpdateTransitRouterResponse>

JSON format 

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

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

Error codes

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