- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization Scopes
- IAM Permissions
Retrieves an aggregated list of VPN tunnels.
HTTP request
GET https://compute.googleapis.com/compute/v1/projects/{project}/aggregated/vpnTunnels
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
project |
Project ID for this request. |
Query parameters
Parameters | |
---|---|
maxResults |
The maximum number of results per page that should be returned. If the number of available results is larger than |
pageToken |
Specifies a page token to use. Set |
filter |
A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either For example, if you are filtering Compute Engine instances, you can exclude instances named You can also filter nested fields. For example, you could specify To filter on multiple expressions, provide each separate expression within parentheses. For example, |
orderBy |
Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using Currently, only sorting by |
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, "items": [ { "scopeName": string, "vpnTunnels": [ { "id": string, "creationTimestamp": string, "name": string, "description": string, "region": string, "targetVpnGateway": string, "vpnGateway": string, "vpnGatewayInterface": number, "peerExternalGateway": string, "peerExternalGatewayInterface": number, "peerGcpGateway": string, "router": string, "peerIp": string, "sharedSecret": string, "sharedSecretHash": string, "status": enum, "selfLink": string, "ikeVersion": number, "detailedStatus": string, "localTrafficSelector": [ string ], "remoteTrafficSelector": [ string ], "kind": string } ], "warning": { "code": enum, "message": string, "data": [ { "key": string, "value": string } ] } } ], "nextPageToken": string, "selfLink": string, "warning": { "code": enum, "message": string, "data": [ { "key": string, "value": string } ] }, "kind": string } |
Fields | |
---|---|
id |
[Output Only] Unique identifier for the resource; defined by the server. |
items[] |
A list of VpnTunnelsScopedList resources. |
items[].scopeName |
Name of the scope containing this set of VPN tunnels. |
items[].vpnTunnels[] |
A list of VPN tunnels contained in this scope. |
items[].vpnTunnels[].id |
[Output Only] The unique identifier for the resource. This identifier is defined by the server. |
items[].vpnTunnels[].creationTimestamp |
[Output Only] Creation timestamp in RFC3339 text format. |
items[].vpnTunnels[].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 |
items[].vpnTunnels[].description |
An optional description of this resource. Provide this property when you create the resource. |
items[].vpnTunnels[].region |
[Output Only] URL of the region where the VPN tunnel resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. |
items[].vpnTunnels[].targetVpnGateway |
URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. |
items[].vpnTunnels[].vpnGateway |
URL of the VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. This must be used (instead of targetVpnGateway) if a High Availability VPN gateway resource is created. |
items[].vpnTunnels[].vpnGatewayInterface |
The interface ID of the VPN gateway with which this VPN tunnel is associated. |
items[].vpnTunnels[].peerExternalGateway |
URL of the peer side external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field is exclusive with the field peerGcpGateway. |
items[].vpnTunnels[].peerExternalGatewayInterface |
The interface ID of the external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. |
items[].vpnTunnels[].peerGcpGateway |
URL of the peer side HA GCP VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field can be used when creating highly available VPN from VPC network to VPC network, the field is exclusive with the field peerExternalGateway. If provided, the VPN tunnel will automatically use the same vpnGatewayInterface ID in the peer GCP VPN gateway. |
items[].vpnTunnels[].router |
URL of the router resource to be used for dynamic routing. |
items[].vpnTunnels[].peerIp |
IP address of the peer VPN gateway. Only IPv4 is supported. |
items[].vpnTunnels[].sharedSecret |
Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway. |
items[].vpnTunnels[].sharedSecretHash |
Hash of the shared secret. |
items[].vpnTunnels[].status |
[Output Only] The status of the VPN tunnel, which can be one of the following:
|
items[].vpnTunnels[].selfLink |
[Output Only] Server-defined URL for the resource. |
items[].vpnTunnels[].ikeVersion |
IKE protocol version to use when establishing the VPN tunnel with the peer VPN gateway. Acceptable IKE versions are |
items[].vpnTunnels[].detailedStatus |
[Output Only] Detailed status message for the VPN tunnel. |
items[].vpnTunnels[].localTrafficSelector[] |
Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: |
items[].vpnTunnels[].remoteTrafficSelector[] |
Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is supported. |
items[].vpnTunnels[].kind |
[Output Only] Type of resource. Always |
items[].warning |
Informational warning which replaces the list of addresses when the list is empty. |
items[].warning.code |
[Output Only] A warning code, if applicable. For example, Compute Engine returns |
items[].warning.message |
[Output Only] A human-readable description of the warning code. |
items[].warning.data[] |
[Output Only] Metadata about this warning in "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
items[].warning.data[].key |
[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be |
items[].warning.data[].value |
[Output Only] A warning data value corresponding to the key. |
nextPageToken |
[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than |
selfLink |
[Output Only] Server-defined URL for this resource. |
warning |
[Output Only] Informational warning message. |
warning.code |
[Output Only] A warning code, if applicable. For example, Compute Engine returns |
warning.message |
[Output Only] A human-readable description of the warning code. |
warning.data[] |
[Output Only] Metadata about this warning in "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
warning.data[].key |
[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be |
warning.data[].value |
[Output Only] A warning data value corresponding to the key. |
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 Google IAM permissions:
compute.vpnTunnels.list