Creates an associated forwarding correlation.

Usage notes

After you create a network instance connection on a transit router, you can configure an associated forwarding correlation to associate the network instance connection with a route table. Then, the network instance connection can forward network traffic based on the associated route table. Before you begin, we recommend that you read and understand the following rules:

  • Only Enterprise Edition transit routers support associated forwarding correlations. For more information about the regions and zones that support Enterprise Edition transit routers, see Transit routers.
  • AssociateTransitRouterAttachmentWithRouteTable is an asynchronous operation. After you send a request, the system returns the request ID but the operation is still being performed in the system background. You can call ListTransitRouterRouteTableAssociations to query the status of an associated forwarding correlation.
    • If an associated forwarding correlation is in the Associating state, the associated forwarding correlation is being created. You can query the associated forwarding correlation but cannot perform other operations.
    • If an associated forwarding correlation is in the Active state, the associated forwarding correlation is created.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes AssociateTransitRouterAttachmentWithRouteTable

The operation that you want to perform. Set the value to AssociateTransitRouterAttachmentWithRouteTable.

TransitRouterAttachmentId String Yes tr-attach-nls9fzkfat8934****

The ID of the network instance connection.

TransitRouterRouteTableId String Yes vtb-bp1dudbh2d5na6b50****

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

ClientToken String No 02fb3da4-130e-11e9-8e44-001****

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.
DryRun Boolean No false

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 associated forwarding correlation is created.
  • true: sends a request for precheck only. The associated forwarding correlation is not created after the request passes the precheck. 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.

Response parameters

Parameter Type Example Description
RequestId String 4EC47282-1B74-4534-BD0E-403F3EE64CAF

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=AssociateTransitRouterAttachmentWithRouteTable
&TransitRouterAttachmentId=tr-attach-nls9fzkfat8934****
&TransitRouterRouteTableId=vtb-bp1dudbh2d5na6b50****
&ClientToken=02fb3da4-130e-11e9-8e44-001****
&DryRun=false
&Common request parameters

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<AssociateTransitRouterAttachmentWithRouteTableResponse>
    <RequestId>4EC47282-1B74-4534-BD0E-403F3EE64CAF</RequestId>
</AssociateTransitRouterAttachmentWithRouteTableResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

HttpCode 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.
404 InvalidRouteTableId.NotFound The specified RouteTableId is not found. The error message returned because 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.

For a list of error codes, visit the API Error Center.