Get
|
|||||
|
|
Returns the specified network. Gets a list of available networks by making a list() request
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- View and manage your data across Google Cloud Platform services
- View and manage your Google Compute Engine resources
- View your Google Compute Engine resources
Input
This building block consumes 2 input parameters
Name | Format | Description |
---|---|---|
project Required |
STRING |
Project ID for this request |
network Required |
STRING |
Name of the network to return |
= Parameter name
= Format
project STRING Required Project ID for this request |
network STRING Required Name of the network to return |
Output
This building block provides 19 output parameters
Name | Format | Description |
---|---|---|
IPv4Range |
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 |
autoCreateSubnetworks |
BOOLEAN |
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 |
creationTimestamp |
STRING |
[Output Only] Creation timestamp in RFC3339 text format |
description |
STRING |
An optional description of this resource. Provide this field when you create the resource |
gatewayIPv4 |
STRING |
[Output Only] The gateway address for default routing out of the network, selected by GCP |
id |
INTEGER |
[Output Only] The unique identifier for the resource. This identifier is defined by the server |
kind |
STRING |
[Output Only] Type of the resource. Always compute#network for networks |
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?. 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 |
peerings[] |
OBJECT |
A network peering attached to a network resource. The message includes the peering name, peer network, peering state, and a flag indicating whether Google Compute Engine should automatically create routes for the peering |
peerings[].autoCreateRoutes |
BOOLEAN |
This field will be deprecated soon. Use the exchange_subnet_routes field instead. Indicates whether full mesh connectivity is created and managed automatically. When it is set to true, Google Compute Engine will automatically create and manage the routes between two networks when the state is ACTIVE. Otherwise, user needs to create routes manually to route packets to peer network |
peerings[].exchangeSubnetRoutes |
BOOLEAN |
Whether full mesh connectivity is created and managed automatically. When it is set to true, Google Compute Engine will automatically create and manage the routes between two networks when the peering state is ACTIVE. Otherwise, user needs to create routes manually to route packets to peer network |
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 |
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 |
ENUMERATION |
[Output Only] State for the peering, either |
peerings[].stateDetails |
STRING |
[Output Only] Details about the current state of the peering |
routingConfig |
OBJECT |
A routing configuration attached to a network resource. The message includes the list of routers associated with the network, and a flag indicating the type of routing behavior to enforce network-wide |
routingConfig.routingMode |
ENUMERATION |
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 |
selfLink |
STRING |
[Output Only] Server-defined URL for the resource |
subnetworks[] |
STRING |
= Parameter name
= Format
IPv4Range 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 |
autoCreateSubnetworks BOOLEAN 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 |
creationTimestamp STRING [Output Only] Creation timestamp in RFC3339 text format |
description STRING An optional description of this resource. Provide this field when you create the resource |
gatewayIPv4 STRING [Output Only] The gateway address for default routing out of the network, selected by GCP |
id INTEGER [Output Only] The unique identifier for the resource. This identifier is defined by the server |
kind STRING [Output Only] Type of the resource. Always compute#network for networks |
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?. 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 |
peerings[] OBJECT A network peering attached to a network resource. The message includes the peering name, peer network, peering state, and a flag indicating whether Google Compute Engine should automatically create routes for the peering |
peerings[].autoCreateRoutes BOOLEAN This field will be deprecated soon. Use the exchange_subnet_routes field instead. Indicates whether full mesh connectivity is created and managed automatically. When it is set to true, Google Compute Engine will automatically create and manage the routes between two networks when the state is ACTIVE. Otherwise, user needs to create routes manually to route packets to peer network |
peerings[].exchangeSubnetRoutes BOOLEAN Whether full mesh connectivity is created and managed automatically. When it is set to true, Google Compute Engine will automatically create and manage the routes between two networks when the peering state is ACTIVE. Otherwise, user needs to create routes manually to route packets to peer network |
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 |
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 ENUMERATION [Output Only] State for the peering, either |
peerings[].stateDetails STRING [Output Only] Details about the current state of the peering |
routingConfig OBJECT A routing configuration attached to a network resource. The message includes the list of routers associated with the network, and a flag indicating the type of routing behavior to enforce network-wide |
routingConfig.routingMode ENUMERATION 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 |
selfLink STRING [Output Only] Server-defined URL for the resource |
subnetworks[] STRING |