All Products
Search
Document Center

Cloud Enterprise Network:UpdateTransitRouterRouteEntry

Last Updated:Mar 25, 2024

Modifies the name and description of a route in a 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.

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
cen:UpdateTransitRouterRouteEntryWrite
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
TransitRouterRouteEntryIdstringYes

The ID of the route.

rte-ksssq7kto4wfdx****
TransitRouterRouteEntryNamestringNo

The new name of the route.

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

testname
TransitRouterRouteEntryDescriptionstringNo

The new description of the route.

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

testdesc
ClientTokenstringNo

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 is different for each request.
02fb3da4-130e-11e9-8e44-001****
DryRunbooleanNo

Specifies whether to perform a dry run. Default values:

  • false (default): performs a dry run and sends the request.
  • true: performs a dry run. The system checks the required parameters and request syntax. If the request fails the dry run, an error message is returned. If the request passes the dry run, the DryRunOperation error code is returned.
false

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

2D69CCEA-42D0-48B2-8C9A-9BB207F76D6E

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400IllegalParam.TransitRouterRouteEntryIdTransitRouterRouteEntryId is not found.The error message returned because the route ID of the transit router (TransitRouterRouteEntryId) is invalid.
400DryRunOperationRequest validation has been passed with DryRun flag set.The error message returned because the dry run request passed the precheck.
400InvalidNameName is invalid.The error message returned because the specified name is invalid.
400InvalidDescriptionDescription is invalid.The error message returned because the description is invalid.
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