Querying the Virtual Gateway List¶

Function¶

This API is used to query the virtual gateway list.

URI¶

GET /v2.0/dcaas/virtual-gateways

Request¶

Table 1 lists the request parameter.

**Table 1** Request parameter¶
Parameter	Type	Mandatory	Description
fields	String	No	Specifies the parameters expected to be returned. If you do not specify it, all parameters will be returned.

Response¶

Table 2 lists the response parameter.

**Table 2** Response parameter¶
Parameter	Type	Description
virtual_gateways	List	Specifies the virtual gateway list.

For details about the virtual_gateway field, see Table 1.

Examples¶

Example request

Querying all virtual gateways

GET /v2.0/dcaas/virtual-gateways

Querying a virtual gateway by ID

GET /v2.0/dcaas/virtual-gateways?id=7ec892f3-ca64-46c7-863f-a2eb1b9e8389

Example response

{
    "virtual_gateways" : [{
            "id": "0a0888a6-4096-43a6-81c6-923912933451",
            "name": "virtual gateway",
            "description": null,
            "tenant_id": "0605768a3300d5762f82c01180692873",
            "vpc_id": "5352423b-b4ff-4a9e-839d-02698c2b36af",
            "local_ep_group_id": "f8834cf1-5468-87c7-223d-56e78b9699ab",
            "local_ep_group_ipv6_id": null,
            "device_id": "aaa_01",
            "redundant_device_id": null,
            "type": "default",
            "ipsec_bandwidth": 1,
            "status": "PENDING_CREATE",
            "admin_state_up": true,
            "bgp_asn": 64512,
            "region_id": null
    }]
}

Status Codes¶

For details, see Common Status Codes.

last updated: 2024-05-03 00:46