Transit Router
Transit Router
Document
- Documentation
Transit RouterAPI referenceAPI overview
Copy page
Download PDFAPI reference
API overview
Copy pageDownload PDFAPI overview
This topic introduces the API actions available for Transit Router (TR).
TR instances
API | Description |
Create an instance. | |
Delete an instance. | |
Query TR attachments that meet specified conditions, including VPC, VPN, DC Gateway attachments, and Inter-region attachments. | |
Query TR instances that meet specified conditions. | |
Modify the name or description of the TR instance. |
Instance sharing
API | Description |
Create instance sharing to share a specified TR instance with another account. | |
Query instance sharing that meets specified conditions. | |
Modify the description of the instance sharing. | |
Accept the TR instance shared by other accounts to this account. | |
Reject TR instances shared with your account by other accounts. | |
Delete instance sharing. |
VPC attachment
API | Description |
Creates a VPC attachment. | |
Deletes a specified VPC attachment. | |
Query VPC attachments that meet specified conditions. | |
Modify the name, description, or attachment point of VPC attachments, enable or disable route synchronization. |
Virtual Private Network (VPN)-type attachment
API | Description |
Create a Virtual Private Network (VPN) attachment. | |
Delete a VPN attachment. | |
Query VPN attachments that meet specified conditions. | |
Modify the name or description of the VPN attachment. |
DC gateway-type attachment
API | Description |
Create a Direct Connect (DC) Gateway attachment. | |
Delete a DC Gateway attachment. | |
Query DC Gateway attachments that meet specified conditions. | |
Modify the name or description of the DC Gateway attachment. |
TR bandwidth packages
API | Description |
Create a bandwidth package. | |
Modifies the bandwidth of a specified TR bandwidth package. | |
Delete a bandwidth package. | |
Query TR bandwidth packages that meet specified conditions. | |
Query the geographic region sets and regions supported for the current account. | |
Query the billing information about a bandwidth package. | |
Renew a bandwidth package. | |
Set renewal type for a bandwidth package. |
Inter-region attachment
API | Description |
Creates an inter-region peering attachment. | |
Modify the name, description, bandwidth, and the associated bandwidth package of the Inter-region attachment. | |
Delete an Inter-region attachment. | |
Query inter-region attachments that meet specified conditions. |
Route tables
API | Description |
Create a custom route table. | |
Delete a custom route table. | |
Query TR route tables that meet specified conditions. | |
Modify the name or description of the route table. |
Route entry
API | Description |
Add static route entries to a specified TR route table. | |
Delete a static route entry. | |
Query static route entries that meet specified conditions. | |
Modifies the name or description of a route entry. |
Association forwarding
API | Description |
Attach a route table for TR attachments (including VPC, VPN, DC Gateway network instance attachments and Inter-region attachments). | |
Query the route table attached to the TR attachment. | |
Detach the route table from the TR attachment. | |
Modify the route table associated with TR attachments. |
Route learning
API | Description |
Query route learning that meets specified conditions. | |
Delete route learning. | |
Create a route learning rule. |
Routing policy
API | Description |
Create a route policy (excluding route policy entries). | |
Add a route policy entry. | |
Query route policy entries that meet specified conditions. | |
Query route policies that meets the specified condition. | |
Modify a route policy entry. | |
Modifies the attachment relationship of a route policy. | |
Modify the name or description of the route policy. | |
Associate the route policy to the TR route table. | |
Delete a route policy. | |
Deleting a route policy entry. | |
Disassociate the route policy from the TR route table. |
Forwarding policy
API | Description |
Create a forwarding policy (excluding forwarding policy entries). | |
Add a forwarding policy entries to the forwarding policy. | |
Query forwarding policy entries that meet specified conditions. | |
Query the forwarding policy that meets specified conditions. | |
Modify forwarding policy entries. | |
Modify the attachment relationship of the forwarding policy. | |
Modify the name or description of the forwarding policy. | |
Associate the forwarding policy with the TR attachment (including VPC, VPN, DC Gateway network instance attachments, and Inter-region attachment). | |
Delete a forwarding policy entry. | |
Delete a forwarding policy. | |
Disassociate the forwarding policy from the TR attachment. |
Traffic marking policy
tip
The Traffic marking policy is in Beta. If you need to call the following interface, please contact the account manager.
API | Description |
Create a Traffic marking policy. | |
Delete Traffic marking policy. | |
Modify the name or description of the Traffic marking policy. | |
Query Traffic marking policy that meets specified conditions. | |
Add marking rules to a Traffic marking policy. | |
Delete the marking rules in the Traffic marking policy. | |
Query the marking rules that meet the specified condition in the Traffic marking policy. | |
Enable the Traffic marking feature for the TR attachment. | |
Disable the stream tagging feature for the TR attachment. | |
Modify the Traffic marking policy associated with the TR attachment. |
Traffic queue policy
tip
The Traffic queue policy is in Beta; if you need to call the following interface, please contact your account manager.
API | Description |
Create Traffic queue policy. | |
Delete the Traffic queue policy. | |
Modify the name or description of the Traffic queue policy. | |
Query the traffic queue policies that meets specified conditions. | |
Add queues to the Traffic queue policy. | |
Delete the queue in the Traffic queue policy. | |
Query queues in the Traffic queue policy that meet the specified condition. | |
Enable the flow queue feature for TR attachments. | |
Disable the flow queue feature for a TR attachment. | |
Modify the Traffic queue policy attached to the TR attachment. |
Flow logs
API | Description |
Create a TR flow log. | |
Query the TR flow log list that meets the specified condition. | |
Modify the name, description, or collection cycle of the TR flow log. | |
Enable TR flow log. | |
Stop TR flow log. | |
Delete TR flow log. |
Multicast
tip
The multicast feature is in Beta. If you need to call the following interface, please contact your account manager.
API | Description |
Create a multicast domain. | |
Modify the name and description of the multicast domain. | |
Delete the multicast domain. | |
Query multicast domain lists that meet specified conditions. | |
Query the attachment information of the multicast domain that meets the specified conditions. | |
Attach the multicast domain to the specified subnet. | |
Detach the multicast domain from the specified subnet. | |
Query multicast sources and multicast members in the specified multicast domain. | |
Add multicast sources to the specified multicast domain. | |
Delete the specified multicast source. | |
Add multicast members to the specified multicast domain. | |
Delete the specified multicast member. |
Tag
API | Description |
Adds user tags to TR resources. | |
Deletes user tags from TR resources. | |
Query tags that meet specified criteria. |
Last updated: 2026.03.11 11:24:56
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
