Returns the specified network. Gets a list of available networks by making a list()
request.
HTTP request
GET https://compute.googleapis.com/compute/v1/projects/{project}/global/networks/{resourceId}
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
project |
Project ID for this request. |
resourceId |
Name of the network to return. |
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
JSON representation | |
---|---|
{ "id": string, "creationTimestamp": string, "name": string, "description": string, "IPv4Range": string, "gatewayIPv4": string, "selfLink": string, "autoCreateSubnetworks": boolean, "subnetworks": [ string ], "peerings": [ { "name": string, "network": string, "state": enum, "stateDetails": string, "autoCreateRoutes": boolean, "exportCustomRoutes": boolean, "importCustomRoutes": boolean, "exchangeSubnetRoutes": boolean } ], "routingConfig": { "routingMode": enum }, "kind": string } |
Fields | |
---|---|
id |
[Output Only] The unique identifier for the resource. This identifier is defined by the server. |
creationTimestamp |
[Output Only] Creation timestamp in RFC3339 text format. |
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 `a-z?. 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 |
An optional description of this resource. Provide this field when you create the resource. |
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: |
gatewayIPv4 |
[Output Only] The gateway address for default routing out of the network, selected by GCP. |
selfLink |
[Output Only] Server-defined URL for the resource. |
autoCreateSubnetworks |
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. |
subnetworks[] |
[Output Only] Server-defined fully-qualified URLs for all subnetworks in this VPC network. |
peerings[] |
[Output Only] A list of network peerings for the resource. |
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 |
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. |
peerings[].state |
[Output Only] State for the peering, either |
peerings[].stateDetails |
[Output Only] Details about the current state of the peering. |
peerings[].autoCreateRoutes |
This field will be deprecated soon. Use the |
peerings[].exportCustomRoutes |
Whether to export the custom routes to peer network. |
peerings[].importCustomRoutes |
Whether to import the custom routes from peer network. |
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 |
routingConfig |
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 |
The network-wide routing mode to use. If set to |
kind |
[Output Only] Type of the resource. Always |
Authorization Scopes
Requires one of the following OAuth scopes:
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 Google IAM permissions:
compute.networks.get