Call AssociateTransitRouterAttachmentWithRouteTable to create a forwarding association - Cloud Enterprise Network - Alibaba Cloud - Cloud Enterprise Network

Creates a route table association.

Operation description

After you create a network instance connection, you must set a route table association for it by associating the network instance connection with an Enterprise Edition transit router route table. After the association is created, the Enterprise Edition transit router forwards traffic of the network instance based on the route entries in the route table. Before you invoke this operation, take note of the following information:

Only Enterprise Edition transit router route tables support route table associations. For information about the regions and zones that support Enterprise Edition transit routers, see What is Cloud Enterprise Network?.
Each network instance connection can be associated with only one Enterprise Edition transit router route table.
AssociateTransitRouterAttachmentWithRouteTable is an asynchronous operation. After you send a request, the system returns a RequestId but the association between the network instance connection and the route table is not yet complete. The association task is still running in the background. You can call ListTransitRouterRouteTableAssociations to query the association status between the network instance connection and the route table.
- If the association status is Associating, the network instance connection is being associated with the route table. In this state, you can only query the association but cannot perform other operations.
- If the association status is Active, the network instance connection is associated with the route table.

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:AssociateTransitRouterAttachmentWithRouteTable

create

*TransitRouterPeerAttachment

acs:cen:*:{#accountId}:centransitrouterattachment/{#centransitrouterattachmentId}

None

Request parameters

Parameter	Type	Required	Description	Example
TransitRouterAttachmentId	string	Yes	The ID of the network instance connection.	tr-attach-nls9fzkfat8934****
TransitRouterRouteTableId	string	Yes	The ID of the Enterprise Edition transit router route table.	vtb-bp1dudbh2d5na6b50****
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****
DryRun	boolean	No	Specifies whether to perform a dry run. The dry run checks parameter validity, user permissions, and instance status. Valid values: false (default): sends the request. If the request passes the dry run, the route table association is created. true: sends a dry run request. The system checks the required parameters, request syntax, and instance status. If the request fails the dry run, an error message is returned. If the request passes the dry run, the error code `DryRunOperation` is returned.	false

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	4EC47282-1B74-4534-BD0E-403F3EE64CAF

Examples

Success response

JSON format

{
  "RequestId": "4EC47282-1B74-4534-BD0E-403F3EE64CAF"
}

Error codes

HTTP status code	Error code	Error message	Description
400	AssociationExist.TransitRouterTable	The specified association already exists.	The error message returned because the specified route table is already associated with an associated forwarding correlation.
400	IllegalParam.TransitRouterTableType	When peer attachment is associated with a custom routeTable, the Transit Router in both regions must be enterprise.	The error message returned because both the local and peer transit routers must be of Enterprise Edition when you associate the inter-region connection with a route table.
400	OperationFailed.TransitRouterType	Operation failed because transit router type not support this operation.	The error message returned because this operation is not support by the specified type of transit router.
400	IncorrectStatus.AttachmentOrRouteTable	The resource is not in a valid state for the operation.	The error message returned because this operation is not supported when the specified attachment or route table is in an unstable state. Try again later.
400	IllegalParam.TransitRouterTableId	The specified TransitRouterTableId is invalid.	The error message returned because the TransitRouterTableId parameter is set to an invalid value.
400	OperationUnsupported.Associate	The specified attachment or routeTable is not supported by this operation.	The error message returned because this operation is not supported by the specified attachment or route table.
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.TransitRouterAttachmentId	The specified parameter TransitRouterAttachmentId is invalid.
404	InvalidRouteTableId.NotFound	The specified RouteTableId is not found.	The specified route table ID does not exist.
404	InvalidAttachmentId.NotFound	The specified AttachmentId is not found.	The error message returned because the specified network instance connection ID does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.