All Products
Search
Document Center

Cloud Enterprise Network:EnableTransitRouterRouteTablePropagation

Last Updated:Mar 01, 2024

Creates a route learning correlation.

Operation 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. Before you begin, we recommend that you take note of the following rules:

  • 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 What is CEN?

  • EnableTransitRouterRouteTablePropagation is an asynchronous operation. After you send a request, the system returns a request ID and runs the task in the background. You can call the ListTransitRouterRouteTablePropagations operation to query the route learning status between a network instance connection and a route table.

    • Enabling indicates that a route learning correlation is being created between the network instance connection and route table. You can query the route learning correlation but cannot perform other operations.
    • Active indicates that the route learning correlation is created between the network instance connection and route table.

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:EnableTransitRouterRouteTablePropagationWrite
  • TransitRouterPeerAttachment
    acs:cen:*:{#accountId}:centransitrouterattachment/{#centransitrouterattachmentId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
TransitRouterAttachmentIdstringYes

The ID of the network instance connection.

tr-attach-nls9fzkfat8934****
TransitRouterRouteTableIdstringYes

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

vtb-bp1dudbh2d5na6b50****
ClientTokenstringNo

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 token can contain only ASCII characters.

Note If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID may be different for each request.
02fb3da4-130e-11e9-8e44-001****
DryRunbooleanNo

Specifies whether to perform only a dry run, without performing the actual request. Default values:

  • false (default): performs a dry run and performs the actual request.
  • true: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and service limits. If the request fails the dry run, an error code is returned. If the request passes the dry run, the DryRunOperation error code is returned.
false

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

59CF8BF9-DE61-421E-B903-D56AF46A303C

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400IllegalParam.TransitRouterTableIdThe specified TransitRouterTableId is invalid.The error message returned because the TransitRouterTableId parameter is set to an invalid value.
400OperationFailed.TransitRouterTypeThe specified TransitRouterType does not support the operation.The error message returned because this operation is not supported by the specified type of transit router.
400IncorrectStatus.AttachmentOrRouteTableThe 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.
400OperationUnsupported.EnablePropagationThe 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.
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.
404InvalidRouteTableId.NotFoundThe specified RouteTableId is not found.The specified route table ID does not exist.
404InvalidAttachmentId.NotFoundThe 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 Service error codes.

Change history

Change timeSummary of changesOperation
2023-01-04The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 400 change
    delete Error Codes: 404