Docs

Transit Router

Association forwarding

DescribeTransitRouterRouteTableAssociations - Querying the association forwarding list

Call the DescribeTransitRouterRouteTableAssociations API to query association forwarding rules that meet 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: DescribeTransitRouterRouteTableAssociations

The interface name. The current API name is DescribeTransitRouterRouteTableAssociations.

Version String required Example value: 2020-04-01

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

TransitRouterRouteTableId String required Example: tr-rtb-hy13n2l4c6c0v****

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.

PageNumber Integer optional Example: 1

The page number of the list. Default: 1.

PageSize Integer Optional Example: 20

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

TransitRouterAttachmentId String optional example: tr-attach-a*******

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 DescribeTransitRouterVpnAttachments API to obtain the ID of the Virtual Private Network (VPN) 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.

Response parameters

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

PageSize Integer Example: 20

Number of entries per page in the current pagination.

PageNumber Integer Example value: 1

The current page number.

TotalCount Integer Example: 1

Total number of qualified association forwarding rules.

TransitRouterRouteTableAssociations Object[] Example: --

The details of qualified association forwarding rules.

TransitRouterAttachmentId String Example value: 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 status of the association forwarding.

Available

Creating

Pending: Configuration in progress.

Deleting

Request examples

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

Response examples

{​
  "ResponseMetadata": {​
    "RequestId": "20250815110552079110162179816D68",​
    "Action": "DescribeTransitRouterRouteTableAssociations",​
    "Version": "2020-04-01",​
    "Service": "transitrouter",​
    "Region": "cn-beijing"​
  },​
  "Result": {​
    "PageSize": 20,​
    "PageNumber": 1,​
    "TotalCount": 1,​
    "TransitRouterRouteTableAssociations": [​
      {​
        "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	InvalidTransitRouter.NotFound	The specified Transit Router does not exist.	The specified Transit Router (TR) does not exist.
404	InvalidTransitRouterAttachment.NotFound	The specified Transit Router attachment does not exist.	The specified network instance attachment does not exist.
404	InvalidTransitRouterRouteTable.NotFound	The specified route table does not exist.	The specified Transit Router (TR) route table does not exist.

Last updated: 2026.01.09 16:26:47