- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- 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 | |
---|---|
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:
By default, each expression is an
|
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 |
returnPartialSuccess |
Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. |
includeAllScopes |
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 } |
Fields | |
---|---|
id |
[Output Only] Unique identifier for the resource; defined by the server. |
items[] |
A list of VpnGateway resources. |
items[].scopeName |
[Output Only] Name of the scope containing this set of VPN gateways. |
items[].vpnGateways[] |
[Output Only] A list of VPN gateways contained in this scope. |
items[].vpnGateways[].id |
[Output Only] The unique identifier for the resource. This identifier is defined by the server. |
items[].vpnGateways[].creationTimestamp |
[Output Only] Creation timestamp in RFC3339 text format. |
items[].vpnGateways[].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[].vpnGateways[].description |
An optional description of this resource. Provide this property when you create the resource. |
items[].vpnGateways[].region |
[Output Only] URL of the region where the VPN gateway resides. |
items[].vpnGateways[].network |
URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created. |
items[].vpnGateways[].selfLink |
[Output Only] Server-defined URL for the resource. |
items[].vpnGateways[].labels |
Labels for this resource. These can only be added or modified by the An object containing a list of |
items[].vpnGateways[].labelFingerprint |
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 To see the latest fingerprint, make a A base64-encoded string. |
items[].vpnGateways[].vpnInterfaces[] |
A list of interfaces on this VPN gateway. |
items[].vpnGateways[].vpnInterfaces[].id |
The numeric ID of this VPN gateway interface. |
items[].vpnGateways[].vpnInterfaces[].ipAddress |
[Output Only] The external IP address for this VPN gateway interface. |
items[].vpnGateways[].kind |
[Output Only] Type of resource. Always |
items[].warning |
[Output Only] 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. |
unreachables[] |
[Output Only] Unreachable resources. |
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.vpnGateways.list
To find predefined roles that contain those permissions, see Compute Engine IAM Roles.