Method: targetVpnGateways.get

Returns the specified target VPN gateway. acceleratorTypes.get a list of available target VPN gateways by making a list() request.

HTTP request

GET https://compute.googleapis.com/compute/beta/projects/{project}/regions/{region}/targetVpnGateways/{resourceId}

The URL uses Google API HTTP annotation syntax.

Path parameters

Parameters
project

string

Project ID for this request.

region

string

Name of the region for this request.

resourceId

string

Name of the target 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
{
  "resource": {
    "id": string,
    "creationTimestamp": string,
    "name": string,
    "description": string,
    "region": string,
    "network": string,
    "tunnels": string,
    "status": enum,
    "selfLink": string,
    "forwardingRules": string,
    "labels": {
      "key": string,
      "value": string
    },
    "labelFingerprint": string,
    "kind": string
  },
}
Fields
resource

object

resource.id

string (fixed64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

resource.creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.

resource.name

string

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

resource.description

string

An optional description of this resource. Provide this property when you create the resource.

resource.region

string

[Output Only] URL of the region where the target VPN gateway resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

resource.network

string

URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.

resource.tunnels[]

string

[Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using compute.vpntunnels.insert method and associated to a VPN gateway.

resource.status

enum

[Output Only] The status of the VPN gateway.

resource.selfLink

string

[Output Only] Server-defined URL for the resource.

resource.forwardingRules[]

string

[Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated to a VPN gateway.

resource.labels

map (key: string, value: string)

Labels to apply to this TargetVpnGateway resource. These can be later modified by the setLabels method. Each label key/value must comply with RFC1035. Label values may be empty.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

resource.labelFingerprint

string (bytes format)

A fingerprint for the labels being applied to this TargetVpnGateway, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.

To see the latest fingerprint, make a get() request to retrieve an TargetVpnGateway.

A base64-encoded string.

resource.kind

string

[Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.

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 Auth Guide.

IAM Permissions

In addition to any permissions specified on the fields above, authorization requires one or more of the following Google IAM permissions:

  • compute.targetVpnGateways.get

Send feedback about...

Compute Engine