Method: vpnTunnels.aggregatedList

HTTP request
Path parameters
Query parameters
Request body
Response body
- JSON representation
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

Parameters
`project`	`string` Project ID for this request.

project

string

Project ID for this request.

Query parameters

Parameters
`maxResults`	`integer (uint32 format)` The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
`pageToken`	`string` Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
`filter`	`string` 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 `=`, `!=`, `>`, or `<`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, `(scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake")`. By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example, `(cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true)`.
`orderBy`	`string` 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 `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.

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": integer, "peerExternalGateway": string, "peerExternalGatewayInterface": integer, "peerGcpGateway": string, "router": string, "peerIp": string, "sharedSecret": string, "sharedSecretHash": string, "status": enum, "selfLink": string, "ikeVersion": integer, "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 }

JSON representation

{
  "id": string,
  "items": [
    {
      "scopeName": string,
      "vpnTunnels": [
        {
          "id": string,
          "creationTimestamp": string,
          "name": string,
          "description": string,
          "region": string,
          "targetVpnGateway": string,
          "vpnGateway": string,
          "vpnGatewayInterface": integer,
          "peerExternalGateway": string,
          "peerExternalGatewayInterface": integer,
          "peerGcpGateway": string,
          "router": string,
          "peerIp": string,
          "sharedSecret": string,
          "sharedSecretHash": string,
          "status": enum,
          "selfLink": string,
          "ikeVersion": integer,
          "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`	`string` [Output Only] Unique identifier for the resource; defined by the server.
`items[]`	`object` A list of VpnTunnelsScopedList resources.
`items[].scopeName`	`string` Name of the scope containing this set of VPN tunnels.
`items[].vpnTunnels[]`	`object` A list of VPN tunnels contained in this scope.
`items[].vpnTunnels[].id`	`string (fixed64 format)` [Output Only] The unique identifier for the resource. This identifier is defined by the server.
`items[].vpnTunnels[].creationTimestamp`	`string` [Output Only] Creation timestamp in RFC3339 text format.
`items[].vpnTunnels[].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.
`items[].vpnTunnels[].description`	`string` An optional description of this resource. Provide this property when you create the resource.
`items[].vpnTunnels[].region`	`string` [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`	`string` 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`	`string` 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`	`integer` The interface ID of the VPN gateway with which this VPN tunnel is associated.
`items[].vpnTunnels[].peerExternalGateway`	`string` 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`	`integer` 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`	`string` 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`	`string` URL of the router resource to be used for dynamic routing.
`items[].vpnTunnels[].peerIp`	`string` IP address of the peer VPN gateway. Only IPv4 is supported.
`items[].vpnTunnels[].sharedSecret`	`string` Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway.
`items[].vpnTunnels[].sharedSecretHash`	`string` Hash of the shared secret.
`items[].vpnTunnels[].status`	`enum` [Output Only] The status of the VPN tunnel, which can be one of the following: PROVISIONING: Resource is being allocated for the VPN tunnel. WAITING_FOR_FULL_CONFIG: Waiting to receive all VPN-related configs from the user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule, and Route resources are needed to setup the VPN tunnel. FIRST_HANDSHAKE: Successful first handshake with the peer VPN. ESTABLISHED: Secure session is successfully established with the peer VPN. NETWORK_ERROR: Deprecated, replaced by NO_INCOMING_PACKETS AUTHORIZATION_ERROR: Auth error (for example, bad shared secret). NEGOTIATION_FAILURE: Handshake failed. DEPROVISIONING: Resources are being deallocated for the VPN tunnel. FAILED: Tunnel creation has failed and the tunnel is not ready to be used. NO_INCOMING_PACKETS: No incoming packets from peer. REJECTED: Tunnel configuration was rejected, can be result of being blacklisted. ALLOCATING_RESOURCES: Cloud VPN is in the process of allocating all required resources. STOPPED: Tunnel is stopped due to its Forwarding Rules being deleted for Classic VPN tunnels or the project is in frozen state. PEER_IDENTITY_MISMATCH: Peer identity does not match peer IP, probably behind NAT. TS_NARROWING_NOT_ALLOWED: Traffic selector narrowing not allowed for an HA-VPN tunnel.
`items[].vpnTunnels[].selfLink`	`string` [Output Only] Server-defined URL for the resource.
`items[].vpnTunnels[].ikeVersion`	`integer` IKE protocol version to use when establishing the VPN tunnel with the peer VPN gateway. Acceptable IKE versions are `1` or `2`. The default version is `2`.
`items[].vpnTunnels[].detailedStatus`	`string` [Output Only] Detailed status message for the VPN tunnel.
`items[].vpnTunnels[].localTrafficSelector[]`	`string` 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: `192.168.0.0/16`. The ranges must be disjoint. Only IPv4 is supported.
`items[].vpnTunnels[].remoteTrafficSelector[]`	`string` 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`	`string` [Output Only] Type of resource. Always `compute#vpnTunnel` for VPN tunnels.
`items[].warning`	`object` Informational warning which replaces the list of addresses when the list is empty.
`items[].warning.code`	`enum` [Output Only] A warning code, if applicable. For example, Compute Engine returns `NO_RESULTS_ON_PAGE` if there are no results in the response.
`items[].warning.message`	`string` [Output Only] A human-readable description of the warning code.
`items[].warning.data[]`	`object` [Output Only] Metadata about this warning in `key: value` format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
`items[].warning.data[].key`	`string` [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 `scope` and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
`items[].warning.data[].value`	`string` [Output Only] A warning data value corresponding to the key.
`nextPageToken`	`string` [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than `maxResults`, use the `nextPageToken` as a value for the query parameter `pageToken` in the next list request. Subsequent list requests will have their own `nextPageToken` to continue paging through the results.
`selfLink`	`string` [Output Only] Server-defined URL for this resource.
`warning`	`object` [Output Only] Informational warning message.
`warning.code`	`enum` [Output Only] A warning code, if applicable. For example, Compute Engine returns `NO_RESULTS_ON_PAGE` if there are no results in the response.
`warning.message`	`string` [Output Only] A human-readable description of the warning code.
`warning.data[]`	`object` [Output Only] Metadata about this warning in `key: value` format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
`warning.data[].key`	`string` [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 `scope` and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
`warning.data[].value`	`string` [Output Only] A warning data value corresponding to the key.
`kind`	`string` [Output Only] Type of resource. Always `compute#vpnTunnel` for VPN tunnels.

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