Console
    Contact Us Start free

    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" 
 : 
 [ 
 { 
 "rangeName" 
 : 
 string 
 , 
 "ipCidrRange" 
 : 
 string 
 , 
 "reservedInternalRange" 
 : 
 string 
 } 
 ] 
 , 
 "fingerprint" 
 : 
 string 
 , 
 "allowSubnetCidrRoutesOverlap" 
 : 
 boolean 
 , 
 "enableFlowLogs" 
 : 
 boolean 
 , 
 "privateIpv6GoogleAccess" 
 : 
 enum 
 , 
 "ipv6CidrRange" 
 : 
 string 
 , 
 "externalIpv6Prefix" 
 : 
 string 
 , 
 "internalIpv6Prefix" 
 : 
 string 
 , 
 "purpose" 
 : 
 enum 
 , 
 "role" 
 : 
 enum 
 , 
 "state" 
 : 
 enum 
 , 
 "logConfig" 
 : 
 { 
 "enable" 
 : 
 boolean 
 , 
 "aggregationInterval" 
 : 
 enum 
 , 
 "flowSampling" 
 : 
 number 
 , 
 "metadata" 
 : 
 enum 
 , 
 "metadataFields" 
 : 
 [ 
 string 
 ] 
 , 
 "filterExpr" 
 : 
 string 
 } 
 , 
 "stackType" 
 : 
 enum 
 , 
 "ipv6AccessType" 
 : 
 enum 
 , 
 "ipCollection" 
 : 
 string 
 , 
 "ipv6GceEndpoint" 
 : 
 enum 
 , 
 "params" 
 : 
 { 
 "resourceManagerTags" 
 : 
 { 
 string 
 : 
 string 
 , 
 ... 
 } 
 } 
 , 
 "utilizationDetails" 
 : 
 { 
 "ipv4Utilizations" 
 : 
 [ 
 { 
 "rangeName" 
 : 
 string 
 , 
 "totalAllocatedIp" 
 : 
 string 
 , 
 "totalFreeIp" 
 : 
 string 
 } 
 ] 
 , 
 "externalIpv6InstanceUtilization" 
 : 
 { 
 "totalAllocatedIp" 
 : 
 { 
 "high" 
 : 
 string 
 , 
 "low" 
 : 
 string 
 } 
 , 
 "totalFreeIp" 
 : 
 { 
 "high" 
 : 
 string 
 , 
 "low" 
 : 
 string 
 } 
 } 
 , 
 "externalIpv6LbUtilization" 
 : 
 { 
 "totalAllocatedIp" 
 : 
 { 
 "high" 
 : 
 string 
 , 
 "low" 
 : 
 string 
 } 
 , 
 "totalFreeIp" 
 : 
 { 
 "high" 
 : 
 string 
 , 
 "low" 
 : 
 string 
 } 
 } 
 , 
 "internalIpv6Utilization" 
 : 
 { 
 "totalAllocatedIp" 
 : 
 { 
 "high" 
 : 
 string 
 , 
 "low" 
 : 
 string 
 } 
 , 
 "totalFreeIp" 
 : 
 { 
 "high" 
 : 
 string 
 , 
 "low" 
 : 
 string 
 } 
 } 
 } 
 , 
 "systemReservedInternalIpv6Ranges" 
 : 
 [ 
 string 
 ] 
 , 
 "systemReservedExternalIpv6Ranges" 
 : 
 [ 
 string 
 ] 
 , 
 "resolveSubnetMask" 
 : 
 enum 
 }
    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 Google services without assigned external IP addresses. This field can be both set at resource creation time and updated using setPrivateIpGoogleAccess .

    secondaryIpRanges[]

    object

    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.

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

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

    secondaryIpRanges[].reservedInternalRange

    string

    The URL of the reserved internal range.

    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.

    allowSubnetCidrRoutesOverlap

    boolean

    Whether this subnetwork's ranges can conflict with existing static routes. Setting this to true allows this subnetwork's primary and secondary ranges to overlap with (and contain) static routes that have already been configured on the corresponding network.

    For example if a static route has range 10.1.0.0/16, a subnet range 10.0.0.0/8 could only be created if allowConflictingRoutes=true.

    Overlapping is only allowed on subnetwork operations; routes whose ranges conflict with this subnetwork's ranges won't be allowed unless route.allow_conflicting_subnetworks is set to true.

    Typically packets destined to IPs within the subnetwork (which may contain private/sensitive data) are prevented from leaving the virtual network. Setting this field to true will disable this feature.

    The default value is false and applies to all existing subnetworks and automatically created subnetworks.

    This field cannot be set to true at resource creation time.

    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

    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

    role

    enum

    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

    [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

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

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

    logConfig.aggregationInterval

    enum

    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.

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

    logConfig.metadata

    enum

    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 .

    logConfig.metadataFields[]

    string

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

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

    stackType

    enum

    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

    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

    [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 Google IP Pool directly.
    params

    object

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

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

    utilizationDetails

    object

    Output only. [Output Only] The current IP utilization of all subnetwork ranges. Contains the total number of allocated and free IPs in each range.

    utilizationDetails.ipv4Utilizations[]

    object

    Utilizations of all IPV4 IP ranges. For primary ranges, the range name will be empty.

    utilizationDetails.ipv4Utilizations[].rangeName

    string

    Will be set for secondary range. Empty for primary IPv4 range.

    utilizationDetails.ipv4Utilizations[].totalAllocatedIp

    string ( int64 format)

    utilizationDetails.ipv4Utilizations[].totalFreeIp

    string ( int64 format)

    utilizationDetails.externalIpv6InstanceUtilization

    object

    Utilizations of external IPV6 IP range.

    utilizationDetails.externalIpv6InstanceUtilization.totalAllocatedIp

    object

    utilizationDetails.externalIpv6InstanceUtilization.totalAllocatedIp.high

    string ( uint64 format)

    utilizationDetails.externalIpv6InstanceUtilization.totalAllocatedIp.low

    string ( uint64 format)

    utilizationDetails.externalIpv6InstanceUtilization.totalFreeIp

    object

    utilizationDetails.externalIpv6InstanceUtilization.totalFreeIp.high

    string ( uint64 format)

    utilizationDetails.externalIpv6InstanceUtilization.totalFreeIp.low

    string ( uint64 format)

    utilizationDetails.externalIpv6LbUtilization

    object

    Utilizations of external IPV6 IP range for NetLB.

    utilizationDetails.externalIpv6LbUtilization.totalAllocatedIp

    object

    utilizationDetails.externalIpv6LbUtilization.totalAllocatedIp.high

    string ( uint64 format)

    utilizationDetails.externalIpv6LbUtilization.totalAllocatedIp.low

    string ( uint64 format)

    utilizationDetails.externalIpv6LbUtilization.totalFreeIp

    object

    utilizationDetails.externalIpv6LbUtilization.totalFreeIp.high

    string ( uint64 format)

    utilizationDetails.externalIpv6LbUtilization.totalFreeIp.low

    string ( uint64 format)

    utilizationDetails.internalIpv6Utilization

    object

    Utilizations of internal IPV6 IP range.

    utilizationDetails.internalIpv6Utilization.totalAllocatedIp

    object

    utilizationDetails.internalIpv6Utilization.totalAllocatedIp.high

    string ( uint64 format)

    utilizationDetails.internalIpv6Utilization.totalAllocatedIp.low

    string ( uint64 format)

    utilizationDetails.internalIpv6Utilization.totalFreeIp

    object

    utilizationDetails.internalIpv6Utilization.totalFreeIp.high

    string ( uint64 format)

    utilizationDetails.internalIpv6Utilization.totalFreeIp.low

    string ( uint64 format)

    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.

    resolveSubnetMask

    enum

    Configures subnet mask resolution for this subnetwork.

    Methods

    aggregatedList

    		Retrieves an aggregated list of subnetworks.

    delete

    		Deletes the specified subnetwork.

    expandIpCidrRange

    		Expands the IP CIDR range of the subnetwork to a specified value.

    get

    		Returns the specified subnetwork.

    getIamPolicy

    		Gets the access control policy for a resource.

    insert

    		Creates a subnetwork in the specified project using the data included in the request.

    list

    		Retrieves a list of subnetworks available to the specified project.

    listUsable

    		Retrieves an aggregated list of all usable subnetworks in the project.

    patch

    		Patches the specified subnetwork with the data included in the request.

    setIamPolicy

    		Sets the access control policy on the specified resource.

    setPrivateIpGoogleAccess

    		Set whether VMs in this subnet can access Google services without assigning external IP addresses through Private Google Access.

    testIamPermissions

    		Returns permissions that a caller has on the specified resource.
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: