All Products
Document Center

Cloud Enterprise Network:UpdateTransitRouter

Last Updated:Mar 25, 2024

Modifies the name and description of a transit router.

Operation description

UpdateTransitRouter is an asynchronous operation. After a request is sent, the system returns a request ID and runs the task in the background. You can call the ListTransitRouters operation 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.


OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
  • TransitRouter

Request parameters


The client token that is used to ensure the idempotence of the request.

You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters.

Note If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID may be different for each request.

Specifies whether to perform only a dry run, without performing the actual request. Valid values:

  • false (default): performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.
  • true: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and service limits. If the request fails the dry run, an error message is returned. If the request passes the dry run, the system returns the ID of the request.

The region ID of the transit router.

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


The transit router ID.


The transit router name.

The name must be 1 to 128 characters in length, and cannot start with http:// or https://. You can also leave this parameter empty.


The description of the transit router.

The description must be 1 to 256 characters in length, and cannot start with http:// or https://. You can also leave this parameter empty.


Response parameters


The request ID.



Sample success responses


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

Error codes

HTTP status codeError codeError messageDescription
400OperationUnsupported.RegionIdThe specified region ID is not supported.The specified region ID is not supported.
400IncorrectStatus.TransitRouterInstanceThe status of TransitRouter is incorrect.The error message returned because the transit router is in an invalid state.
400InvalidParameterInvalid parameter.The error message returned because the parameter is set to an invalid value.
400UnauthorizedThe AccessKeyId is unauthorized.The error message returned because you do not have the permissions to perform this operation.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history