Method: vpnGateways.aggregatedList

HTTP request
Path parameters
Query parameters
Request body
Response body
- JSON representation
Authorization Scopes
IAM Permissions
Examples
Try it!

Retrieves an aggregated list of VPN gateways.

HTTP request

GET https://compute.googleapis.com/compute/beta/projects/{project}/aggregated/vpnGateways

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.
`returnPartialSuccess`	`boolean` Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
`includeAllScopes`	`boolean` Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.

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, "vpnGateways": [ { "id": string, "creationTimestamp": string, "name": string, "description": string, "region": string, "network": string, "selfLink": string, "labels": { string: string, ... }, "labelFingerprint": string, "vpnInterfaces": [ { "id": integer, "ipAddress": 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 } ] }, "unreachables": [ string ], "kind": string }

JSON representation

{
  "id": string,
  "items": [
    {
      "scopeName": string,
      "vpnGateways": [
        {
          "id": string,
          "creationTimestamp": string,
          "name": string,
          "description": string,
          "region": string,
          "network": string,
          "selfLink": string,
          "labels": {
            string: string,
            ...
          },
          "labelFingerprint": string,
          "vpnInterfaces": [
            {
              "id": integer,
              "ipAddress": 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
      }
    ]
  },
  "unreachables": [
    string
  ],
  "kind": string
}

Fields
`id`	`string` [Output Only] Unique identifier for the resource; defined by the server.
`items[]`	`object` A list of VpnGateway resources.
`items[].scopeName`	`string` [Output Only] Name of the scope containing this set of VPN gateways.
`items[].vpnGateways[]`	`object` [Output Only] A list of VPN gateways contained in this scope.
`items[].vpnGateways[].id`	`string (fixed64 format)` [Output Only] The unique identifier for the resource. This identifier is defined by the server.
`items[].vpnGateways[].creationTimestamp`	`string` [Output Only] Creation timestamp in RFC3339 text format.
`items[].vpnGateways[].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[].vpnGateways[].description`	`string` An optional description of this resource. Provide this property when you create the resource.
`items[].vpnGateways[].region`	`string` [Output Only] URL of the region where the VPN gateway resides.
`items[].vpnGateways[].network`	`string` URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.
`items[].vpnGateways[].selfLink`	`string` [Output Only] Server-defined URL for the resource.
`items[].vpnGateways[].labels`	`map (key: string, value: string)` Labels for this resource. These can only be added or modified by the `setLabels` method. Each label key/value pair 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" }`.
`items[].vpnGateways[].labelFingerprint`	`string (bytes format)` A fingerprint for the labels being applied to this VpnGateway, 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 `412 conditionNotMet`. To see the latest fingerprint, make a `get()` request to retrieve an VpnGateway. A base64-encoded string.
`items[].vpnGateways[].vpnInterfaces[]`	`object` A list of interfaces on this VPN gateway.
`items[].vpnGateways[].vpnInterfaces[].id`	`integer (uint32 format)` The numeric ID of this VPN gateway interface.
`items[].vpnGateways[].vpnInterfaces[].ipAddress`	`string` [Output Only] The external IP address for this VPN gateway interface.
`items[].vpnGateways[].kind`	`string` [Output Only] Type of resource. Always `compute#vpnGateway` for VPN gateways.
`items[].warning`	`object` [Output Only] 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.
`unreachables[]`	`string` [Output Only] Unreachable resources.
`kind`	`string` [Output Only] Type of resource. Always `compute#vpnGateway` for 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 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.vpnGateways.list

To find predefined roles that contain those permissions, see Compute Engine IAM Roles.