All Products
Search

This Product

    Cloud Enterprise Network:CreateTransitRouterRouteTable

    Document Center

    Cloud Enterprise Network:CreateTransitRouterRouteTable

    Last Updated:Mar 25, 2024

    Creates a custom route table for an Enterprise Edition transit router.

    Operation description

    • Only Enterprise Edition transit routers support custom route tables. For more information about the regions and zones that support Enterprise Edition transit routers, see What is CEN?

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

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

    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:CreateTransitRouterRouteTableWrite
    • TransitRouter
      acs:cen:*:{#accountId}:centransitrouter/{#centransitrouterId}
    • TransitRouterRouteTable
      acs:cen:*:{#accountId}:centransitrouterroutetable/*
      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****
    TransitRouterRouteTableNamestringNo

    The name of the custom route table.

    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
    TransitRouterRouteTableDescriptionstringNo

    The description of the custom route table.

    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
    TransitRouterIdstringYes

    The ID of the Enterprise Edition transit router.

    		tr-bp1su1ytdxtataupl****
    DryRunbooleanNo

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

    • false (default): sends the request. If the request passes the precheck, the custom route table is created.
    • true: prechecks the request but does not create the custom route table. 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.
    		false
    Tagobject []No

    The tags.

    You can specify at most 20 tags in each call.

    KeystringNo

    The tag key.

    The tag key cannot be an empty string. The tag key can be up to 64 characters in length and cannot start with acs: or aliyun. It cannot contain http:// or https://.

    You can specify at most 20 tag keys.

    		test
    ValuestringNo

    The tag value.

    The tag value can be 0 to 128 characters in length, and cannot start with aliyun or acs:. It cannot contain http:// or https://.

    Each tag key must have a unique tag value. You can specify at most 20 tag values in each call.

    		tagtest
    RouteTableOptionsobjectNo

    The features of the route table.

    MultiRegionECMPstringNo

    Specifies whether to enable multi-region equal-cost multi-path (ECMP) routing. Valid values:

    • disable(default) If multi-region ECMP routing is disabled, routes that are learned from different regions but have the same prefix and attributes select the transit router with the smallest region ID as the next hop. Region IDs are sorted in alphabetic order. The network latency and bandwidth consumption also vary based on the region. Proceed with caution.
    • enable If multi-region ECMP routing is enabled, routes that are learned from different regions but have the same prefix and attributes form an ECMP route. The network latency and bandwidth consumption also vary based on the region. Proceed with caution.
    		disable

    Response parameters

    ParameterTypeDescriptionExample
    object
    TransitRouterRouteTableIdstring

    The ID of the custom route table.

    		vtb-bp1xbcgpgcz9axl9m****
    RequestIdstring

    The ID of the request.

    		599904C8-A3DA-4E5F-83B6-D5364E664247

    Examples

    Sample success responses

    JSONformat

    {
  "TransitRouterRouteTableId": "vtb-bp1xbcgpgcz9axl9m****",
  "RequestId": "599904C8-A3DA-4E5F-83B6-D5364E664247"
}

    Error codes

    HTTP status codeError codeError messageDescription
    400InvalidTransitRouterId.NotFoundTransitRouterId is not foundThe error message returned because the specified transit router ID (TransitRouterId) does not exist.
    400OperationFailed.CCNTrNotSupportOperation failed because the CCN transit router does not support route table.The error message returned because transit routers deployed in CCN regions do not allow you to create route tables.
    400DryRunOperationRequest validation has been passed with DryRun flag set.The error message returned because the dry run request passed the precheck.
    400MissingParam.TransitRouterIdThe parameter TransitrouterId is mandatory.The error message returned because the TransitRouterId parameter is not set.
    400OperationFailed.BasicTrNotSupportOperation failed because the Basic TransitRouter does not support RouteTableThe error message returned because this operation is not supported by Basic Edition transit routers.
    400IncorrectStatus.TransitRouterTransitRouter status is invalid.The error message returned because the status of the transit router does not support this operation. Try again later.
    400QuotaExceeded.TransitRouterRoutTableTransitRouterRoutTable quota exceeded.The error message returned because the number of route tables has reached the upper limit.
    400OperationUnsupported.MultiRegionEcmpThis region does not support MultiRegionEcmp.-
    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-10-18The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
    2023-01-10The Error code has changed. The request parameters of the API has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
    Input ParametersThe request parameters of the API has changed.
      Added Input Parameters: RouteTableOptions
    2023-01-04The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400