| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="compute_alpha.html">Compute Engine API</a> . <a href="compute_alpha.regionInstances.html">regionInstances</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#bulkInsert">bulkInsert(project, region, body=None, requestId=None)</a></code></p> |
| <p class="firstline">Creates multiple instances in a given region. Count specifies the number of instances to create.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="bulkInsert">bulkInsert(project, region, body=None, requestId=None)</code> |
| <pre>Creates multiple instances in a given region. Count specifies the number of instances to create. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| region: string, The name of the region for this request. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { |
| "count": "A String", # The maximum number of instances to create. |
| "instance": { # Represents an Instance resource. |
| # |
| # An instance is a virtual machine that is hosted on Google Cloud Platform. For more information, read Virtual Machine Instances. (== resource_for {$api_version}.instances ==) |
| "canIpForward": True or False, # Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding. |
| "confidentialInstanceConfig": { # A set of Confidential Instance options. |
| "enableConfidentialCompute": True or False, # Defines whether the instance should have confidential compute enabled. |
| }, |
| "cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance. |
| "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. |
| "deletionProtection": True or False, # Whether the resource should be protected against deletion. |
| "description": "A String", # An optional description of this resource. Provide this property when you create the resource. |
| "disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them. |
| { # An instance-attached disk resource. |
| "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance). |
| "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem. |
| "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance. |
| # |
| # If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks. |
| "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts a disk using a customer-supplied encryption key. |
| # |
| # If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key. |
| # |
| # If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance. |
| # |
| # If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later. |
| # |
| # Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group. |
| "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. |
| "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. |
| "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. |
| "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. |
| # |
| # The key must meet the following requirements before you can provide it to Compute Engine: |
| # - The key is wrapped using a RSA public key certificate provided by Google. |
| # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: |
| # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem |
| "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. |
| }, |
| "diskSizeGb": "A String", # The size of the disk in GB. |
| "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. |
| { # Guest OS features. |
| "type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options. |
| }, |
| ], |
| "index": 42, # [Output Only] A zero-based index to this disk, where 0 is reserved for the boot disk. If you have many disks attached to an instance, each disk would have a unique index number. |
| "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. |
| # |
| # This property is mutually exclusive with the source property; you can only define one or the other, but not both. |
| # |
| # This property is mutually exclusive with the source property; you can only define one or the other, but not both. |
| "description": "A String", # An optional description. Provide this property when creating the disk. |
| "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance. If a disk with the same name already exists in the given region, the existing disk is attached to the new instance and the new disk is not created. |
| "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. The size must be at least 10 GB. If you specify a sourceImage, which is required for boot disks, the default size is the size of the sourceImage. If you do not specify a sourceImage, the default disk size is 500 GB. |
| "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example: |
| # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard |
| # |
| # |
| # Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values: |
| # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType |
| # - projects/project/zones/zone/diskTypes/diskType |
| # - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL. |
| "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. |
| # |
| # Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures |
| { # Guest OS features. |
| "type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options. |
| }, |
| ], |
| "labels": { # Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks. |
| "a_key": "A String", |
| }, |
| "multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to more than one instance. |
| "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk. |
| "replicaZones": [ # URLs of the zones where the disk should be replicated to. Only applicable for regional resources. |
| "A String", |
| ], |
| "resourcePolicies": [ # Resource policies applied to this disk for automatic snapshot creations. Specified using the full or partial URL. For instance template, specify only the resource policy name. |
| "A String", |
| ], |
| "sourceImage": "A String", # The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD. |
| # |
| # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image: |
| # projects/debian-cloud/global/images/family/debian-9 |
| # |
| # |
| # Alternatively, use a specific version of a public operating system image: |
| # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD |
| # |
| # |
| # To create a disk with a custom image that you created, specify the image name in the following format: |
| # global/images/my-custom-image |
| # |
| # |
| # You can also specify a custom 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-image-family |
| # |
| # |
| # If the source image is deleted later, this field will not be set. |
| "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. |
| # |
| # Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys. |
| "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. |
| "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. |
| "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. |
| "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. |
| # |
| # The key must meet the following requirements before you can provide it to Compute Engine: |
| # - The key is wrapped using a RSA public key certificate provided by Google. |
| # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: |
| # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem |
| "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. |
| }, |
| "sourceSnapshot": "A String", # The source snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceImage or disks.source is required except for local SSD. |
| # |
| # To create a disk with a snapshot that you created, specify the snapshot name in the following format: |
| # global/snapshots/my-backup |
| # |
| # |
| # If the source snapshot is deleted later, this field will not be set. |
| "sourceSnapshotEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source snapshot. |
| "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. |
| "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. |
| "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. |
| "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. |
| # |
| # The key must meet the following requirements before you can provide it to Compute Engine: |
| # - The key is wrapped using a RSA public key certificate provided by Google. |
| # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: |
| # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem |
| "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. |
| }, |
| }, |
| "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance. |
| "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks. |
| "licenses": [ # [Output Only] Any valid publicly visible licenses. |
| "A String", |
| ], |
| "mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode. |
| "savedState": "A String", # For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this field is set to PRESERVED if the LocalSSD data has been saved to a persistent location by customer request. (see the discard_local_ssd option on Stop/Suspend). Read-only in the api. |
| "shieldedInstanceInitialState": { # Initial State for shielded instance, these are public keys which are safe to store in public # [Output Only] shielded vm initial state stored on disk |
| "dbs": [ # The Key Database (db). |
| { |
| "content": "A String", # The raw content in the secure keys file. |
| "fileType": "A String", # The file type of source file. |
| }, |
| ], |
| "dbxs": [ # The forbidden key database (dbx). |
| { |
| "content": "A String", # The raw content in the secure keys file. |
| "fileType": "A String", # The file type of source file. |
| }, |
| ], |
| "keks": [ # The Key Exchange Key (KEK). |
| { |
| "content": "A String", # The raw content in the secure keys file. |
| "fileType": "A String", # The file type of source file. |
| }, |
| ], |
| "pk": { # The Platform Key (PK). |
| "content": "A String", # The raw content in the secure keys file. |
| "fileType": "A String", # The file type of source file. |
| }, |
| }, |
| "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD. |
| # |
| # 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. |
| "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT. |
| }, |
| ], |
| "displayDevice": { # A set of Display Device options # Enables display device for the instance. |
| "enableDisplay": True or False, # Defines whether the instance has Display enabled. |
| }, |
| "eraseWindowsVssSignature": True or False, # Specifies whether the disks restored from source snapshots or source machine image should erase Windows specific VSS signature. |
| "fingerprint": "A String", # Specifies a fingerprint for this resource, which is essentially a hash of the instance's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update the instance. You must always provide an up-to-date fingerprint hash in order to update the instance. |
| # |
| # To see the latest fingerprint, make get() request to the instance. |
| "guestAccelerators": [ # A list of the type and count of accelerator cards attached to the instance. |
| { # A specification of the type and number of accelerator cards attached to the instance. |
| "acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance. |
| "acceleratorType": "A String", # Full or partial URL of the accelerator type resource to attach to this instance. For example: projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100 If you are creating an instance template, specify only the accelerator name. See GPUs on Compute Engine for a full list of accelerator types. |
| }, |
| ], |
| "hostname": "A String", # Specifies the hostname of the instance. The specified hostname must be RFC1035 compliant. If hostname is not specified, the default hostname is [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global DNS, and [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS. |
| "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. |
| "instanceEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts data for an instance with a customer-supplied encryption key. |
| # |
| # If you are creating a new instance, this field encrypts the local SSD and in-memory contents of the instance using a key that you provide. |
| # |
| # If you are restarting an instance protected with a customer-supplied encryption key, you must provide the correct key in order to successfully restart the instance. |
| # |
| # If you do not provide an encryption key when creating the instance, then the local SSD and in-memory contents will be encrypted using an automatically generated key and you do not need to provide a key to start the instance later. |
| # |
| # Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt local SSDs and in-memory content in a managed instance group. |
| "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. |
| "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. |
| "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. |
| "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. |
| # |
| # The key must meet the following requirements before you can provide it to Compute Engine: |
| # - The key is wrapped using a RSA public key certificate provided by Google. |
| # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: |
| # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem |
| "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. |
| }, |
| "kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances. |
| "labelFingerprint": "A String", # A fingerprint for this request, which is essentially a hash of the label's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. |
| # |
| # To see the latest fingerprint, make get() request to the instance. |
| "labels": { # Labels to apply to this instance. These can be later modified by the setLabels method. |
| "a_key": "A String", |
| }, |
| "lastStartTimestamp": "A String", # [Output Only] Last start timestamp in RFC3339 text format. |
| "lastStopTimestamp": "A String", # [Output Only] Last stop timestamp in RFC3339 text format. |
| "lastSuspendedTimestamp": "A String", # [Output Only] Last suspended timestamp in RFC3339 text format. |
| "machineType": "A 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. |
| "metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys. |
| "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. |
| # |
| # To see the latest fingerprint, make a get() request to retrieve the resource. |
| "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB. |
| { |
| "key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project. |
| "value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 262144 bytes (256 KiB). |
| }, |
| ], |
| "kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata. |
| }, |
| "minCpuPlatform": "A String", # Specifies a minimum CPU platform for the VM instance. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: "Intel Haswell" or minCpuPlatform: "Intel Sandy Bridge". |
| "name": "A 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. |
| "networkInterfaces": [ # An array of network configurations for this instance. These specify how interfaces are configured to interact with other network services, such as connecting to the internet. Multiple interfaces are supported per instance. |
| { # A network interface resource attached to an instance. |
| "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access. |
| { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. |
| "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. |
| "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. |
| "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. |
| "networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD. |
| # |
| # If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier. |
| # |
| # If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP. |
| "publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance. |
| "publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled. |
| "setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration. |
| "setPublicPtr": True or False, # Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name. |
| "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT. |
| }, |
| ], |
| "aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks. |
| { # An alias IP range attached to an instance's network interface. |
| "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. This range may be a single IP address (such as 10.2.3.4), a netmask (such as /24) or a CIDR-formatted string (such as 10.1.2.0/24). |
| "subnetworkRangeName": "A String", # The name of a subnetwork secondary IP range from which to allocate an IP alias range. If not specified, the primary range of the subnetwork is used. |
| }, |
| ], |
| "fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface, otherwise the request will fail with error 412 conditionNotMet. |
| "ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface. |
| "kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. |
| "name": "A String", # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc. |
| "network": "A String", # URL of the network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used; if the network is not specified but the subnetwork is specified, the network is inferred. |
| # |
| # 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 |
| "networkIP": "A String", # An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system. |
| "subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not specify this field. If the network is in auto subnet mode, specifying the subnetwork is optional. If the network is in custom subnet mode, specifying the subnetwork is required. If you specify this field, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: |
| # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork |
| # - regions/region/subnetworks/subnetwork |
| }, |
| ], |
| "postKeyRevocationActionType": "A String", # Specifies whether this instance will be shut down on key revocation. |
| "preservedStateSizeGb": "A String", # Total amount of preserved state for SUSPENDED instances. Read-only in the api. |
| "privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default. |
| "reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from. |
| "consumeReservationType": "A String", # Specifies the type of reservation from which this instance can consume resources: ANY_RESERVATION (default), SPECIFIC_RESERVATION, or NO_RESERVATION. See Consuming reserved instances for examples. |
| "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify googleapis.com/reservation-name as the key and specify the name of your reservation as its value. |
| "values": [ # Corresponds to the label values of a reservation resource. |
| "A String", |
| ], |
| }, |
| "resourcePolicies": [ # Resource policies applied to this instance. |
| "A String", |
| ], |
| "scheduling": { # Sets the scheduling options for an Instance. NextID: 12 # Sets the scheduling options for this instance. |
| "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. |
| # |
| # By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. |
| "latencyTolerant": True or False, # Defines whether the instance is tolerant of higher cpu latency. This can only be set during instance creation, or when the instance is not currently running. It must not be set if the preemptible option is also set. |
| "locationHint": "A String", # An opaque location hint used to place the instance close to other resources. This field is for use by internal tools that use the public API. |
| "longTermRelease": True or False, # DEPRECATED, please use maintenance_freeze_duration_hours. TODO(b/154158138): Remove this field. Compute Engine Long Term Release. When specified, VMs that have this policy become long term release (internal: stable fleet) VMs. |
| # |
| # For all VM shapes, this should result in fewer disruptions due to software updates and greater predictability via 1 week extended notifications. |
| # |
| # For GPU VMs, this should also result in an 2 week uptime guarantee. See go/stable-fleet-gpus-design for more details. |
| "maintenanceFreezeDurationHours": 42, # Specifies the number of hours after instance creation where the instance won't be scheduled for maintenance. |
| "minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. |
| "nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity. |
| { # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled. |
| "key": "A String", # Corresponds to the label key of Node resource. |
| "operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity. |
| "values": [ # Corresponds to the label values of Node resource. |
| "A String", |
| ], |
| }, |
| ], |
| "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options. |
| "preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states. |
| }, |
| "selfLink": "A String", # [Output Only] Server-defined URL for this resource. |
| "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. |
| "serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported. |
| # |
| # Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Service Accounts for more information. |
| { # A service account. |
| "email": "A String", # Email address of the service account. |
| "scopes": [ # The list of scopes to be made available for this service account. |
| "A String", |
| ], |
| }, |
| ], |
| "shieldedInstanceConfig": { # A set of Shielded Instance options. |
| "enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default. |
| "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default. |
| "enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default. |
| }, |
| "shieldedInstanceIntegrityPolicy": { # The policy describes the baseline against which Instance boot integrity is measured. |
| "updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot. |
| }, |
| "shieldedVmConfig": { # A set of Shielded VM options. |
| "enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. |
| "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. |
| "enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. |
| }, |
| "shieldedVmIntegrityPolicy": { # The policy describes the baseline against which VM instance boot integrity is measured. |
| "updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot. |
| }, |
| "sourceMachineImage": "A String", # Source machine image |
| "sourceMachineImageEncryptionKey": { # Represents a customer-supplied encryption key # Source GMI encryption key when creating an instance from GMI. |
| "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. |
| "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. |
| "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. |
| "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. |
| # |
| # The key must meet the following requirements before you can provide it to Compute Engine: |
| # - The key is wrapped using a RSA public key certificate provided by Google. |
| # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: |
| # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem |
| "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. |
| }, |
| "startRestricted": True or False, # [Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity. |
| "status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. |
| "statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status. |
| "tags": { # A set of instance tags. # Tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035. Multiple tags can be specified via the 'tags.items' field. |
| "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the tags' contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update tags. You must always provide an up-to-date fingerprint hash in order to update or change tags. |
| # |
| # To see the latest fingerprint, make get() request to the instance. |
| "items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035. |
| "A String", |
| ], |
| }, |
| "upcomingMaintenance": { # Upcoming Maintenance notification information. # [Output Only] Specifies upcoming maintenance for the instance. |
| "date": "A String", # [Output Only] The date when the maintenance will take place. This value is in RFC3339 text format. |
| "time": "A String", # [Output Only] The time when the maintenance will take place. This value is in RFC3339 text format. |
| "type": "A String", # Defines the type of maintenance. |
| }, |
| "zone": "A String", # [Output Only] URL of the zone where the instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. |
| }, |
| "minCount": "A String", # The minimum number of instances to create. If no min_count is specified then count is used as the default value. If min_count instances cannot be created, then no instances will be created. |
| "predefinedNames": [ # List of predefined names. The number of names provided must be equal to count. |
| "A String", |
| ], |
| "sourceInstanceTemplate": "A String", # Specifies the instance template from which to create the instance. This field is optional. This field is optional. It can be a full or partial URL. For example, the following are all valid URLs to an instance template: |
| # - https://www.googleapis.com/compute/v1/projects/project/global/instanceTemplates/instanceTemplate |
| # - projects/project/global/instanceTemplates/instanceTemplate |
| # - global/instanceTemplates/instanceTemplate |
| } |
| |
| 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). |
| |
| Returns: |
| An object of the form: |
| |
| { # Represents an Operation resource. |
| # |
| # Google Compute Engine has three Operation resources: |
| # |
| # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) |
| # |
| # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. |
| # |
| # Operations can be global, regional or zonal. |
| # - For global operations, use the `globalOperations` resource. |
| # - For regional operations, use the `regionOperations` resource. |
| # - For zonal operations, use the `zonalOperations` resource. |
| # |
| # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==) |
| "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. |
| "creationTimestamp": "A String", # [Deprecated] This field is deprecated. |
| "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. |
| "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. |
| "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. |
| "errors": [ # [Output Only] The array of errors encountered while processing this operation. |
| { |
| "code": "A String", # [Output Only] The error type identifier for this error. |
| "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. |
| "message": "A String", # [Output Only] An optional, human-readable error message. |
| }, |
| ], |
| }, |
| "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. |
| "httpErrorStatusCode": 42, # [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. |
| "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. |
| "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. |
| "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. |
| "name": "A String", # [Output Only] Name of the operation. |
| "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. |
| "progress": 42, # [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. |
| "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. |
| "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. |
| "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. |
| "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. |
| "targetLink": "A 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. |
| "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`. |
| "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. |
| { |
| "code": "A 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. |
| "data": [ # [Output Only] Metadata about this warning in key: value format. For example: |
| # "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| { |
| "key": "A 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). |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| }, |
| ], |
| "message": "A String", # [Output Only] A human-readable description of the warning code. |
| }, |
| ], |
| "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. |
| }</pre> |
| </div> |
| |
| </body></html> |
