DescribeVpnGateways

GET /?Action=DescribeVpnGateways
Description

Describes one or more virtual private gateways.
You can use the Filter.N parameter to filter the virtual private gateways on the following properties:

  • attachment.state: The current attachment state between the gateway and the VPC (attaching | attached | detaching | detached).

  • attachment.vpc-id: The ID of the VPC the virtual private gateway is attached to.

  • state: The state of the virtual private gateway (pending | available | deleting | deleted).

  • tag-key: The key of a tag associated with the resource.

  • tag-value: The value of a tag associated with the resource.

  • tag:XXXX: The value of a tag associated with the resource, where XXXX is the key of the tag.

  • type: The type of virtual private gateway (only ipsec.1 is supported).

  • vpn-gateway-id: The ID of the virtual private gateway.

Note

If you exceed the number of identical requests allowed for a configured time period, the RequestLimitExceeded error message is returned.
Body parameter

Required: false
Name: DescribeVpnGatewaysRequest

Name Description Required Schema Default Example

DryRun

If set to true, checks whether you have the required permissions to perform the action.

false

boolean

Filter.N

One or more filters. Example:
osc-cli fcu DescribeVpnGateways \
  --Filter.1.Name "tag:KEYOFTHETAG" \
  --Filter.1.Value.1 "VALUEOFTHETAG"

false

Filter

VpnGatewayId.N

One or more virtual private gateways.

false

string
Responses
HTTP Code 200
HTTP Code Description Schema

200

DescribeVpnGatewaysResult

Response 200

Response 200

Name Description Required Schema Default Example

requestId

The ID of the request.

false

string

vpnGatewaySet.N

Information about one or more virtual private gateways.

false

VpnGateway