Transit Router
Transit Router
Document
- Documentation
Transit RouterAPI referenceVPC attachmentDescribeTransitRouterVpcAttachments - Querying the list of VPC attachments
Copy page
Download PDFVPC attachment
DescribeTransitRouterVpcAttachments - Querying the list of VPC attachments
Copy pageDownload PDFDescribeTransitRouterVpcAttachments - Querying the list of VPC attachments
Call DescribeTransitRouterVpcAttachments to query Virtual Private Cloud (VPC) attachments that meet 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.
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: DescribeTransitRouterVpcAttachments
The interface name. The current API name is DescribeTransitRouterVpcAttachments.
Version String required Example: 2020-04-01
The interface version. The current API version is 2020-04-01.
TransitRouterId String required Example: tr-7qthudw0ll6jmc****
The ID of the Transit Router (TR) instance. You can call the DescribeTransitRouters API to obtain the TR instance 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.
VpcId String optional Example: vpc-bp1aevy8sofi8mh1****
TransitRouterAttachmentIds.N String optional Example: tr-attach-13n2l4c****
The ID of the network instance attachment.
- N represents the sequence number of a network instance attachment, ranging from 1 to 100.
- Separate multiple attachment IDs with ampersands (&).
TagFilters.N.Key String optional Example: k1
The tag key of the network instance attachment.
- N represents the sequence number of a tag key, ranging from 1 to 10. Separate multiple tag keys with ampersands (&).
- Specifying multiple tag keys means querying the network instance attachments that contain all specified tag keys.
TagFilters.N.Values.N String optional Example: v1
The tag value of the network instance attachment.
- The first N represents the sequence number of a tag key, ranging from 1 to 10.
- The second N represents the sequence number of a tag value, ranging from 1 to 3. The relationship between multiple tag values for the same tag key is a logical "OR". That is, the query returns resources tagged with any one of the specified values for that key.
- Separate multiple tags with ampersands (&).
- To provide this parameter, you must first provide TagFilters.N.Key.
- When an empty value is set for this parameter, it means querying resources where the tag value is empty under the specified tag key.
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: 1
The current page number.
TotalCount Integer Example: 2
The total number of qualified VPC attachments.
TransitRouterAttachments Object[] Example: --
The details of qualified VPC attachments.
Ipv6Enabled Boolean Example: false
Describe whether to enable IPv6.
- true: Yes.
- false: No.
CreationTime String Example: 2021-04-09T08:36:47+08:00
The time when the network instance attachment is created.
Description String Example: This attachment is used for test.
The description of the network instance attachment.
Status String Example: Available
The status of the network instance attachment.
- Creating
- Deleting
- Pending: Configuration in progress.
- Available
TransitRouterAttachmentId String Example: tr-attach-13n2l4c****
The ID of the network instance attachment.
TransitRouterAttachmentName String Example: trattachment-01
The name of the network instance attachment.
TransitRouterId String Example: tr-3tehy13n2l4c6c0v****
The ID of the Transit Router (TR) instance.
VpcId String Example: vpc-1i5i8khf9m58gae5kcx6****
The ID of the VPC instance.
AutoPublishRouteEnabled Boolean Example: true
Describe whether to automatically publish TR routes to the route table of the network instance.
- true: Yes.
- false: No.
UpdateTime String Example: 2021-04-10T09:18:28+08:00
The time when the network instance attachment is last modified.
AttachPoints Object[] Example: -
The details of attachment points associated with the qualified network instance attachments.
SubnetId String Example: subnet-1i5i8khf9m58gae5kcx6****
The subnet ID of the attachment point.
NetworkInterfaceId String Example: eni-3tehy13n2l4c6c0v****
The network interface ID of the attachment point.
ZoneId String Example: cn-guangzhou-a
The availability zone ID of the attachment point.
Tags Object[] Example: -
The tag information of the network instance attachment.
Key String Example: k1
The tag key.
Value String Example: v1
The tag value.
Bandwidth Integer Example: 10
The maximum bandwidth for the network instance attachment, measured in Gbps.
Request examples
GET /?Action=DescribeTransitRouterVpcAttachments&Version=2020-04-01&TransitRouterId=tr-7qthudw0ll6jmc**** HTTP/1.1
Host: transitrouter.cn-beijing.volcengineapi.com
X-Date: 20250804T033804Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20250804/cn-beijing/transitrouter/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f
Response examples
{
"ResponseMetadata": {
"RequestId": "2025080411380721704123209707BA78",
"Action": "DescribeTransitRouterVpcAttachments",
"Version": "2020-04-01",
"Service": "transitrouter",
"Region": "cn-beijing"
},
"Result": {
"PageSize": 20,
"PageNumber": 1,
"TotalCount": 2,
"TransitRouterAttachments": [
{
"Ipv6Enabled": true,
"CreationTime": "2021-04-09T08:36:47+08:00",
"Description": "This attachment is used for test.",
"Status": "Available",
"TransitRouterAttachmentId": "tr-attach-13n2l4c****",
"TransitRouterAttachmentName": "trattachment-01",
"TransitRouterId": "tr-3tehy13n2l4c6c0v****",
"VpcId": "vpc-1i5i8khf9m58gae5kcx6****",
"AutoPublishRouteEnabled": true,
"UpdateTime": "2021-04-10T09:18:28+08:00",
"AttachPoints": [
{
"SubnetId": "subnet-1i5i8khf9m58gae5kcx6****",
"NetworkInterfaceId": "eni-3tehy13n2l4c6c0v****",
"ZoneId": "cn-guangzhou-a"
}
],
"Tags": [
{
"Key": "k1",
"Value": "v1"
}
]
}
]
}
}
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.
Last updated: 2026.03.11 11:24:56
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
