- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
- Try it!
Retrieves the list of networks available to the specified project.
HTTP request
GET https://compute.googleapis.com/compute/beta/projects/{project}/global/networks
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
Contains a list of networks.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{ "kind" : string , "id" : string , "items" : [ { "kind" : string , "id" : string , "creationTimestamp" : string , "name" : string , "description" : string , "IPv4Range" : string , "gatewayIPv4" : string , "selfLink" : string , "selfLinkWithId" : string , "autoCreateSubnetworks" : boolean , "subnetworks" : [ string ] , "peerings" : [ { "name" : string , "network" : string , "state" : enum , "stateDetails" : string , "autoCreateRoutes" : boolean , "exportCustomRoutes" : boolean , "importCustomRoutes" : boolean , "exchangeSubnetRoutes" : boolean , "exportSubnetRoutesWithPublicIp" : boolean , "importSubnetRoutesWithPublicIp" : boolean , "peerMtu" : integer , "stackType" : enum } ] , "routingConfig" : { "routingMode" : enum , "bgpBestPathSelectionMode" : enum , "bgpAlwaysCompareMed" : boolean , "bgpInterRegionCost" : enum } , "mtu" : integer , "firewallPolicy" : string , "networkFirewallPolicyEnforcementOrder" : enum , "enableUlaInternalIpv6" : boolean , "internalIpv6Range" : 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] Unique identifier for the resource; defined by the server. |
items[]
|
A list of Network resources. |
items[].kind
|
[Output Only] Type of the resource. Always |
items[].id
|
[Output Only] The unique identifier for the resource. This identifier is defined by the server. |
items[].creationTimestamp
|
[Output Only] Creation timestamp in RFC3339 text format. |
items[].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[].description
|
An optional description of this resource. Provide this field when you create the resource. |
items[].IPv4Range
|
Deprecated in favor of subnet mode networks. The range of internal addresses that are legal on this network. This range is a CIDR
specification, for example: |
items[].gatewayIPv4
|
[Output Only] The gateway address for default routing out of the network, selected by Google Cloud. |
items[].selfLink
|
[Output Only] Server-defined URL for the resource. |
items[].selfLinkWithId
|
[Output Only] Server-defined URL for this resource with the resource id. |
items[].autoCreateSubnetworks
|
Must be set to create a VPC network. If not set, a legacy network is created. When set to true, the VPC network is created in An auto mode VPC network starts with one subnet per region. Each subnet has a predetermined range as described in Auto mode VPC network IP ranges . For custom mode VPC networks, you can add subnets using the subnetworks insert method. |
items[].subnetworks[]
|
[Output Only] Server-defined fully-qualified URLs for all subnetworks in this VPC network. |
items[].peerings[]
|
[Output Only] A list of network peerings for the resource. |
items[].peerings[].name
|
Name of this peering. Provided by the client when the peering is created. The name must comply with RFC1035
. Specifically, the name must be 1-63 characters long and match regular expression |
items[].peerings[].network
|
The URL of the peer network. It can be either full URL or partial URL. The peer network may belong to a different project. If the partial URL does not contain project, it is assumed that the peer network is in the same project as the current network. |
items[].peerings[].state
|
[Output Only] State for the peering, either |
items[].peerings[].stateDetails
|
[Output Only] Details about the current state of the peering. |
items[].peerings[].autoCreateRoutes
|
This field will be deprecated soon. Use the |
items[].peerings[].exportCustomRoutes
|
Whether to export the custom routes to peer network. The default value is false. |
items[].peerings[].importCustomRoutes
|
Whether to import the custom routes from peer network. The default value is false. |
items[].peerings[].exchangeSubnetRoutes
|
Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is |
items[].peerings[].exportSubnetRoutesWithPublicIp
|
Whether subnet routes with public IP range are exported. The default value is true, all subnet routes are exported. IPv4 special-use ranges are always exported to peers and are not controlled by this field. |
items[].peerings[].importSubnetRoutesWithPublicIp
|
Whether subnet routes with public IP range are imported. The default value is false. IPv4 special-use ranges are always imported from peers and are not controlled by this field. |
items[].peerings[].peerMtu
|
Maximum Transmission Unit in bytes. |
items[].peerings[].stackType
|
Which IP version(s) of traffic and routes are allowed to be imported or exported between peer networks. The default value is IPV4_ONLY. |
items[].routingConfig
|
The network-level routing configuration for this network. Used by Cloud Router to determine what type of network-wide routing behavior to enforce. |
items[].routingConfig.routingMode
|
The network-wide routing mode to use. If set to |
items[].routingConfig.bgpBestPathSelectionMode
|
The BGP best path selection algorithm to be employed within this network for dynamic routes learned by Cloud Routers. Can be |
items[].routingConfig.bgpAlwaysCompareMed
|
Enable comparison of Multi-Exit Discriminators (MED) across routes with different neighbor ASNs when using the STANDARD BGP best path selection algorithm. |
items[].routingConfig.bgpInterRegionCost
|
Allows to define a preferred approach for handling inter-region cost in the selection process when using the |
items[].mtu
|
Maximum Transmission Unit in bytes. The minimum value for this field is 1300 and the maximum value is 8896. The suggested value is 1500, which is the default MTU used on the Internet, or 8896 if you want to use Jumbo frames. If unspecified, the value defaults to 1460. |
items[].firewallPolicy
|
[Output Only] URL of the firewall policy the network is associated with. |
items[].networkFirewallPolicyEnforcementOrder
|
The network firewall policy enforcement order. Can be either AFTER_CLASSIC_FIREWALL or BEFORE_CLASSIC_FIREWALL. Defaults to AFTER_CLASSIC_FIREWALL if the field is not specified. |
items[].enableUlaInternalIpv6
|
Enable ULA internal ipv6 on this network. Enabling this feature will assign a /48 from google defined ULA prefix fd20::/20. . |
items[].internalIpv6Range
|
When enabling ula internal ipv6, caller optionally can specify the /48 range they want from the google defined ULA prefix fd20::/20. The input must be a valid /48 ULA IPv6 address and must be within the fd20::/20. Operation will fail if the speficied /48 is already in used by another resource. If the field is not speficied, then a /48 range will be randomly allocated from fd20::/20 and returned via this field. . |
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 .
IAM Permissions
In addition to any permissions specified on the fields above, authorization requires one or more of the following IAM permissions:
-
compute.networks.list
To find predefined roles that contain those permissions, see Compute Engine IAM Roles .