Method: subnetworks.listUsable

Retrieves an aggregated list of all usable subnetworks in the project.

HTTP request

GET https://compute.s3nsapis.fr/compute/v1/projects/{project}/aggregated/subnetworks/listUsable

The URL uses gRPC Transcoding syntax. To know more about valid error responses that can be thrown by this HTTP request, please refer to the service error catalog

Path parameters

Parameters
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 Trusted Cloud 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.
serviceProject

string

The project id or project number in which the subnetwork is intended to be used. Only applied for Shared VPC. See Shared VPC documentation

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": [
    {
      object (UsableSubnetwork)
    }
  ],
  "nextPageToken": string,
  "selfLink": string,
  "warning": {
    "code": enum (WarningCode),
    "message": string,
    "data": [
      {
        "key": string,
        "value": string
      }
    ]
  },
  "unreachables": [
    string
  ],
  "scopedWarnings": [
    {
      object (SubnetworksScopedWarning)
    }
  ]
}
Fields
kind

string

[Output Only] Type of resource. Always

compute#usableSubnetworksAggregatedList

for aggregated lists of usable subnetworks.
id

string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.
items[]

object (UsableSubnetwork)

[Output] A list of usable subnetwork URLs.
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. In special cases

listUsable

may return 0 subnetworks and

nextPageToken

which still should be used to get the next page of results.
warning

object

[Output Only] Informational warning message.
warning.code

enum (WarningCode)

[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.
scopedWarnings[]

object (SubnetworksScopedWarning)

[Output Only] Informational warning messages for failures encountered from scopes.

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.

UsableSubnetwork

Subnetwork which the current user has compute.subnetworks.use permission on.

JSON representation 
{
  "subnetwork": string,
  "network": string,
  "ipCidrRange": string,
  "secondaryIpRanges": [
    {
      object (UsableSubnetworkSecondaryRange)
    }
  ],
  "stackType": enum (StackType),
  "ipv6AccessType": enum (Ipv6AccessType),
  "purpose": enum (Purpose),
  "role": enum (Role),
  "externalIpv6Prefix": string,
  "internalIpv6Prefix": string
}
Fields
subnetwork

string

Subnetwork URL.
network

string

Network URL.
ipCidrRange

string

The range of internal addresses that are owned by this subnetwork.
secondaryIpRanges[]

object (UsableSubnetworkSecondaryRange)

Secondary IP ranges.
stackType

enum (StackType)

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

.
ipv6AccessType

enum (Ipv6AccessType)

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.
purpose

enum (Purpose)
role

enum (Role)

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.
externalIpv6Prefix

string

[Output Only] The external IPv6 address range that is assigned to this subnetwork.
internalIpv6Prefix

string

[Output Only] The internal IPv6 address range that is assigned to this subnetwork.

UsableSubnetworkSecondaryRange

Secondary IP range of a usable subnetwork.

JSON representation 
{
  "rangeName": string,
  "ipCidrRange": string
}
Fields
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.
ipCidrRange

string

The range of IP addresses belonging to this subnetwork secondary range.

StackType

Enums
IPV4_ONLY New VMs in this subnet will only be assigned IPv4 addresses.
IPV4_IPV6 New VMs in this subnet can have both IPv4 and IPv6 addresses.
IPV6_ONLY New VMs in this subnet will only be assigned IPv6 addresses.

Ipv6AccessType

Enums
INTERNAL VMs on this subnet will be assigned IPv6 addresses that are only accessible over the VPC network.
EXTERNAL VMs on this subnet will be assigned IPv6 addresses that are accessible via the Internet, as well as the VPC network.

Purpose

Enums
PRIVATE_RFC_1918 Regular user created or automatically created subnet.
INTERNAL_HTTPS_LOAD_BALANCER Subnet reserved for Internal HTTP(S) Load Balancing. This is a legacy purpose, please use REGIONAL_MANAGED_PROXY instead.
PRIVATE Regular user created or automatically created subnet.
PRIVATE_SERVICE_CONNECT Subnetworks created for Private Service Connect in the producer network.
GLOBAL_MANAGED_PROXY Subnet reserved for Global Envoy-based Load Balancing.
REGIONAL_MANAGED_PROXY Subnetwork used for Regional Envoy-based Load Balancing.
PRIVATE_NAT Subnetwork used as source range for Private NAT Gateways.
PEER_MIGRATION Subnetwork will be used for Migration from one peered VPC to another. (a transient state of subnetwork while migrating resources from one project to another).

Role

Enums
ACTIVE The ACTIVE subnet that is currently used.
BACKUP The BACKUP subnet that could be promoted to ACTIVE.

SubnetworksScopedWarning

JSON representation 
{
  "scopeName": string,
  "warning": {
    "code": enum (WarningCode),
    "message": string,
    "data": [
      {
        "key": string,
        "value": string
      }
    ]
  }
}
Fields
scopeName

string

Name of the scope containing this set of Subnetworks.
warning

object

An informational warning about unreachable scope
warning.code

enum (WarningCode)

[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.