Call CreateTransitRouterRouteTable to create a custom route table for an Enterprise Edition transit router - Cloud Enterprise Network - Alibaba Cloud - Cloud Enterprise Network

Creates a custom route table for an Enterprise Edition transit router by calling the CreateTransitRouterRouteTable operation.

Operation description

Only Enterprise Edition transit routers support custom route tables. For 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 system returns a route table ID but the route table is not yet created. The system continues to create the route table in the background. You can call ListTransitRouterRouteTables to query the status of the route table.
- If the route table is in the Creating state, the route table is being created. In this state, you can only perform query operations.
- If the route table is in the Active state, the route table is created.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cen:CreateTransitRouterRouteTable

create

TransitRouter

acs:cen:*:{#accountId}:centransitrouter/{#centransitrouterId}

TransitRouterRouteTable

acs:cen:*:{#accountId}:centransitrouterroutetable/*

None

Request parameters

Parameter	Type	Required	Description	Example
ClientToken	string	No	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 client token can contain only ASCII characters. Note If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId may be different for each API request.	02fb3da4-130e-11e9-8e44-001****
TransitRouterRouteTableName	string	No	The name of the custom route table. The name can be empty or 1 to 128 characters in length and cannot start with http:// or https://.	testname
TransitRouterRouteTableDescription	string	No	The description of the custom route table. The description can be empty or 1 to 256 characters in length and cannot start with http:// or https://.	testdesc
TransitRouterId	string	Yes	The ID of the Enterprise Edition transit router instance.	tr-bp1su1ytdxtataupl****
DryRun	boolean	No	Specifies whether to perform a dry run, including permission and instance status verification. Valid values: false (default): sends a normal request and creates the custom route table after the request passes the verification. true: sends a check request without creating the custom route table. The system checks the required parameters, request format, and other conditions. If the check fails, the corresponding error is returned. If the check passes, the corresponding request ID is returned.	false
Tag	array<object>	No	The tag information. You can specify up to 20 tags at a time.
	object	No
Key	string	No	The tag key of the resource. Once specified, the tag key cannot be an empty string. The tag key can be up to 64 characters in length and cannot start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`. You can specify up to 20 tag keys at a time.	test
Value	string	No	The tag value of the resource. Once specified, the tag value cannot be empty. The tag value can be up to 128 characters in length and cannot start with aliyun or acs:. It cannot contain http:// or https://. Each tag key corresponds to one tag value. You can specify up to 20 tag values at a time.	tagtest
RouteTableOptions	object	No	The route table options.
MultiRegionECMP	string	No	The multi-region equal-cost multi-path (ECMP) routing setting. Valid values: disable (default): disables multi-region ECMP routing. After multi-region ECMP routing is disabled, routes with the same prefix learned from different regions prefer the transit router whose Region ID is the smallest (sorted alphabetically) as the next hop when other route attributes are the same. This may change traffic latency and bandwidth consumption between regions. Make sure that you fully evaluate the impact before disabling this feature. enable: enables multi-region ECMP routing. After multi-region ECMP routing is enabled, routes with the same prefix learned from different regions form ECMP routes when other route attributes are the same. This may change traffic latency and bandwidth consumption between regions. Make sure that you fully evaluate the impact before enabling this feature. Valid values: disable : Disable multi-region equal-cost multi-path (ECMP) routing enable : Enable multi-region equal-cost multi-path (ECMP) routing	disable

Response elements

Element	Type	Description	Example
	object	The response parameters.
TransitRouterRouteTableId	string	The ID of the custom route table.	vtb-bp1xbcgpgcz9axl9m****
RequestId	string	The request ID.	599904C8-A3DA-4E5F-83B6-D5364E664247

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidTransitRouterId.NotFound	TransitRouterId is not found	The error message returned because the specified transit router ID (TransitRouterId) does not exist.
400	OperationFailed.CCNTrNotSupport	Operation 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.
400	DryRunOperation	Request validation has been passed with DryRun flag set.	The error message returned because the dry run request passed the precheck.
400	MissingParam.TransitRouterId	The parameter TransitrouterId is mandatory.	The error message returned because the TransitRouterId parameter is not set.
400	OperationFailed.BasicTrNotSupport	Operation failed because the Basic TransitRouter does not support RouteTable	The error message returned because this operation is not supported by Basic Edition transit routers.
400	IncorrectStatus.TransitRouter	TransitRouter status is invalid.	The error message returned because the status of the transit router does not support this operation. Try again later.
400	QuotaExceeded.TransitRouterRoutTable	TransitRouterRoutTable quota exceeded.	The error message returned because the number of route tables has reached the upper limit.
400	OperationUnsupported.MultiRegionEcmp	This region does not support MultiRegionEcmp.
400	InvalidParameter	Invalid parameter.	The error message returned because the parameter is set to an invalid value.
400	Unauthorized	The AccessKeyId is unauthorized.	The error message returned because you do not have the permissions to perform this operation.
400	InvalidParameter.TagValue	The specified parameter TagValue is invalid.	The input parameter Tag Value is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.