Creates a route learning correlation.

Description

After you establish a network instance connection on a transit router, you can create a route learning correlation for the network instance connection. Then, the routes of the connected network instance are automatically advertised to the route table of the transit router.

Limits

You can create route learning correlations only on Enterprise Edition transit routers. For more information about the regions and zones that support Enterprise Edition transit routers, see Transit routers.

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 No EnableTransitRouterRouteTablePropagation

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

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

The ID of the network instance connection.

TransitRouterRouteTableId String Yes vtb-bp1dudbh2d5na6b50****

The ID of the route table that belongs to 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 a token, but you must make sure that it is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.

DryRun Boolean No false

Specifies whether to only precheck the request. Check items include permissions and the status of the transit router. Valid values:

  • false (default): sends a normal request. If the request passes the precheck, a route learning correlation is created.
  • true: sends a request for precheck only. No route learning correlation is created after the request passes the precheck. If you select this option, the system checks whether the required parameters are set, and whether the request syntax is valid. If the request fails to pass the precheck, the system returns an error. If the request passes the precheck, the system returns the ID of the request.

Response parameters

Parameter Type Example Description
RequestId String 59CF8BF9-DE61-421E-B903-D56AF46A303C

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=EnableTransitRouterRouteTablePropagation
&TransitRouterAttachmentId=tr-attach-nls9fzkfat8934****
&TransitRouterRouteTableId=vtb-bp1dudbh2d5na6b50****
&<Common request parameters>

Sample success responses

XML format

<EnableTransitRouterRouteTablePropagationResponse> 
  <RequestId>59CF8BF9-DE61-421E-B903-D56AF46A303C</RequestId>
</EnableTransitRouterRouteTablePropagationResponse>

JSON format

{
  "RequestId": "59CF8BF9-DE61-421E-B903-D56AF46A303C"
}

Error codes

HttpCode Error code Error message Description
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 AttachmentId does not exist.

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