Docs

Transit Router

Route learning

DescribeTransitRouterRouteTablePropagations - Querying a route learning list

Call DescribeTransitRouterRouteTablePropagations to query route learning that meets the specified conditions.

Debug

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Go to debug

Request parameters

The following only details request parameters specific to this API and key common parameters. For more information, see Common parameters.

Action String required Example value: DescribeTransitRouterRouteTablePropagations

The interface name. The current API name is DescribeTransitRouterRouteTablePropagations.

Version String required Example value: 2020-04-01

The interface version. The current API version is 2020-04-01.

PageNumber Integer required Example value: 1

The page number of the list. Default: 1.

PageSize Integer required Example: 20

The number of entries on each page in a pagination query. Valid values: 1–100. Default: 20.

TransitRouterAttachmentId String required Example: tr-attach-13n2l4c****

The ID of the network instance attachment.

You can call the DescribeTransitRouterVpcAttachments API to obtain the ID of the Virtual Private Cloud (VPC) attachment.

You can call the DescribeTransitRouterDirectConnectGatewayAttachments API to obtain the ID of the Direct Connect (DC) Gateway attachment.

You can call the DescribeTransitRouterPeerAttachments API to obtain the ID of the inter-region attachment.

TransitRouterRouteTableId String required Example value: r-rtb-1i5i8khf9m58gae5kcx6****

The ID of the route table associated with the Transit Router (TR) instance. You can call the DescribeTransitRouterRouteTables API to obtain the TR route table ID.

Response parameters

The following only details response parameters specific to this API. For more information, see Response structure.

PageSize Integer Example: 1

The current page number.

PageNumber Integer Example value: 1

The current page number.

TotalCount Integer Example: 2

The total number of route learning that matches the conditions.

TransitRouterRouteTablePropagations Object[] Example value: --

The details of route learning that matches the conditions.

CreationTime String Example value: 2021-04-09T08:36:47+08:00

The time when route learning is created.

TransitRouterAttachmentId String Example: tr-attach-13n2l4c****

The ID of the network instance attachment.

TransitRouterRouteTableId String Example: tr-rtb-1i5i8khf9m58gae5kcx6****

The ID of the route table associated with the Transit Router (TR) instance.

Status String Example: Available

The route learning status.

Available

Creating

Pending: Configuration in progress.

Deleting

PropagationGranularity String Example value: Subnet

The route learning granularity.

Subnet: Learn routes per subnet

VPC: Learn routes per Virtual Private Cloud (VPC).

Request examples

GET /?Action=DescribeTransitRouterRouteTablePropagations&Version=2020-04-01&TransitRouterRouteTableId=r-rtb-1i5i8khf9m58gae5kcx6**** HTTP/1.1​
Host: transitrouter.cn-beijing.volcengineapi.com​
X-Date: 20250815T031012Z​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20250815/cn-beijing/transitrouter/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​

Response examples

{​
    "ResponseMetadata": {​
        "RequestId": "20250815111015034200066214456DC8",​
        "Action": "DescribeTransitRouterRouteTablePropagations",​
        "Version": "2020-04-01",​
        "Service": "transitrouter",​
        "Region": "cn-beijing"​
    },​
    "Result": {​
        "PageSize": 1,​
        "PageNumber": 1,​
        "TotalCount": 2,​
        "TransitRouterRouteTablePropagations": [​
            {​
                "CreationTime": "2021-04-09T08:36:47+08:00",​
                "TransitRouterAttachmentId": "tr-attach-13n2l4c****",​
                "TransitRouterRouteTableId": "tr-rtb-1i5i8khf9m58gae5kcx6****",​
                "Status": "Available"​
            }​
        ]​
    }​
}​

Error codes

The table below describes the error codes for this API that are associated with business logic. For more information, see Common error codes.

Status code	Error codes	Error message	Explanation
400	InvalidPage.Malformed	The specified page is malformed.	The specified pagination parameter is invalid.
403	Forbidden.NoPermissionToOperate	You are not authorized to operate the specified resource.	No permission to manage the specified resource.
404	InvalidTransitRouterRouteTable.NotFound	The specified route table does not exist.	The specified Transit Router (TR) route table does not exist.

Last updated: 2025.12.29 19:24:05