- What's New
- Function Overview
- Service Overview
- Billing
- Getting Started
-
User Guide
- Permissions Management
- Enterprise Routers
- Attachments
- Route Tables
- Associations
- Propagations
- Routes
-
Routing Control
-
Route Policies
- Route Policy Overview
- Creating a Route Policy
- Associating a Route Policy with an Enterprise Router
- Changing the Route Policy Associated with an Enterprise Router
- Disassociating a Route Policy from an Enterprise Router
- Modifying a Route Policy
- Viewing a Route Policy
- Deleting a Route Policy
- Adding a Policy Node to a Route Policy
- Modifying a Policy Node in a Route Policy
- Exporting Policy Nodes in a Route Policy
- Viewing a Policy Node in a Route Policy
- Deleting a Policy Node from a Route Policy
-
IP Prefix Lists
- IP Prefix List Overview
- Creating an IP Prefix List
- Modifying the Name of an IP Prefix List
- Viewing an IP Prefix List
- Deleting an IP Prefix List
- Adding a Prefix Rule to an IP Address Prefix List
- Modifying an IP Prefix Rule in an IP Prefix List
- Exporting Prefix Rules in an IP Prefix List
- Viewing a Prefix Rule in an IP Prefix List
- Deleting a Prefix Rule from an IP Prefix List
-
AS_Path Lists
- AS_Path List Overview
- Creating an AS_Path List
- Modifying the Name of an AS_Path List
- Viewing an AS_Path List
- Deleting an AS_Path List
- Adding an AS_Path Filter to an AS_Path List
- Exporting AS_Path Filters in an AS_Path List
- Viewing an AS_Path Filter in an AS_Path List
- Deleting an AS_Path Filter from an AS_Path List
-
Route Policies
- Sharing
- Flow Logs
- Monitoring and Auditing
- Tags
- Quotas
-
Best Practices
- Summary on Enterprise Router Best Practices
- Connecting VPCs Across Regions Using Enterprise Router and Central Network
- Using Enterprise Router to Isolate VPCs in the Same Region
- Using a Third-Party Firewall to Protect VPCs Connected by Enterprise Routers
- Enabling an On-Premises Data Center to Access Service VPCs Using an Enterprise Router and Transit VPC
- Setting Up a Hybrid Cloud Network Using Enterprise Router and Direct Connect Global DC Gateway
-
Setting Up a Hybrid Cloud Network Using Enterprise Router and a Pair of Direct Connect Connections (Global DC Gateway)
- Overview
- Network and Resource Planning
- Process of Setting Up a Hybrid Cloud Network Using Enterprise Router and a Pair of Direct Connect Connections (Global DC Gateway)
- Procedure for Setting Up a Hybrid Cloud Network Using Enterprise Router and a Pair of Direct Connect Connections (Global DC Gateway)
-
Setting Up a Hybrid Cloud Network Using Enterprise Router and a Pair of Active/Standby Direct Connect Connections (Global DC Gateway)
- Overview
- Network and Resource Planning
- Process of Setting Up a Hybrid Cloud Network Using Enterprise Router and a Pair of Active/Standby Direct Connect Connections (Global DC Gateway)
- Procedure for Setting Up a Hybrid Cloud Network Using Enterprise Router and a Pair of Active/Standby Direct Connect Connections (Global DC Gateway)
- Setting Up a Hybrid Cloud Network Using Enterprise Router, VPN, and Direct Connect (Global DC Gateway)
- Setting Up a Hybrid Cloud Network Using Enterprise Router and Direct Connect (Virtual Gateway)
- Setting Up a Hybrid Cloud Network Using Enterprise Router and a Pair of Direct Connect Connections (Virtual Gateway)
- Setting Up a Hybrid Cloud Network Using Enterprise Router, VPN, and Direct Connect (Virtual Gateway)
- Allowing VPCs to Share an EIP to Access the Internet Using Enterprise Router and NAT Gateway
- Using Enterprise Router to Migrate the Network Set Up Through VPC Peering
- Using Enterprise Router to Migrate the Network Set Up Through Direct Connect (Global DC Gateway)
- Using Enterprise Router and Central Network to Migrate the Network Set Up Through a Cloud Connection
- API Reference
- FAQs
-
More Documents
-
User Guide (ME-Abu Dhabi Region)
- Service Overview
- Getting Started
- Enterprise Routers
- Attachments
- Route Tables
- Associations
- Propagations
- Routes
- Sharing
- Flow Logs
- Monitoring
- Interconnecting with CTS
- Permissions Management
- Tags
- Quotas
- FAQ
- Change History
-
User Guide (Ankara Region)
- Service Overview
- Getting Started
- Permissions Management
- Enterprise Routers
- Attachments
- Route Tables
- Associations
- Propagations
- Routes
- Sharing
- Flow Logs
- Monitoring
- Quotas
- FAQ
- Change History
- API Reference (Ankara Region)
-
User Guide (ME-Abu Dhabi Region)
- General Reference
Copied.
Querying VPC Attachments
Function
This API is used to query the VPC attachments of the enterprise router.
Constraints
There are some constraints:
-
Filtering query is supported. The supported query criteria include id, state, enterprise_project_id, and vpc_id. You can query multiple resources at a time or use combined criteria to query resources.
-
Pagination query is supported. You can use limit and marker together for pagination query.
-
Only sorting by a single field (id, name, description, created_at, or updated_at) is supported.
Calling Method
For details, see Calling APIs.
URI
GET /v3/{project_id}/enterprise-router/{er_id}/vpc-attachments
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID |
er_id |
Yes |
String |
Enterprise router ID |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
limit |
No |
Integer |
Number of records on each page. Value range: 0 to 2000 Minimum: 0 Maximum: 2000 |
marker |
No |
String |
ID of the last enterprise router on the previous page. If this parameter is left blank, the first page is queried. This parameter must be used together with limit. Minimum: 1 Maximum: 128 |
state |
No |
Array of strings |
Attachment status. Value options: pending, available, modifying, deleting, deleted, failed, pending_acceptance, rejected, and initiating_request |
id |
No |
Array of strings |
Query by resource ID. Multiple resources can be queried at a time. |
sort_key |
No |
Array of strings |
Keyword for sorting. The keyword can be id, name, or state. By default, id is used. |
sort_dir |
No |
Array of strings |
Sorting order. There are two value options: asc (ascending order) and desc (descending order). The default value is asc. |
vpc_id |
No |
Array of strings |
VPC id |
Request Parameters
None
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
vpc_attachments |
Array of VpcAttachmentDetails objects |
VPC attachments |
page_info |
PageInfo object |
Pagination query information |
request_id |
String |
Request ID |
Parameter |
Type |
Description |
---|---|---|
id |
String |
VPC attachment ID |
name |
String |
VPC attachment name |
vpc_id |
String |
VPC id |
virsubnet_id |
String |
VPC subnet ID |
auto_create_vpc_routes |
Boolean |
The default value is false. If this parameter is set to true, routes with this enterprise router as the next hop and 10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16 as the destinations will be automatically added to the route tables of the VPC. Default: false |
state |
String |
VPC attachment status. The value can be pending, available, modifying, deleting, deleted, failed, initiating_request, rejected, pending_acceptance, freezed, or invalid. |
created_at |
String |
Creation time in the format of YYYY-MM-DDTHH:mm:ss.sssZ |
updated_at |
String |
Update time in the format of YYYY-MM-DDTHH:MM:SS |
tags |
Array of Tag objects |
Tag information |
description |
String |
Description of the VPC attachment |
project_id |
String |
Project ID |
vpc_project_id |
String |
ID of the project that the VPC belongs to |
route_synchronization |
RouteSynchronization object |
Route synchronization setting. |
Parameter |
Type |
Description |
---|---|---|
key |
String |
Tag key.
Minimum: 1 Maximum: 128 |
value |
String |
Tag value.
Minimum: 0 Maximum: 255 |
Parameter |
Type |
Description |
---|---|---|
route_synchronization_enable |
Boolean |
Whether to enable route synchronization. |
vpc_route_table_type |
String |
VPC route table where routes are to be synchronized. |
route_type |
String |
Type of the route to be synchronized. |
conflict_policy |
String |
A conflict policy that specifies whether to synchronize routes with the same destination and next hop to the VPC route table. |
Example Requests
-
Querying all VPC attachments in pagination
GET https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/vpc-attachments?limit=10
-
Querying all VPC attachments
GET https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/vpc-attachments
Example Responses
Status code: 200
OK
{ "vpc_attachments" : [ { "id" : "6f83b848-8331-4271-ac0c-ef94b7686402", "name" : "vpc-attach-01", "vpc_id" : "b715e131-3371-4e17-a2de-4f669e24439a", "virsubnet_id" : "aacdc21d-90f9-45ef-ab48-80ec1bbe15b8", "project_id" : "08d5a9564a704afda6039ae2babbef3c", "state" : "available", "created_at" : "2020-03-11T15:13:31Z", "updated_at" : "2020-03-11T15:13:31Z" }, { "id" : "6f83b848-8331-4271-ac0c-ef94b7686402", "name" : "vpc-attach-01", "vpc_id" : "4b8567f6-358f-4a7f-8cd3-3cbb82c0b25f", "virsubnet_id" : "2b55f334-a15e-43a9-ab11-b34c2dbb6fac", "project_id" : "08d5a9564a704afda6039ae2babbef3c", "state" : "available", "created_at" : "2020-03-11T15:13:31Z", "updated_at" : "2020-03-11T15:13:31Z" } ], "page_info" : { "next_marker" : "1", "current_count" : 2 }, "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9" }
Status Codes
Status Code |
Description |
---|---|
200 |
OK |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot