REST Resource: subnetworks

Resource: Subnetwork

Represents a Subnetwork resource.

A subnetwork (also known as a subnet) is a logical partition of a Virtual Private Cloud network with one primary IP range and zero or more secondary IP ranges. For more information, read Virtual Private Cloud (VPC) Network.

JSON representation 
{
  "kind": string,
  "id": string,
  "creationTimestamp": string,
  "name": string,
  "description": string,
  "network": string,
  "ipCidrRange": string,
  "reservedInternalRange": string,
  "gatewayAddress": string,
  "region": string,
  "selfLink": string,
  "privateIpGoogleAccess": boolean,
  "secondaryIpRanges": [
    {
      object (SubnetworkSecondaryRange)
    }
  ],
  "fingerprint": string,
  "enableFlowLogs": boolean,
  "privateIpv6GoogleAccess": enum (PrivateIpv6GoogleAccess),
  "ipv6CidrRange": string,
  "externalIpv6Prefix": string,
  "internalIpv6Prefix": string,
  "purpose": enum (Purpose),
  "role": enum (Role),
  "state": enum (State),
  "logConfig": {
    object (LogConfig)
  },
  "stackType": enum (StackType),
  "ipv6AccessType": enum (Ipv6AccessType),
  "ipCollection": string,
  "ipv6GceEndpoint": enum (Ipv6GceEndpoint),
  "params": {
    object (SubnetworkParams)
  },
  "systemReservedInternalIpv6Ranges": [
    string
  ],
  "systemReservedExternalIpv6Ranges": [
    string
  ]
}
Fields
kind

string

[Output Only] Type of the resource. Always

compute#subnetwork

for Subnetwork resources.
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

The name of the resource, provided by the client when initially creating the resource. 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])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
description

string

An optional description of this resource. Provide this property when you create the resource. This field can be set only at resource creation time.
network

string

The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. This field can be set only at resource creation time.
ipCidrRange

string

The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example,

10.0.0.0/8

or

100.64.0.0/10

. Ranges must be unique and non-overlapping within a network. Only IPv4 is supported. This field is set at resource creation time. The range can be any range listed in the Valid ranges list. The range can be expanded after creation using

expandIpCidrRange

.
reservedInternalRange

string

The URL of the reserved internal range.
gatewayAddress

string

[Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork.
region

string

URL of the region where the Subnetwork resides. This field can be set only at resource creation time.
privateIpGoogleAccess

boolean

Whether the VMs in this subnet can access Trusted Cloud services without assigned external IP addresses. This field can be both set at resource creation time and updated using

setPrivateIpGoogleAccess

.
secondaryIpRanges[]

object (SubnetworkSecondaryRange)

An array of configurations for secondary IP ranges for VM instances contained in this subnetwork. The primary IP of such VM must belong to the primary ipCidrRange of the subnetwork. The alias IPs may belong to either primary or secondary ranges. This field can be updated with a

patch

request.
fingerprint

string (bytes format)

Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a

Subnetwork

. An up-to-date fingerprint must be provided in order to update the

Subnetwork

, otherwise the request will fail with error

412 conditionNotMet

.

To see the latest fingerprint, make a

get()

request to retrieve a Subnetwork.

A base64-encoded string.
enableFlowLogs

boolean

Whether to enable flow logging for this subnetwork. If this field is not explicitly set, it will not appear in

get

listings. If not set the default behavior is determined by the org policy, if there is no org policy specified, then it will default to disabled. This field isn't supported if the subnet

purpose

field is set to

REGIONAL_MANAGED_PROXY

.
privateIpv6GoogleAccess

enum (PrivateIpv6GoogleAccess)

This field is for internal use.

This field can be both set at resource creation time and updated using

patch

.
ipv6CidrRange

string

[Output Only] This field is for internal use.
externalIpv6Prefix

string

The external IPv6 address range that is owned by this subnetwork.
internalIpv6Prefix

string

The internal IPv6 address range that is owned by this subnetwork.
purpose

enum (Purpose)
role

enum (Role)

The role of subnetwork. Currently, this field is only used when purpose is set to

GLOBAL_MANAGED_PROXY

or

REGIONAL_MANAGED_PROXY

. The value can be set to

ACTIVE

or

BACKUP

. An

ACTIVE

subnetwork is one that is currently being used for Envoy-based load balancers in a region. A

BACKUP

subnetwork is one that is ready to be promoted to

ACTIVE

or is currently draining. This field can be updated with a

patch

request.
state

enum (State)

[Output Only] The state of the subnetwork, which can be one of the following values:

READY

: Subnetwork is created and ready to use

DRAINING

: only applicable to subnetworks that have the purpose set to

INTERNAL_HTTPS_LOAD_BALANCER

and indicates that connections to the load balancer are being drained. A subnetwork that is draining cannot be used or modified until it reaches a status of

READY
logConfig

object (LogConfig)

This field denotes the VPC flow logging options for this subnetwork. If logging is enabled, logs are exported to Cloud Logging.
stackType

enum (StackType)

The stack type for the subnet. If set to

IPV4_ONLY

, new VMs in the subnet are assigned IPv4 addresses only. If set to

IPV4_IPV6

, new VMs in the subnet can be assigned both IPv4 and IPv6 addresses. If not specified,

IPV4_ONLY

is used.

This field can be both set at resource creation time and updated using

patch

.
ipv6AccessType

enum (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.
ipCollection

string

Reference to the source of IP, like a

PublicDelegatedPrefix

(PDP) for BYOIP. The PDP must be a sub-PDP in EXTERNAL_IPV6_SUBNETWORK_CREATION mode.

Use one of the following formats to specify a sub-PDP when creating a dual stack subnetwork with external access using BYOIP:

  • Full resource URL, as in

    https://www.googleapis.com/compute/v1/projects/projectId/regions/region/publicDelegatedPrefixes/sub-pdp-name

  • Partial URL, as in
    • projects/projectId/regions/region/publicDelegatedPrefixes/sub-pdp-name
    • regions/region/publicDelegatedPrefixes/sub-pdp-name
ipv6GceEndpoint

enum (Ipv6GceEndpoint)

[Output Only] Possible endpoints of this subnetwork. It can be one of the following:

  • VM_ONLY

    : The subnetwork can be used for creating instances and IPv6 addresses with VM endpoint type. Such a subnetwork gets external IPv6 ranges from a public delegated prefix and cannot be used to create NetLb.

  • VM_AND_FR

    : The subnetwork can be used for creating both VM instances and Forwarding Rules. It can also be used to reserve IPv6 addresses with both VM and FR endpoint types. Such a subnetwork gets its IPv6 range from Trusted Cloud IP Pool directly.

params

object (SubnetworkParams)

Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload.
systemReservedInternalIpv6Ranges[]

string

Output only. [Output Only] The array of internal IPv6 network ranges reserved from the subnetwork's internal IPv6 range for system use.
systemReservedExternalIpv6Ranges[]

string

Output only. [Output Only] The array of external IPv6 network ranges reserved from the subnetwork's external IPv6 range for system use.

SubnetworkSecondaryRange

Represents a secondary IP range of a subnetwork.

JSON representation 
{
  "rangeName": string,
  "ipCidrRange": string,
  "reservedInternalRange": string
}
Fields
rangeName

string

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

string

The range of IP addresses belonging to this subnetwork secondary range. Provide this property when you create the subnetwork. Ranges must be unique and non-overlapping with all primary and secondary IP ranges within a network. Only IPv4 is supported. The range can be any range listed in the Valid ranges list.
reservedInternalRange

string

The URL of the reserved internal range.

PrivateIpv6GoogleAccess

Enums
DISABLE_GOOGLE_ACCESS Disable private IPv6 access to/from Trusted Cloud services.
ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE Outbound private IPv6 access from VMs in this subnet to Trusted Cloud services.
ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE Bidirectional private IPv6 access to/from Trusted Cloud services.

Role

Enums
ACTIVE The ACTIVE subnet that is currently used.
BACKUP The BACKUP subnet that could be promoted to ACTIVE.

State

Enums
READY Subnetwork is ready for use.
DRAINING Subnetwork is being drained.

LogConfig

The available logging options for this subnetwork.

JSON representation 
{
  "enable": boolean,
  "aggregationInterval": enum (AggregationInterval),
  "flowSampling": number,
  "metadata": enum (Metadata),
  "metadataFields": [
    string
  ],
  "filterExpr": string
}
Fields
enable

boolean

Whether to enable flow logging for this subnetwork. If this field is not explicitly set, it will not appear in

get

listings. If not set the default behavior is determined by the org policy, if there is no org policy specified, then it will default to disabled. Flow logging isn't supported if the subnet

purpose

field is set to

REGIONAL_MANAGED_PROXY

.
aggregationInterval

enum (AggregationInterval)

Can only be specified if VPC flow logging for this subnetwork is enabled. Toggles the aggregation interval for collecting flow logs. Increasing the interval time will reduce the amount of generated flow logs for long lasting connections. Default is an interval of 5 seconds per connection.
flowSampling

number

Can only be specified if VPC flow logging for this subnetwork is enabled. The value of the field must be in [0, 1]. Set the sampling rate of VPC flow logs within the subnetwork where 1.0 means all collected logs are reported and 0.0 means no logs are reported. Default is 0.5 unless otherwise specified by the org policy, which means half of all collected logs are reported.
metadata

enum (Metadata)

Can only be specified if VPC flow logs for this subnetwork is enabled. Configures whether all, none or a subset of metadata fields should be added to the reported VPC flow logs. Default is

EXCLUDE_ALL_METADATA

.
metadataFields[]

string

Can only be specified if VPC flow logs for this subnetwork is enabled and "metadata" was set to CUSTOM_METADATA.
filterExpr

string

Can only be specified if VPC flow logs for this subnetwork is enabled. The filter expression is used to define which VPC flow logs should be exported to Cloud Logging.

AggregationInterval

Enums
INTERVAL_5_SEC
INTERVAL_30_SEC
INTERVAL_1_MIN
INTERVAL_5_MIN
INTERVAL_10_MIN
INTERVAL_15_MIN

Metadata

Enums
INCLUDE_ALL_METADATA
EXCLUDE_ALL_METADATA
CUSTOM_METADATA

Ipv6AccessType

Enums
INTERNAL VMs on this subnet will be assigned IPv6 addresses that are only accessible over the VPC network.
EXTERNAL VMs on this subnet will be assigned IPv6 addresses that are accessible via the Internet, as well as the VPC network.

Ipv6GceEndpoint

Enums
VM_AND_FR
VM_ONLY

SubnetworkParams

Additional subnetwork parameters.

JSON representation 
{
  "resourceManagerTags": {
    string: string,
    ...
  }
}
Fields
resourceManagerTags

map (key: string, value: string)

Tag keys/values directly bound to this resource. Tag keys and values have the same definition as resource manager tags. The field is allowed for INSERT only. The keys/values to set on the resource should be specified in either ID { : } or Namespaced format { : }. For example the following are valid inputs: * {"tagKeys/333" : "tagValues/444", "tagKeys/123" : "tagValues/456"} * {"123/environment" : "production", "345/abc" : "xyz"} Note: * Invalid combinations of ID & namespaced format is not supported. For instance: {"123/environment" : "tagValues/444"} is invalid.

Methods

aggregatedList

 The method compute.v1.SubnetworksService.AggregatedList is not available in Trusted Cloud by S3NS.

delete

 The method compute.v1.SubnetworksService.Delete is not available in Trusted Cloud by S3NS.

expandIpCidrRange

 The method compute.v1.SubnetworksService.ExpandIpCidrRange is not available in Trusted Cloud by S3NS.

get

 The method compute.v1.SubnetworksService.Get is not available in Trusted Cloud by S3NS.

getIamPolicy

 The method compute.v1.SubnetworksService.GetPolicy is not available in Trusted Cloud by S3NS.

insert

 The method compute.v1.SubnetworksService.Insert is not available in Trusted Cloud by S3NS.

list

 The method compute.v1.SubnetworksService.List is not available in Trusted Cloud by S3NS.

listUsable

 The method compute.v1.SubnetworksService.ListUsable is not available in Trusted Cloud by S3NS.

patch

 The method compute.v1.SubnetworksService.Patch is not available in Trusted Cloud by S3NS.

setIamPolicy

 The method compute.v1.SubnetworksService.SetPolicy is not available in Trusted Cloud by S3NS.

setPrivateIpGoogleAccess

 The method compute.v1.SubnetworksService.SetPrivateIpGoogleAccess is not available in Trusted Cloud by S3NS.

testIamPermissions

 The method compute.v1.SubnetworksService.TestPermissions is not available in Trusted Cloud by S3NS.