Method: networks.get

Returns the specified network.

HTTP request

GET https://compute.googleapis.com/compute/beta/projects/{project}/global/networks/{network}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
project

string

Project ID for this request.
network

string

Name of the network to return.

Request body

The request body must be empty.

Response body

Represents a VPC Network resource.

Networks connect resources to each other and to the internet. For more information, read Virtual Private Cloud (VPC) Network.

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

JSON representation 
{
  "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,
    "effectiveBgpAlwaysCompareMed": boolean,
    "effectiveBgpInterRegionCost": enum
  },
  "mtu": integer,
  "firewallPolicy": string,
  "networkFirewallPolicyEnforcementOrder": enum,
  "enableUlaInternalIpv6": boolean,
  "internalIpv6Range": string,
  "networkProfile": string
}
Fields
kind

string

[Output Only] Type of the resource. Always compute#network for networks.
id

string (uint64 format)

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

string

[Output Only] Creation timestamp in RFC3339 text format.
name

string

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 [a-z]([-a-z0-9]*[a-z0-9])?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.
description

string

An optional description of this resource. Provide this field when you create the resource.
IPv4Range
(deprecated)

string

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: 192.168.0.0/16. Provided by the client when the network is created.
gatewayIPv4

string

[Output Only] The gateway address for default routing out of the network, selected by Google Cloud.
autoCreateSubnetworks

boolean

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 auto mode. When set to false, the VPC network is created in custom mode.

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

string

[Output Only] Server-defined fully-qualified URLs for all subnetworks in this VPC network.
peerings[]

object

[Output Only] A list of network peerings for the resource.
peerings[].name

string

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 [a-z]([-a-z0-9]*[a-z0-9])?. The first character must be a lowercase letter, and all the following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
peerings[].network

string

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.
peerings[].state

enum

[Output Only] State for the peering, either ACTIVE or INACTIVE. The peering is ACTIVE when there's a matching configuration in the peer network.
peerings[].stateDetails

string

[Output Only] Details about the current state of the peering.
peerings[].autoCreateRoutes

boolean

This field will be deprecated soon. Use the exchangeSubnetRoutes field instead. 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 ACTIVE.
peerings[].exportCustomRoutes

boolean

Whether to export the custom routes to peer network. The default value is false.
peerings[].importCustomRoutes

boolean

Whether to import the custom routes from peer network. The default value is false.
peerings[].exchangeSubnetRoutes

boolean

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 ACTIVE.
peerings[].exportSubnetRoutesWithPublicIp

boolean

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.
peerings[].importSubnetRoutesWithPublicIp

boolean

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.
peerings[].peerMtu

integer

Maximum Transmission Unit in bytes.
peerings[].stackType

enum

Which IP version(s) of traffic and routes are allowed to be imported or exported between peer networks. The default value is IPV4_ONLY.
routingConfig

object

The network-level routing configuration for this network. Used by Cloud Router to determine what type of network-wide routing behavior to enforce.
routingConfig.routingMode

enum

The network-wide routing mode to use. If set to REGIONAL, this network's Cloud Routers will only advertise routes with subnets of this network in the same region as the router. If set to GLOBAL, this network's Cloud Routers will advertise routes with all subnets of this network, across regions.
routingConfig.bgpBestPathSelectionMode

enum

The BGP best path selection algorithm to be employed within this network for dynamic routes learned by Cloud Routers. Can be LEGACY (default) or STANDARD.
routingConfig.bgpAlwaysCompareMed

boolean

Enable comparison of Multi-Exit Discriminators (MED) across routes with different neighbor ASNs when using the STANDARD BGP best path selection algorithm.
routingConfig.bgpInterRegionCost

enum

Allows to define a preferred approach for handling inter-region cost in the selection process when using the STANDARD BGP best path selection algorithm. Can be DEFAULT or ADD_COST_TO_MED.
routingConfig.effectiveBgpAlwaysCompareMed

boolean

[Output Only] Effective value of the bgpAlwaysCompareMed field.
routingConfig.effectiveBgpInterRegionCost

enum

[Output Only] Effective value of the bgpInterRegionCost field.
mtu

integer

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

string

[Output Only] URL of the firewall policy the network is associated with.
networkFirewallPolicyEnforcementOrder

enum

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

boolean

Enable ULA internal ipv6 on this network. Enabling this feature will assign a /48 from google defined ULA prefix fd20::/20. .
internalIpv6Range

string

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

string

A full or partial URL of the network profile to apply to this network. This field can be set only at resource creation time. For example, the following are valid URLs:

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

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