Returns the status for the specified VPN gateway.
HTTP request
GET https://compute.googleapis.com/compute/v1/projects/{project}/regions/{region}/vpnGateways/{resourceId}/getStatus
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
project |
Project ID for this request. |
region |
Name of the region for this request. |
resourceId |
Name of the VPN gateway to return. |
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
JSON representation | |
---|---|
{ "result": { "vpnConnections": [ { "peerExternalGateway": string, "peerGcpGateway": string, "tunnels": [ { "localGatewayInterface": number, "peerGatewayInterface": number, "tunnelUrl": string } ], "state": { "state": enum, "unsatisfiedReason": enum } } ] } } |
Fields | |
---|---|
result |
|
result.vpnConnections[] |
globalOperations.list of VPN connection for this VpnGateway. |
result.vpnConnections[].peerExternalGateway |
URL reference to the peer external VPN gateways to which the VPN tunnels in this VPN connection are connected. This field is mutually exclusive with peerGcpGateway. |
result.vpnConnections[].peerGcpGateway |
URL reference to the peer side VPN gateways to which the VPN tunnels in this VPN connection are connected. This field is mutually exclusive with peerGcpGateway. |
result.vpnConnections[].tunnels[] |
globalOperations.list of VPN tunnels that are in this VPN connection. |
result.vpnConnections[].tunnels[].localGatewayInterface |
The VPN gateway interface this VPN tunnel is associated with. |
result.vpnConnections[].tunnels[].peerGatewayInterface |
The peer gateway interface this VPN tunnel is connected to, the peer gateway could either be an external VPN gateway or GCP VPN gateway. |
result.vpnConnections[].tunnels[].tunnelUrl |
URL reference to the VPN tunnel. |
result.vpnConnections[].state |
HighAvailabilityRequirementState for the VPN connection. |
result.vpnConnections[].state.state |
Indicates the high availability requirement state for the VPN connection. Valid values are |
result.vpnConnections[].state.unsatisfiedReason |
Indicates the reason why the VPN connection does not meet the high availability redundancy criteria/requirement. Valid values is |
Authorization Scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/compute
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
IAM Permissions
In addition to any permissions specified on the fields above, authorization requires one or more of the following Google IAM permissions:
compute.vpnGateways.get