- HTTP request
- Path parameters
- Request body
- Response body
- Authorization Scopes
- IAM Permissions
- Examples
- Try it!
Returns the specified externalVpnGateway. globalOperations.get a list of available externalVpnGateways by making a list()
request.
HTTP request
GET https://compute.googleapis.com/compute/beta/projects/{project}/global/externalVpnGateways/{resourceId}
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
project |
Project ID for this request. |
resourceId |
Name of the externalVpnGateway 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 | |
---|---|
{ "description": string, "selfLink": string, "id": string, "creationTimestamp": string, "name": string, "redundancyType": enum, "interfaces": [ { "id": integer, "ipAddress": string } ], "labels": { string: string, ... }, "labelFingerprint": string, "kind": string } |
Fields | |
---|---|
description |
An optional description of this resource. Provide this property when you create the resource. |
selfLink |
[Output Only] Server-defined URL for the resource. |
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 |
redundancyType |
Indicates the user-supplied redundancy type of this external VPN gateway. |
interfaces[] |
globalOperations.list of interfaces for this external VPN gateway. |
interfaces[].id |
The numeric ID of this interface. The allowed input values for this id for different redundancy types of external VPN gateway: SINGLE_IP_INTERNALLY_REDUNDANT - 0 TWO_IPS_REDUNDANCY - 0, 1 FOUR_IPS_REDUNDANCY - 0, 1, 2, 3 |
interfaces[].ipAddress |
IP address of the interface in the external VPN gateway. Only IPv4 is supported. This IP address can be either from your on-premise gateway or another Cloud provider's VPN gateway, it cannot be an IP address from Google Compute Engine. |
labels |
Labels for this resource. These can only be added or modified by the An object containing a list of |
labelFingerprint |
A fingerprint for the labels being applied to this ExternalVpnGateway, 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, otherwise the request will fail with error To see the latest fingerprint, make a A base64-encoded string. |
kind |
[Output Only] Type of the 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.externalVpnGateways.get
To find predefined roles that contain those permissions, see Compute Engine IAM Roles.