Instances: insert

Requires authorization

Creates an instance resource in the specified project using the data included in the request.

Request

HTTP request

POST https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances

Parameters

Parameter name Value Description
Path parameters
project string Project ID for this request.
zone string The name of the zone for this request.
Optional query 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).

Authorization

This request requires authorization with at least one of the following scopes (read more about authentication and authorization).

Scope
https://www.googleapis.com/auth/compute
https://www.googleapis.com/auth/cloud-platform

Request body

The following properties are required for creating a virtual machine instance, but aren't the only valid properties that you can set. For a full list of properties you can define, see the Instances resource page. However, at a minimum, you must define these properties to create a instance.

In the request body, supply an Instances resource with the following properties:

Property name Value Description Notes
Required Properties
name string The name of the resource, provided by the client when initially creating the resource. The resource 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.
machineType string Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type:

zones/us-central1-f/machineTypes/n1-standard-1

To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB):

zones/zone/machineTypes/custom-CPUS-MEMORY

For example: zones/us-central1-f/machineTypes/custom-4-5120

For a full list of restrictions, read the Specifications for custom machine types.
disks[].initializeParams.sourceImage string The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or disks.source is required.

To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:

projects/debian-cloud/global/images/family/debian-8

Alternatively, use a specific version of a public operating system image:

projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD

To create a disk with a private image that you created, specify the image name in the following format:

global/images/my-private-image

You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:

global/images/family/my-private-family

If the source image is deleted later, this field will not be set.
disks[].source string Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a new instance, one of initializeParams.sourceImage or disks.source is required.

If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks.

Note that for InstanceTemplate, specify the disk name, not the URL for the disk.
networkInterfaces[] list An array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Only one network interface is supported per instance.
networkInterfaces[].network string URL of the network resource for this instance. This is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used:

global/networks/default

If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
  • https://www.googleapis.com/compute/v1/projects/project/global/networks/network
  • projects/project/global/networks/network
  • global/networks/default
networkInterfaces[].accessConfigs[] list An array of configurations for this interface. Only one access config, ONE_TO_ONE_NAT, is supported per instance. If there are no accessConfigs specified, then this instance will have no external internet access.
networkInterfaces[].accessConfigs[].name string Name of this access configuration.
networkInterfaces[].accessConfigs[].type string The type of configuration. The default and only option is ONE_TO_ONE_NAT.

Response

If successful, this method returns a ZoneOperations resource in the response body.

{
  "kind": "compute#operation",
  "id": unsigned long,
  "creationTimestamp": string,
  "name": string,
  "zone": string,
  "clientOperationId": string,
  "operationType": string,
  "targetLink": string,
  "targetId": unsigned long,
  "status": string,
  "statusMessage": string,
  "user": string,
  "progress": integer,
  "insertTime": string,
  "startTime": string,
  "endTime": string,
  "error": {
    "errors": [
      {
        "code": string,
        "location": string,
        "message": string
      }
    ]
  },
  "warnings": [
    {
      "code": string,
      "message": string,
      "data": [
        {
          "key": string,
          "value": string
        }
      ]
    }
  ],
  "httpErrorStatusCode": integer,
  "httpErrorMessage": string,
  "selfLink": string,
  "region": string,
  "description": string
}
Property name Value Description Notes
kind string [Output Only] Type of the resource. Always compute#operation for Operation resources.
id unsigned long [Output Only] The unique identifier for the resource. This identifier is defined by the server.
creationTimestamp string [Deprecated] This field is deprecated.
name string [Output Only] Name of the resource.
zone string [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
clientOperationId string [Output Only] Reserved for future use.
operationType string [Output Only] The type of operation, such as insert, update, or delete, and so on.
targetId unsigned long [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
status string [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
statusMessage string [Output Only] An optional textual description of the current status of the operation.
user string [Output Only] User who requested the operation, for example: user@example.com.
progress integer [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.
insertTime string [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
startTime string [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
endTime string [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
error object [Output Only] If errors are generated during processing of the operation, this field will be populated.
error.errors[] list [Output Only] The array of errors encountered while processing this operation.
error.errors[].code string [Output Only] The error type identifier for this error.
error.errors[].location string [Output Only] Indicates the field in the request that caused the error. This property is optional.
error.errors[].message string [Output Only] An optional, human-readable error message.
warnings[] list [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
warnings[].code string [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
warnings[].message string [Output Only] A human-readable description of the warning code.
warnings[].data[] list [Output Only] Metadata about this warning in key: value format. For example:
"data": [ { "key": "scope", "value": "zones/us-east1-d" }
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).
warnings[].data[].value string [Output Only] A warning data value corresponding to the key.
httpErrorStatusCode integer [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.
httpErrorMessage string [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
region string [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
description string [Output Only] A textual description of the operation, which is set when the operation is created.

外出先でもリソースをモニタリング

Google Cloud Console アプリを入手して、プロジェクトの管理にお役立てください。

フィードバックを送信...