- HTTP request
- Path parameters
- Request body
- Response body
- Authorization Scopes
- IAM Permissions
- Examples
- Try it!
Returns the specified target VPN gateway. Gets a list of available target VPN gateways by making a list()
request.
HTTP request
GET https://compute.googleapis.com/compute/v1/projects/{project}/regions/{region}/targetVpnGateways/{resourceId}
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 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 | |
---|---|
{ "id": string, "creationTimestamp": string, "name": string, "description": string, "region": string, "network": string, "tunnels": [ string ], "status": enum, "selfLink": string, "forwardingRules": [ string ], "kind": string } |
Fields | |
---|---|
id |
[Output Only] The unique identifier for the resource. This identifier is defined by the server. |
creationTimestamp |
[Output Only] Creation timestamp in RFC3339 text format. |
name |
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 |
description |
An optional description of this resource. Provide this property when you create the resource. |
region |
[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. |
network |
URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created. |
tunnels[] |
[Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using the |
status |
[Output Only] The status of the VPN gateway, which can be one of the following: CREATING, READY, FAILED, or DELETING. |
selfLink |
[Output Only] Server-defined URL for the resource. |
forwardingRules[] |
[Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using |
kind |
[Output Only] Type of resource. Always |
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 IAM permissions:
compute.targetVpnGateways.get
To find predefined roles that contain those permissions, see Compute Engine IAM Roles.