Modifies the name and description of a route in the route table of an Enterprise Edition transit router.

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 No UpdateTransitRouterRouteEntry

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

TransitRouterRouteEntryId String Yes rte-ksssq7kto4wfdx****

The ID of the route.

TransitRouterRouteEntryName String No testname

The new name of the route.

The name must be 1 to 128 characters in length, and can contain letters, digits, and the following special characters: , . ; / @ _ -. You can also leave the name empty.

TransitRouterRouteEntryDescription String No testdesc

The new description of the route.

The description must be 2 to 256 characters in length, and can contain letters, digits, and the following special characters: , . ; / @ _ -. You can also leave the description empty.

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 ensure 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 name and description of the route are modified.
  • true: sends a request for precheck only. The name and description of the transit router are 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.

Response parameters

Parameter Type Example Description
RequestId String 2D69CCEA-42D0-48B2-8C9A-9BB207F76D6E

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=UpdateTransitRouterRouteEntry
&TransitRouterRouteEntryId=rte-ksssq7kto4wfdx****
&<Common request parameters>

Sample success responses

XML format

<UpdateTransitRouterRouteEntryResponse> 
  <RequestId>2D69CCEA-42D0-48B2-8C9A-9BB207F76D6E</RequestId>
</UpdateTransitRouterRouteEntryResponse>

JSON format

{
  "RequestId": "2D69CCEA-42D0-48B2-8C9A-9BB207F76D6E"
}

Error codes

HttpCode Error code Error message Description
400 DryRunOperation Request validation has been passed with DryRun flag set. The error message returned because the dry run request passes the precheck.

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