Method: subnetworks.insert

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

HTTP request

POST https://compute.googleapis.com/compute/beta/projects/{project}/regions/{region}/subnetworks

The URL uses Google API HTTP annotation syntax.

Path parameters

Parameters
project

string

Project ID for this request.

region

string

Name of the region scoping this request.

Query parameters

Parameters
requestId

string

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Request body

The request body contains data with the following structure:

JSON representation
{
  "resource": {
    "id": string,
    "creationTimestamp": string,
    "name": string,
    "description": string,
    "network": string,
    "ipCidrRange": string,
    "gatewayAddress": string,
    "region": string,
    "selfLink": string,
    "privateIpGoogleAccess": boolean,
    "secondaryIpRanges": ,
    "fingerprint": string,
    "allowSubnetCidrRoutesOverlap": boolean,
    "kind": string
  },
}
Fields
resource

object

resource.id

string (fixed64 format)

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

resource.creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.

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

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

resource.network

string

The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. Only networks that are in the distributed mode can have subnetworks. This field can be set only at resource creation time.

Authorization requires the following Google IAM permission on the specified resource network:

  • compute.networks.updatePolicy

resource.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 192.168.0.0/16. Ranges must be unique and non-overlapping within a network. Only IPv4 is supported. This field can be set only at resource creation time.

resource.gatewayAddress

string

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

resource.region

string

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

resource.selfLink

string

[Output Only] Server-defined URL for the resource.

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

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

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

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

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

A base64-encoded string.

resource.allowSubnetCidrRoutesOverlap

boolean

Whether this subnetwork can conflict with static routes. Setting this to true allows this subnetwork's primary and secondary ranges to conflict with routes that have already been configured on the corresponding network. Static routes will take precedence over the subnetwork route if the route prefix length is at least as large as the subnetwork prefix length.

Also, packets destined to IPs within subnetwork may contain private/sensitive data and 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.

resource.kind

string

[Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources.

Response body

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

JSON representation
{
  "operation": {
    "id": string,
    "creationTimestamp": string,
    "name": string,
    "zone": string,
    "clientOperationId": string,
    "operationType": string,
    "targetLink": string,
    "targetId": string,
    "status": enum,
    "statusMessage": string,
    "user": string,
    "progress": number,
    "insertTime": string,
    "startTime": string,
    "endTime": string,
    "error": {
      "errors": [
        {
          "code": string,
          "location": string,
          "message": string
        }
      ]
    },
    "warnings": {
      "code": enum,
      "message": string,
      "data": [
        {
          "key": string,
          "value": string
        }
      ]
    },
    "httpErrorStatusCode": number,
    "httpErrorMessage": string,
    "selfLink": string,
    "region": string,
    "description": string,
    "kind": string
  },
}
Fields
operation

object

operation.id

string (fixed64 format)

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

operation.creationTimestamp

string

[Deprecated] This field is deprecated.

operation.name

string

[Output Only] Name of the resource.

operation.zone

string

[Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

operation.clientOperationId

string

[Output Only] Reserved for future use.

operation.operationType

string

[Output Only] The type of operation, such as insert, update, or delete, and so on.

operation.targetLink

string

[Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.

operation.targetId

string (fixed64 format)

[Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

operation.status

enum

[Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.

operation.statusMessage

string

[Output Only] An optional textual description of the current status of the operation.

operation.user

string

[Output Only] User who requested the operation, for example: user@example.com.

operation.progress

number

[Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.

operation.insertTime

string

[Output Only] The time that this operation was requested. This value is in RFC3339 text format.

operation.startTime

string

[Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

operation.endTime

string

[Output Only] The time that this operation was completed. This value is in RFC3339 text format.

operation.error

object

[Output Only] If errors are generated during processing of the operation, this field will be populated.

operation.error.errors[]

object

[Output Only] The array of errors encountered while processing this operation.

operation.error.errors[].code

string

[Output Only] The error type identifier for this error.

operation.error.errors[].location

string

[Output Only] Indicates the field in the request that caused the error. This property is optional.

operation.error.errors[].message

string

[Output Only] An optional, human-readable error message.

operation.warnings[]

object

[Output Only] If warning messages are generated during processing of the operation, this field will be populated.

operation.warnings[].code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

operation.warnings[].message

string

[Output Only] A human-readable description of the warning code.

operation.warnings[].data[]

object

[Output Only] Metadata about this warning in key: value format. For example:

"data": [  {  "key": "scope",  "value": "zones/us-east1-d"  }

operation.warnings[].data[].key

string

[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

operation.warnings[].data[].value

string

[Output Only] A warning data value corresponding to the key.

operation.httpErrorStatusCode

number

[Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.

operation.httpErrorMessage

string

[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.

operation.selfLink

string

[Output Only] Server-defined URL for the resource.

operation.region

string

[Output Only] The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

operation.description

string

[Output Only] A textual description of the operation, which is set when the operation is created.

operation.kind

string

[Output Only] Type of the resource. Always compute#operation for Operation resources.

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 Auth Guide.

IAM Permissions

In addition to any permissions specified on the fields above, authorization requires one or more of the following Google IAM permissions:

  • compute.subnetworks.create

Send feedback about...

Compute Engine