Method: subnetworks.aggregatedList

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

Retrieves an aggregated list of subnetworks.

To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

HTTP request

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

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. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: `labels.owner:` 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)` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.
`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. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.
`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.
`serviceProjectNumber`	`string (int64 format)` The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

JSON representation
{ "kind": string, "id": string, "items": { string: { "subnetworks": [ { "kind": string, "id": string, "creationTimestamp": string, "name": string, "description": string, "network": string, "ipCidrRange": string, "reservedInternalRange": string, "gatewayAddress": string, "region": string, "selfLink": string, "privateIpGoogleAccess": boolean, "secondaryIpRanges": [ { "rangeName": string, "ipCidrRange": string, "reservedInternalRange": string } ], "fingerprint": string, "allowSubnetCidrRoutesOverlap": boolean, "enableFlowLogs": boolean, "privateIpv6GoogleAccess": enum, "ipv6CidrRange": string, "externalIpv6Prefix": string, "internalIpv6Prefix": string, "purpose": enum, "role": enum, "state": enum, "logConfig": { "enable": boolean, "aggregationInterval": enum, "flowSampling": number, "metadata": enum, "metadataFields": [ string ], "filterExpr": string }, "stackType": enum, "ipv6AccessType": enum, "ipCollection": string, "ipv6GceEndpoint": enum } ], "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 ] }

JSON representation

{
  "kind": string,
  "id": string,
  "items": {
    string: {
      "subnetworks": [
        {
          "kind": string,
          "id": string,
          "creationTimestamp": string,
          "name": string,
          "description": string,
          "network": string,
          "ipCidrRange": string,
          "reservedInternalRange": string,
          "gatewayAddress": string,
          "region": string,
          "selfLink": string,
          "privateIpGoogleAccess": boolean,
          "secondaryIpRanges": [
            {
              "rangeName": string,
              "ipCidrRange": string,
              "reservedInternalRange": string
            }
          ],
          "fingerprint": string,
          "allowSubnetCidrRoutesOverlap": boolean,
          "enableFlowLogs": boolean,
          "privateIpv6GoogleAccess": enum,
          "ipv6CidrRange": string,
          "externalIpv6Prefix": string,
          "internalIpv6Prefix": string,
          "purpose": enum,
          "role": enum,
          "state": enum,
          "logConfig": {
            "enable": boolean,
            "aggregationInterval": enum,
            "flowSampling": number,
            "metadata": enum,
            "metadataFields": [
              string
            ],
            "filterExpr": string
          },
          "stackType": enum,
          "ipv6AccessType": enum,
          "ipCollection": string,
          "ipv6GceEndpoint": enum
        }
      ],
      "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
  ]
}

Fields
`kind`	`string` [Output Only] Type of resource. Always `compute#subnetworkAggregatedList` for aggregated lists of subnetworks.
`id`	`string` [Output Only] Unique identifier for the resource; defined by the server.
`items`	`map (key: string, value: object)` A list of SubnetworksScopedList resources. Key: Name of the scope containing this set of Subnetworks.
`items.subnetworks[]`	`object` A list of subnetworks contained in this scope.
`items.subnetworks[].kind`	`string` [Output Only] Type of the resource. Always `compute#subnetwork` for Subnetwork resources.
`items.subnetworks[].id`	`string (uint64 format)` [Output Only] The unique identifier for the resource. This identifier is defined by the server.
`items.subnetworks[].creationTimestamp`	`string` [Output Only] Creation timestamp in RFC3339 text format.
`items.subnetworks[].name`	`string` The name of the resource, provided by the client when initially creating the resource. 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.subnetworks[].description`	`string` An optional description of this resource. Provide this property when you create the resource. This field can be set only at resource creation time.
`items.subnetworks[].network`	`string` The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. This field can be set only at resource creation time.
`items.subnetworks[].ipCidrRange`	`string` The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, `10.0.0.0/8` or `100.64.0.0/10`. Ranges must be unique and non-overlapping within a network. Only IPv4 is supported. This field is set at resource creation time. The range can be any range listed in the Valid ranges list. The range can be expanded after creation using `expandIpCidrRange`.
`items.subnetworks[].reservedInternalRange`	`string` The URL of the reserved internal range.
`items.subnetworks[].gatewayAddress`	`string` [Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork.
`items.subnetworks[].region`	`string` URL of the region where the Subnetwork resides. This field can be set only at resource creation time.
`items.subnetworks[].selfLink`	`string` [Output Only] Server-defined URL for the resource.
`items.subnetworks[].privateIpGoogleAccess`	`boolean` Whether the VMs in this subnet can access Google services without assigned external IP addresses. This field can be both set at resource creation time and updated using `setPrivateIpGoogleAccess`.
`items.subnetworks[].secondaryIpRanges[]`	`object` An array of configurations for secondary IP ranges for VM instances contained in this subnetwork. The primary IP of such VM must belong to the primary ipCidrRange of the subnetwork. The alias IPs may belong to either primary or secondary ranges. This field can be updated with a `patch` request.
`items.subnetworks[].secondaryIpRanges[].rangeName`	`string` The name associated with this subnetwork secondary range, used when adding an alias IP range to a VM instance. The name must be 1-63 characters long, and comply with RFC1035. The name must be unique within the subnetwork.
`items.subnetworks[].secondaryIpRanges[].ipCidrRange`	`string` The range of IP addresses belonging to this subnetwork secondary range. Provide this property when you create the subnetwork. Ranges must be unique and non-overlapping with all primary and secondary IP ranges within a network. Only IPv4 is supported. The range can be any range listed in the Valid ranges list.
`items.subnetworks[].secondaryIpRanges[].reservedInternalRange`	`string` The URL of the reserved internal range.
`items.subnetworks[].fingerprint`	`string (bytes format)` Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a `Subnetwork`. An up-to-date fingerprint must be provided in order to update the `Subnetwork`, otherwise the request will fail with error `412 conditionNotMet`. To see the latest fingerprint, make a `get()` request to retrieve a Subnetwork. A base64-encoded string.
`items.subnetworks[].allowSubnetCidrRoutesOverlap`	`boolean` Whether this subnetwork's ranges can conflict with existing static routes. Setting this to true allows this subnetwork's primary and secondary ranges to overlap with (and contain) static routes that have already been configured on the corresponding network. For example if a static route has range 10.1.0.0/16, a subnet range 10.0.0.0/8 could only be created if allowConflictingRoutes=true. Overlapping is only allowed on subnetwork operations; routes whose ranges conflict with this subnetwork's ranges won't be allowed unless route.allow_conflicting_subnetworks is set to true. Typically packets destined to IPs within the subnetwork (which may contain private/sensitive data) are prevented from leaving the virtual network. Setting this field to true will disable this feature. The default value is false and applies to all existing subnetworks and automatically created subnetworks. This field cannot be set to true at resource creation time.
`items.subnetworks[].enableFlowLogs`	`boolean` Whether to enable flow logging for this subnetwork. If this field is not explicitly set, it will not appear in `get` listings. If not set the default behavior is determined by the org policy, if there is no org policy specified, then it will default to disabled. This field isn't supported if the subnet `purpose` field is set to `REGIONAL_MANAGED_PROXY`.
`items.subnetworks[].privateIpv6GoogleAccess`	`enum` This field is for internal use. This field can be both set at resource creation time and updated using `patch`.
`items.subnetworks[].ipv6CidrRange`	`string` [Output Only] This field is for internal use.
`items.subnetworks[].externalIpv6Prefix`	`string` The external IPv6 address range that is owned by this subnetwork.
`items.subnetworks[].internalIpv6Prefix`	`string` The internal IPv6 address range that is owned by this subnetwork.
`items.subnetworks[].purpose`	`enum` The purpose of the resource. This field can be either `PRIVATE`, `GLOBAL_MANAGED_PROXY`, `REGIONAL_MANAGED_PROXY`, `PEER_MIGRATION` or `PRIVATE_SERVICE_CONNECT`. `PRIVATE` is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. Subnets with purpose set to `GLOBAL_MANAGED_PROXY` or `REGIONAL_MANAGED_PROXY` are user-created subnetworks that are reserved for Envoy-based load balancers. A subnet with purpose set to `PRIVATE_SERVICE_CONNECT` is used to publish services using Private Service Connect. A subnet with purpose set to `PEER_MIGRATION` is used for subnet migration from one peered VPC to another. If unspecified, the subnet purpose defaults to `PRIVATE`. The `enableFlowLogs` field isn't supported if the subnet `purpose` field is set to `GLOBAL_MANAGED_PROXY` or `REGIONAL_MANAGED_PROXY`.
`items.subnetworks[].role`	`enum` The role of subnetwork. Currently, this field is only used when purpose is set to `GLOBAL_MANAGED_PROXY` or `REGIONAL_MANAGED_PROXY`. The value can be set to `ACTIVE` or `BACKUP`. An `ACTIVE` subnetwork is one that is currently being used for Envoy-based load balancers in a region. A `BACKUP` subnetwork is one that is ready to be promoted to `ACTIVE` or is currently draining. This field can be updated with a `patch` request.
`items.subnetworks[].state`	`enum` [Output Only] The state of the subnetwork, which can be one of the following values: `READY`: Subnetwork is created and ready to use `DRAINING`: only applicable to subnetworks that have the purpose set to `INTERNAL_HTTPS_LOAD_BALANCER` and indicates that connections to the load balancer are being drained. A subnetwork that is draining cannot be used or modified until it reaches a status of `READY`
`items.subnetworks[].logConfig`	`object` This field denotes the VPC flow logging options for this subnetwork. If logging is enabled, logs are exported to Cloud Logging.
`items.subnetworks[].logConfig.enable`	`boolean` Whether to enable flow logging for this subnetwork. If this field is not explicitly set, it will not appear in `get` listings. If not set the default behavior is determined by the org policy, if there is no org policy specified, then it will default to disabled. Flow logging isn't supported if the subnet `purpose` field is set to `REGIONAL_MANAGED_PROXY`.
`items.subnetworks[].logConfig.aggregationInterval`	`enum` Can only be specified if VPC flow logging for this subnetwork is enabled. Toggles the aggregation interval for collecting flow logs. Increasing the interval time will reduce the amount of generated flow logs for long lasting connections. Default is an interval of 5 seconds per connection.
`items.subnetworks[].logConfig.flowSampling`	`number` Can only be specified if VPC flow logging for this subnetwork is enabled. The value of the field must be in [0, 1]. Set the sampling rate of VPC flow logs within the subnetwork where 1.0 means all collected logs are reported and 0.0 means no logs are reported. Default is 0.5 unless otherwise specified by the org policy, which means half of all collected logs are reported.
`items.subnetworks[].logConfig.metadata`	`enum` Can only be specified if VPC flow logs for this subnetwork is enabled. Configures whether all, none or a subset of metadata fields should be added to the reported VPC flow logs. Default is `EXCLUDE_ALL_METADATA`.
`items.subnetworks[].logConfig.metadataFields[]`	`string` Can only be specified if VPC flow logs for this subnetwork is enabled and "metadata" was set to CUSTOM_METADATA.
`items.subnetworks[].logConfig.filterExpr`	`string` Can only be specified if VPC flow logs for this subnetwork is enabled. The filter expression is used to define which VPC flow logs should be exported to Cloud Logging.
`items.subnetworks[].stackType`	`enum` The stack type for the subnet. If set to `IPV4_ONLY`, new VMs in the subnet are assigned IPv4 addresses only. If set to `IPV4_IPV6`, new VMs in the subnet can be assigned both IPv4 and IPv6 addresses. If not specified, `IPV4_ONLY` is used. This field can be both set at resource creation time and updated using `patch`.
`items.subnetworks[].ipv6AccessType`	`enum` The access type of IPv6 address this subnet holds. It's immutable and can only be specified during creation or the first time the subnet is updated into IPV4_IPV6 dual stack.
`items.subnetworks[].ipCollection`	`string` Reference to the source of IP, like a `PublicDelegatedPrefix` (PDP) for BYOIP. The PDP must be a sub-PDP in EXTERNAL_IPV6_SUBNETWORK_CREATION mode. Use one of the following formats to specify a sub-PDP when creating a dual stack subnetwork with external access using BYOIP: Full resource URL, as in `https://www.googleapis.com/compute/v1/projects/projectId/regions/region/publicDelegatedPrefixes/sub-pdp-name` Partial URL, as in projects/`projectId`/regions/`region`/publicDelegatedPrefixes/`sub-pdp-name` regions/`region`/publicDelegatedPrefixes/`sub-pdp-name`
`items.subnetworks[].ipv6GceEndpoint`	`enum` [Output Only] Possible endpoints of this subnetwork. It can be one of the following: `VM_ONLY`: The subnetwork can be used for creating instances and IPv6 addresses with VM endpoint type. Such a subnetwork gets external IPv6 ranges from a public delegated prefix and cannot be used to create NetLb. `VM_AND_FR`: The subnetwork can be used for creating both VM instances and Forwarding Rules. It can also be used to reserve IPv6 addresses with both VM and FR endpoint types. Such a subnetwork gets its IPv6 range from Google IP Pool directly.
`items.warning`	`object` An informational warning that appears when the list of addresses 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.

Authorization scopes

Requires one of the following OAuth scopes:

https://www.googleapis.com/auth/compute.readonly
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.subnetworks.list

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