- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- Try it!
Retrieves an aggregated list of all usable subnetworks in the project.
HTTP request
GET https://compute.googleapis.com/compute/v1/projects/{project}/aggregated/subnetworks/listUsable
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. 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 For example, if you are filtering Compute Engine instances, you can exclude instances named The
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
If you want to use a regular expression, use the
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 You cannot combine constraints on multiple fields using regular expressions. |
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. 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. |
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": [ { "subnetwork": string, "network": string, "ipCidrRange": string, "secondaryIpRanges": [ { "rangeName": string, "ipCidrRange": string } ], "stackType": enum, "ipv6AccessType": enum, "purpose": enum, "role": enum, "externalIpv6Prefix": string, "internalIpv6Prefix": string } ], "nextPageToken": string, "selfLink": string, "warning": { "code": enum, "message": string, "data": [ { "key": string, "value": string } ] } } |
Fields | |
---|---|
kind |
[Output Only] Type of resource. Always |
id |
[Output Only] The unique identifier for the resource. This identifier is defined by the server. |
items[] |
[Output] A list of usable subnetwork URLs. |
items[].subnetwork |
Subnetwork URL. |
items[].network |
Network URL. |
items[].ipCidrRange |
The range of internal addresses that are owned by this subnetwork. |
items[].secondaryIpRanges[] |
Secondary IP ranges. |
items[].secondaryIpRanges[].rangeName |
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[].secondaryIpRanges[].ipCidrRange |
The range of IP addresses belonging to this subnetwork secondary range. |
items[].stackType |
The stack type for the subnet. If set to This field can be both set at resource creation time and updated using |
items[].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. |
items[].purpose |
The purpose of the resource. This field can be either |
items[].role |
The role of subnetwork. Currently, this field is only used when purpose is set to |
items[].externalIpv6Prefix |
[Output Only] The external IPv6 address range that is assigned to this subnetwork. |
items[].internalIpv6Prefix |
[Output Only] The internal IPv6 address range that is assigned to this subnetwork. |
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. |
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.