- What's New
- Function Overview
- Product Bulletin
- Service Overview
- Billing
- Getting Started
- User Guide
-
Best Practices
- Direct Connect Best Practices
- Connecting an On-Premises Data Center to a VPC over a Single Connection and Using Static Routing to Route Traffic
- Connecting an On-Premises Data Center to a VPC over a Single Connection and Using BGP Routing to Route Traffic
- Connecting an On-Premises Data Center to a VPC over Two Connections in Load Balancing Mode (Virtual Gateway)
- Connecting an On-Premises Data Center to a VPC over Two Connections in an Active/Standby Pair (Virtual Gateway)
- Connecting an On-Premises Data Center to Multiple VPCs that Do Not Need to Communicate with Each Other
- Connecting an On-Premises Data Center to Multiple VPCs in the Same Region Using Direct Connect and VPC Peering
- Using a Public NAT Gateway and Direct Connect to Accelerate Internet Access
- Allowing On-Premises Servers to Access Cloud Services Using Direct Connect and VPC Endpoint
-
API Reference
- Before You Start
- API Overview
- Calling APIs
-
API
- Connections
- Virtual Gateways
-
Virtual Interfaces
- Creating a Virtual Interface
- Querying the Virtual Interface List
- Querying Details About a Virtual Interface
- Updating a Virtual Interface
- Deleting a Virtual Interface
- Creating a Virtual Interface Peer
- Updating a Virtual Interface Peer
- Deleting a Virtual Interface Peer
- Performing a Virtual Interface Switchover Test
- Querying the List of Virtual Interface Switchover Test Records
- Tag Management
- Quota Management
- Global DC Gateways
- Peer Links
- Connect Gateways
- Global EIPs
- Global DC Gateway Route Tables
- Public Parameters
- Appendix
- SDK Reference
- Troubleshooting
-
FAQs
-
Popular Questions
- What Are the Network Requirements for Connections?
- What Locations Are Available for Direct Connect?
- How Do I Select a Carrier When Purchasing a Connection?
- How Will I Be Billed for Direct Connect?
- How Do I Submit a Service Ticket?
- How Do I Test the Network Connectivity Between a Location and the Cloud?
- What Do I Do If I Select the Wrong Carrier When Creating a Connection?
-
Product Consultation
- What Are the Network Requirements for Connections?
- What Are 1GE and 10GE?
- What Locations Are Available for Direct Connect?
- Is BGP Routing Supported in Direct Connect?
- What Is Full-Service Installation Statement?
- How Do I Submit a Service Ticket?
- What Are the Network Latency and Packet Loss Rate of a Connection?
- Are the Uplink and Downlink Bandwidths of a Direct Connect Connection the Same?
- What Do I Do If I Select the Wrong Carrier When Creating a Connection?
- How Do I Plan the VPCs for a New Connection?
- What Are Local and Remote Gateways (Interconnection IP Addresses)?
- How Do I Configure BFD for a Connection?
- Leased Line
-
Interconnection with the Cloud
- Can I Access the Same VPC over Multiple Connections?
- How Do I Plan the CIDR Blocks for a Connection?
- What Should I Consider When I Use Direct Connect to Access the Cloud?
- Does Direct Connect Support NAT?
- Can the VLAN of the On-premises Network Be Used in the VPC Through Direct Connect?
- Can My On-Premises Data Center Access Multiple VPCs Through One Connection?
- Can Direct Connect Be Used with Similar Services of Other Cloud Service Providers?
-
Networking and Scenarios
- Can Multiple Connections Access the Same VPC?
- Can My On-Premises Data Center Access Multiple VPCs Through One Connection?
- Can Direct Connect Be Used with Similar Services of Other Cloud Service Providers?
- Can I Limit the Bandwidth Available on Each Hosted Connection?
- How Do I Plan the VPCs for a New Connection?
-
Related Console Operations
- How Do I Submit a Service Ticket?
- How Can I Unsubscribe from Direct Connect?
- What Parameters Can Be Modified After I Have Created a Virtual Interface?
- Do I Need to Delete the Virtual Gateway and Virtual Interface Before Deleting a Hosted Connection?
- How Do I Change the Routing Mode of a Connection?
- How Do I Delete a Hosted Connection?
- What Is the BGP ASN Used by Huawei Cloud?
- What Are Local and Remote Gateways (Interconnection IP Addresses)?
- Troubleshooting
- Billing
- Resource Monitoring
- Quota
-
Popular Questions
-
More Documents
- User Guide (ME-Abu Dhabi Region)
- User Guide (Paris Region)
- eu-west-0-api
- User Guide (Kuala Lumpur Region)
-
API Reference (Kuala Lumpur Region)
- Before You Start
- API Overview
- Calling APIs
- API Usage
-
API
- Connection
- Virtual Gateway
-
Virtual Interface
- Querying Details About a Virtual Interface
- Updating a Virtual Interface
- Deleting a Virtual Interface
- Querying the Virtual Interface List
- Creating a Virtual Interface
- Updating a Virtual Interface Peer
- Deleting a Virtual Interface Peer
- Creating a Virtual Interface Peer
- Performing a Virtual Interface Switchover Test
- Querying the Switchover Test Records of a Virtual Interface
- Tag management
- Quota Management
- Public Parameters
- Appendixes
- Change History
- General Reference
Copied.
Querying Virtual Gateways
Function
This API is used to query virtual gateways.
URI
GET /v3/{project_id}/dcaas/virtual-gateways
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Specifies the project ID. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
limit |
No |
Integer |
Specifies the number of records returned on each page. Value range: 1 to 2000 Minimum: 1 Maximum: 2000 Default: 2000 |
marker |
No |
String |
Specifies the ID of the last resource record on the previous page. If this parameter is left blank, the first page is queried. This parameter must be used together with limit. Minimum: 0 Maximum: 36 |
fields |
No |
Array |
Specifies the list of fields to be displayed. Array Length: 1 - 5 |
sort_dir |
No |
Array |
Specifies the sorting order of returned results, which can be asc (ascending order) or desc (descending order). The default value is asc. |
sort_key |
No |
String |
Specifies the sorting field. Default: id Minimum: 0 Maximum: 36 |
id |
No |
Array |
Specifies the resource ID by which instances are filtered. Array Length: 1 - 5 |
enterprise_project_id |
No |
Array |
Filters resource instances by enterprise project ID. Array Length: 1 - 10 |
vpc_id |
No |
Array |
Specifies the VPC ID by which virtual gateways are filtered. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Specifies the user token. To obtain the token, see section "Obtaining the User Token" in the Identity and Access Management API Reference. The token is the value of X-Subject-Token in the response header. Minimum: 0 Maximum: 10240 |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
request_id |
String |
Specifies the request ID. |
virtual_gateways |
Array of VirtualGateway objects |
Specifies parameters for creating a virtual gateway. |
page_info |
PageInfo object |
Specifies the pagination query information. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Specifies the virtual gateway ID. |
vpc_id |
String |
Specifies the ID of the VPC connected by the virtual gateway. |
tenant_id |
String |
Specifies the ID of the project that the instance belongs to. Minimum: 32 Maximum: 32 |
name |
String |
Specifies the virtual gateway name. Minimum: 0 Maximum: 64 |
description |
String |
Provides supplementary information about the virtual gateway. Minimum: 0 Maximum: 128 |
type |
String |
Specifies the virtual gateway type. The value can only be default. Default: default |
local_ep_group |
Array of strings |
Specifies the IPv4 subnets connected by the virtual gateway, which is usually the CIDR blocks of a VPC. |
local_ep_group_ipv6 |
Array of strings |
Specifies the IPv6 subnets connected by the virtual gateway, which is usually the CIDR blocks of a VPC. This is a reserved field. |
admin_state_up |
Boolean |
Specifies the administrative status, which can be true or false. Default: true |
status |
String |
Specifies the virtual gateway status, which can be ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE, or PENDING_DELETE. |
bgp_asn |
Integer |
Specifies the local BGP ASN of the virtual gateway. Minimum: 1 Maximum: 4294967295 |
enterprise_project_id |
String |
Specifies the ID of the enterprise project that the virtual gateway belongs to. Minimum: 36 Maximum: 36 |
device_id |
String |
Specifies the ID of the device that the virtual interface belongs to. |
redundant_device_id |
String |
Specifies the ID of the redundant device. |
public_border_group |
String |
Specifies the public border group of the AZ, indicating whether the site is a HomeZones site. |
Parameter |
Type |
Description |
---|---|---|
previous_marker |
String |
Specifies the marker of the previous page. The value is the resource UUID. Minimum: 0 Maximum: 36 |
current_count |
Integer |
Specifies the number of resources in the current list. Minimum: 0 Maximum: 2000 |
next_marker |
String |
Specifies the marker of the next page. The value is the resource UUID. If the value is empty, the resource is on the last page. Minimum: 0 Maximum: 36 |
Example Requests
Querying the virtual gateway list
GET https://{dc_endpoint}/v3/0605768a3300d5762f82c01180692873/dcaas/virtual-gateways
Example Responses
Status code: 200
OK
- The list of virtual gateways associated with VPCs is queried.
{ "virtual_gateways" : [ { "id" : "20082c1b-3c99-48d8-8e8c-116af5d7e9f0", "name" : "vgw-c7b22", "description" : "", "tenant_id" : "0605768a3300d5762f82c01180692873", "vpc_id" : "6592c28e-95d7-4b0a-9f61-004fdf03420c", "device_id" : "26.151.63.100", "redundant_device_id" : "26.152.128.20", "type" : "default", "status" : "ACTIVE", "admin_state_up" : true, "bgp_asn" : 64512, "local_ep_group" : [ "192.168.1.0/24" ], "enterprise_project_id" : "0", "public_border_group" : "center" } ], "request_id" : "765f7aaf8f2edd0e719de564ef72e2de" }
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