Console
    Start free

    Method: vpnGateways.getStatus

    Returns the status for the specified VPN gateway.

    HTTP request


    GET https://compute.googleapis.com/compute/v1/projects/{project}/regions/{region}/vpnGateways/{vpnGateway}/getStatus

    The URLs use gRPC Transcoding syntax.

    Path parameters

    Parameters
    project

    string

    Project ID for this request.
    region

    string

    Name of the region for this request.
    vpnGateway

    string

    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" 
 : 
 integer 
 , 
 "peerGatewayInterface" 
 : 
 integer 
 , 
 "tunnelUrl" 
 : 
 string 
 } 
 ] 
 , 
 "state" 
 : 
 { 
 "state" 
 : 
 enum 
 , 
 "unsatisfiedReason" 
 : 
 enum 
 } 
 } 
 ] 
 } 
 }
    Fields
    result

    object

    result.vpnConnections[]

    object

    Output only. vpnGateways.list of VPN connection for this VpnGateway.
    result.vpnConnections[].peerExternalGateway

    string

    Output only. 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

    string

    Output only. 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[]

    object

    vpnGateways.list of VPN tunnels that are in this VPN connection.
    result.vpnConnections[].tunnels[].localGatewayInterface

    integer ( uint32 format)

    Output only. The VPN gateway interface this VPN tunnel is associated with.
    result.vpnConnections[].tunnels[].peerGatewayInterface

    integer ( uint32 format)

    Output only. The peer gateway interface this VPN tunnel is connected to, the peer gateway could either be an external VPN gateway or a Google Cloud VPN gateway.
    result.vpnConnections[].tunnels[].tunnelUrl

    string

    Output only. URL reference to the VPN tunnel.
    result.vpnConnections[].state

    object

    HighAvailabilityRequirementState for the VPN connection.
    result.vpnConnections[].state.state

    enum

    Indicates the high availability requirement state for the VPN connection. Valid values are CONNECTION_REDUNDANCY_MET , CONNECTION_REDUNDANCY_NOT_MET .
    result.vpnConnections[].state.unsatisfiedReason

    enum

    Indicates the reason why the VPN connection does not meet the high availability redundancy criteria/requirement. Valid values is INCOMPLETE_TUNNELS_COVERAGE .

    Authorization scopes

    Requires one of the following OAuth scopes:

    • https://www.googleapis.com/auth/compute.readonly
    • 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 IAM permissions:

    • compute.vpnGateways.get

    To find predefined roles that contain those permissions, see Compute Engine IAM Roles .
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: