Transit Router
Transit Router
Document
- Documentation
Transit RouterAPI referenceInter-region attachmentDescribeTransitRouterPeerAttachments - Listing inter-region attachments
Copy page
Download PDFInter-region attachment
DescribeTransitRouterPeerAttachments - Listing inter-region attachments
Copy pageDownload PDFDescribeTransitRouterPeerAttachments - Listing inter-region attachments
Call DescribeTransitRouterPeerAttachments to query inter-region attachments 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.
Request parameters
The following only details request parameters specific to this API and key common parameters. For more information, see Common parameters.
Action String requiredExample: DescribeTransitRouterPeerAttachments
The interface name. The current API name is DescribeTransitRouterPeerAttachments.
Version String required Example: 2020-04-01
The interface version. The current API version is 2020-04-01.
PageSize Integer optional Example: 20
The number of entries on each page in a pagination query. Valid values: 1–100. Default: 20.
PageNumber Integer optional Example: 1
The page number of the list. Default: 1.
TransitRouterId String optional Example: tr-7qthudw0ll6jmc****
The ID of the local TR instance associated with the inter-region attachment.
TransitRouterAttachmentName String optional Example: tr-attachment
The name of the inter-region attachment.
TransitRouterAttachmentIds.N String optional Example: tr-attach-7qthudw0ll6jmc****
The ID of the inter-region attachment.
- N represents the sequence number of an inter-region attachments, ranging from 1 to 100.
- Separate multiple inter-region attachment IDs with ampersands (&).
PeerTransitRouterId String optional Example: tr-q3wuhuumlho9r****
The ID of the peer TR instance. You can call DescribeTransitRouters to obtain the ID of the TR instance.
PeerTransitRouterRegionId String optional Example: cn-beijing
TagFilters.N.Key String optional Example: k1
The tag key of the inter-region 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 inter-region attachments that contain all specified tag keys.
TagFilters.N.Values.N String optional Example: v1
The tag value of the inter-region 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 (&).
tip
- 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
Only the response parameters specific to this API are listed below. For more information, see Response structure.
PageSize Integer Example: 20
The 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 inter-region attachments matching the specified conditions.
TransitRouterAttachments Object[] Example: -
The details of the inter-region attachment.
TransitRouterAttachmentId String Example: tr-attach-abb******
The ID of the inter-region attachment.
TransitRouterAttachmentName String Example: trattachment-01
The name of the inter-region attachment.
Description String Example: This attachment is used for test.
The description of the inter-region attachment.
TransitRouterRouteTableId String Example: tr-rtb-123567****
The route table associated with forwarding for the inter-region attachment.
PeerTransitRouterId String Example: tr-3tex2x1cwd4c6c0v****
The ID of the peer TR instance.
PeerTransitRouterRegionId String Example: cn-beijing
The ID of the region where the peer TR instance belongs.
TransitRouterBandwidthPackageId String Example: tr-bp-1234****
The ID of the TR bandwidth package associated with the inter-region attachment.
TransitRouterForwardPolicyTableId String Example: tr-fpt-hy13n2l4c6c0v****
The ID of the forwarding policy associated with the inter-region attachment.
Bandwidth Integer Example: 10
The bandwidth of the inter-region attachment, measured in Mbps.
Tags Object[] Example: -
Tag information of the inter-region attachment.
Key String Example: k1
The tag key.
Value String Example: v1
The tag value.
TransitRouterTrafficQosMarkingPolicyId String Example: tr-tmp-hy13n2l4c6c0v****
The ID of the traffic marking policy associated with the inter-region attachment.
TransitRouterTrafficQosQueuePolicyId String Example: tr-tqp-hy13n2l4c6c0v****
The ID of the traffic queue policy associated with the inter-region attachment.
TransitRouterId String Example: tr-1aaaaaaa***
The ID of the Transit Router (TR) instance.
Ipv6Enabled Boolean Example: false
Describe whether IPv6 is enabled.
- true: Yes.
- false: No.
AutoPublishRouteEnabled Boolean Example: false
Describe whether auto-publishing of TR routes to the network instance's route table is enabled.
- true: Yes.
- false: No.
Status String Example: Available
The status of the inter-region attachment.
- Creating
- Deleting
- Pending: Configuration in progress.
- Available
UpdateTime String Example: 2023-08-14T18:05:17+08:00
The time when the inter-region attachment is last modified.
CreationTime String Example: 2023-08-14T18:05:17+08:00
The time when the inter-region attachment is created.
Line Operator String Example: China Unicom
The provider of the cross-border bandwidth package.
- ChinaUnicom: China Unicom.
- ChinaTelecom: China Telecom.
BandwidthType String Example: BandwidthPackage
The bandwidth allocation method for the inter-region peering attachment.
- BandwidthPackage: Bandwidth is allocated from a bandwidth package.
- CloudDataTransfer: Bill by traffic via Cloud Data Transfer.
PeerTransitRouterOwnerId String Example: 2100****63
The ID of the account that owns the peer TR instance.
TransitRouterBandwidthPackageOwnerId String Example: 20122****49
The ID of the account who owns the TR bandwidth package.
Request example
GET /?Action=DescribeTransitRouterPeerAttachments&Version=2020-04-01 HTTP/1.1
Host: transitrouter.cn-beijing.volcengineapi.com
X-Date: 20250804T034726Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20250804/cn-beijing/transitrouter/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f
Response example
{
"ResponseMetadata": {
"RequestId": "20230604110420****100232280022D31",
"Action": "DescribeTransitRouterPeerAttachments",
"Version": "2020-04-01",
"Service": "transitrouter",
"Region": "cn-beijing"
},
"Result": {
"PageNumber": 1,
"PageSize": 20,
"TotalCount": 2,
"TransitRouterAttachments": [
{
"Tags": [
{
"Key": "k1",
"Value": "v1"
}
],
"Status": "Available",
"Bandwidth": 10,
"UpdateTime": "2023-08-14T18:05:17+08:00",
"Description": "This attachment is used for test.",
"Ipv6Enabled": true,
"CreationTime": "2023-08-14T18:05:17+08:00",
"LineOperator": "ChinaUnicom",
"BandwidthType": "BandwidthPackage",
"TransitRouterId": "tr-1aaaaaaa***",
"PeerTransitRouterId": "tr-3tex2x1cwd4c6c0v****",
"AutoPublishRouteEnabled": true,
"PeerTransitRouterOwnerId": "2100****63",
"PeerTransitRouterRegionId": "cn-beijing",
"TransitRouterAttachmentId": "tr-attach-abb******",
"TransitRouterRouteTableId": "tr-rtb-123567****",
"TransitRouterAttachmentName": "trattachment-01",
"TransitRouterBandwidthPackageId": "tr-bp-1234****",
"TransitRouterForwardPolicyTableId": "tr-fpt-hy13n2l4c6c0v****",
"TransitRouterBandwidthPackageOwnerId": "20122****49",
"TransitRouterTrafficQosQueuePolicyId": "tr-tqp-hy13n2l4c6c0v****",
"TransitRouterTrafficQosMarkingPolicyId": "tr-tmp-hy13n2l4c6c0v****"
}
]
}
}
Error codes
The following table lists the error codes related to the business logic for this API. For details, see Common error codes.
Last updated: 2026.05.28 14:56:13
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
