All Products
Search

This Product

    Cloud Enterprise Network:CreateTransitRouterRouteEntry

    Document Center

    Cloud Enterprise Network:CreateTransitRouterRouteEntry

    Last Updated:Oct 12, 2023

    Adds a route to a route table of an Enterprise Edition transit router.

    Operation Description

    CreateTransitRouterRouteEntry is an asynchronous operation. After you send a request, the route ID is returned but the operation is still being performed in the system background. You can call ListTransitRouterRouteEntries to query the status of a route.

    • If a route is in the Creating state, the route is being created. In this case, you can query the route but cannot perform other operations.
    • If a route is in the Active state, the route is created.

    debugging

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    debugging

    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:CreateTransitRouterRouteEntryWrite
    • TransitRouterRouteEntry
      acs:cen:*:{#accountId}:centransitrouterroutentry/*
    • TransitRouterRouteTable
      acs:cen:*:{#accountId}:centransitrouterroutetable/{#centransitrouterroutetableId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    ClientTokenstringNo

    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.
    		02fb3da4-130e-11e9-8e44-001****
    TransitRouterRouteEntryNamestringNo

    The name of the route.

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

    		testname
    TransitRouterRouteEntryDescriptionstringNo

    The description of the route.

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

    		testdesc
    TransitRouterRouteTableIdstringYes

    The ID of the route table of the Enterprise Edition transit router.

    		vtb-bp1dudbh2d5na6b50****
    TransitRouterRouteEntryNextHopTypestringYes

    The type of the next hop. Valid values:

    • BlackHole: routes network traffic to a black hole. All packets that match this route are dropped. If you select this option, you do not need to specify the next hop information.
    • Attachment: routes network traffic to a network instance connection. If you select this option, you must specify the ID of the network instance connection. All packets that match this route are routed to the specified network instance connection.
    		BlackHole
    TransitRouterRouteEntryDestinationCidrBlockstringYes

    The destination CIDR block of the route.

    		192.168.0.0/24
    TransitRouterRouteEntryNextHopIdstringNo

    The ID of the network instance connection that you want to specify as the next hop.

    		tr-attach-nls9fzkfat8934****
    DryRunbooleanNo

    Specifies whether to perform a precheck to check information such as the permissions and instance status. Valid values:

    • false (default): sends the request. If the request passes the precheck, the route entry is added.
    • true: sends a precheck request but does not add the route. 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 DryRunOperation error code is returned.
    		false

    Response parameters

    ParameterTypeDescriptionExample
    object
    TransitRouterRouteEntryIdstring

    The ID of the route.

    		rte-75eg4jprkvk0pw****
    RequestIdstring

    The ID of the request.

    		835E7F4B-B380-4E0F-96A5-6EA572388047

    Examples

    Sample success responses

    JSONformat

    {
  "TransitRouterRouteEntryId": "rte-75eg4jprkvk0pw****",
  "RequestId": "835E7F4B-B380-4E0F-96A5-6EA572388047"
}

    Error codes

    HTTP status codeError codeError messageDescription
    400DryRunOperationRequest validation has been passed with DryRun flag set.The error message returned because the dry run request passed the precheck.
    400InvalidTransitRouterRouteTableId.NotFoundTransitRouterRouteTableId is not found.The error message returned because the specified route table ID of the transit router does not exist.
    400TransitRouterRouteEntryNextHopId.NotFoundTransitRouterRouteEntryNextHopId is not found.The error message returned because the specified next hop ID of the transit router does not exist.
    400OperationFailed.CreateRouteEntryWithCCNAttachmentOperation failed because Create RouteEntry to CCN Attachment does not support.The error message returned because routes that point to a CCN attachment are not supported.
    400QuotaExceeded.TransitRouterRoutEntryTransitRouterRoutEntry quota exceeded.The error message returned because the number of routes has reached the upper limit.
    400IllegalParam.TransitRouterDestinationCidrBlockTransitRouterDestinationCidrBlock is illegal.The error message returned because the specified destination CIDR block for the transit router (TransitRouterDestinationCidrBlock) is invalid.
    400InstanceExist.TransitRouterRouteEntryThe instance TransitRouterRouteEntry already exists.The error message returned because the route entry that you want to add already exists.
    400IncorrectStatus.TransitRouterRouteTableTransitRouterRouteTable status is invalid.The error message returned because the transit router is in an invalid state.
    400ParamExclusive.RouteEntryIdAndRouteTableIdOrDestCidrBlockRouteEntryId and TransitRouterRouteTableIdOrDestCidrBlock is mutually exclusive.The error message returned because the RouteEntryId, TransitRouterRouteTableId, or DestCidrBlock parameter conflicts with each other.
    400InvalidDescriptionDescription is invalid.The error message returned because the description is invalid.
    400InvalidNameName is invalid.The error message returned because the specified name is invalid.
    400IllegalParam.NextHopTypeThe NextHopType is illegal.The error message returned because the NextHopType parameter is set to an invalid value.
    400MissingParam.TransitRouterRouteEntryNextHopIdThe parameter TransitRouterRouteEntryNextHopId is mandatoryThe error message returned because the TransitRouterRouteEntryNextHopId parameter is not set.
    400InvalidTransitRouterRouteEntryNextHopId.NotFoundTransitRouterRouteEntryNextHopId is not foundThe error message returned because the specified ID of the next hop (TransitRouterRouteEntryNextHopId) specified for the transit router route entry does not exist.
    400OperationFailed.CreateRouteEntryWithSameDestinationCidrBlockOperation failed because Create RouteEntry with same destination cidrblock does not support.The error message returned because the destination CIDR block of each route entry in the route table must be unique.
    400InvalidDestinationCidrBlock.NotFoundDestinationCidrBlock is not found.The error message returned because the specified destination CIDR block does not exist.
    400OperationFailed.CreateRouteEntryWithConnectAttachmentOperation failed because Create RouteEntry to connect Attachment does not support.You cannot create a route that points to a connect attachment.
    400ParamExclusive.NextHopTypeBlackHoleAndNextHopIdTransitRouterRouteEntryNextHopType(BlackHole) and TransitRouterRouteEntryNextHopId is mutually exclusive.If you set Blackhole Route to Yes, do not specify a next hop.
    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
    2023-06-13The error codes of the API operation change.see changesets
    Change itemChange content
    Error CodesThe error codes of the API operation change.
      Error Codes 400 change
    2023-01-04The error codes of the API operation change.see changesets
    Change itemChange content
    Error CodesThe error codes of the API operation change.
      Error Codes 400 change