- Resource: Instance
- Status
- InstanceParams
- ShieldedVmIntegrityPolicy
- ShieldedInstanceIntegrityPolicy
- PostKeyRevocationActionType
- ResourceStatus
- Scheduling
- ResizeState
- PhysicalHostTopology
- ShutdownDetails
- StopState
- TargetState
- Methods
Resource: Instance
Represents an Instance resource.
An instance is a virtual machine that is hosted on Trusted Cloud Platform. For more information, read Virtual Machine Instances.
JSON representation |
---|
{ "kind": string, "id": string, "creationTimestamp": string, "name": string, "description": string, "tags": { object ( |
Fields | |
---|---|
kind |
[Output Only] Type of the resource. Always
for instances. |
id |
[Output Only] The unique identifier for the resource. This identifier is defined by the server. |
creationTimestamp |
[Output Only] Creation timestamp in RFC3339 text format. |
name |
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 |
description |
An optional description of this resource. Provide this property when you create the resource. |
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. |
machineType |
Full or partial URL of the machine type resource to use for this instance, in the format:
. 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:
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):
For example:
For a full list of restrictions, read the Specifications for custom machine types. |
status |
[Output Only] The status of the instance. One of the following values:
,
,
,
,
,
,
, and
. For more information about the status of the instance, see Instance life cycle. |
statusMessage |
[Output Only] An optional, human-readable explanation of the status. |
zone |
[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. |
canIpForward |
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. |
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. |
disks[] |
Array of disks associated with this instance. Persistent disks must be created before you can assign them. |
metadata |
The metadata key/value pairs assigned to this instance. This includes metadata keys that were explicitly defined for the instance. |
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. |
selfLink |
[Output Only] Server-defined URL for this resource. |
scheduling |
Sets the scheduling options for this instance. |
cpuPlatform |
[Output Only] The CPU platform used by this instance. |
labels |
Labels to apply to this instance. These can be later modified by the
method. |
params |
Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload. |
labelFingerprint |
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
request to the instance. A base64-encoded string. |
instanceEncryptionKey |
Encrypts suspended data for an instance with a customer-managed encryption key. If you are creating a new instance, this field will encrypt the local SSD and in-memory contents of the instance during the suspend operation. 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 during the suspend operation. |
minCpuPlatform |
Specifies a minimum CPU platform for the VM instance. Applicable values are the friendly names of CPU platforms, such as
or
. |
guestAccelerators[] |
A list of the type and count of accelerator cards attached to the instance. |
startRestricted |
[Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity. |
deletionProtection |
Whether the resource should be protected against deletion. |
resourcePolicies[] |
Resource policies applied to this instance. |
sourceMachineImage |
Source machine image |
shieldedVmConfig |
Deprecating, please use shieldedInstanceConfig. |
shieldedVmIntegrityPolicy |
Deprecating, please use shieldedInstanceIntegrityPolicy. |
reservationAffinity |
Specifies the reservations that this instance can consume from. |
hostname |
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. |
displayDevice |
Enables display device for the instance. |
shieldedInstanceConfig |
|
shieldedInstanceIntegrityPolicy |
|
sourceMachineImageEncryptionKey |
Source machine image encryption key when creating an instance from a machine image. |
eraseWindowsVssSignature |
Specifies whether the disks restored from source snapshots or source machine image should erase Windows specific VSS signature. |
postKeyRevocationActionType |
PostKeyRevocationActionType of the instance. |
confidentialInstanceConfig |
|
fingerprint |
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
request to the instance. A base64-encoded string. |
privateIpv6GoogleAccess |
The private IPv6 Google access type for the VM. If not specified, use
as default. |
advancedMachineFeatures |
Controls for advanced machine-related behavior features. |
lastStartTimestamp |
[Output Only] Last start timestamp in RFC3339 text format. |
lastStopTimestamp |
[Output Only] Last stop timestamp in RFC3339 text format. |
lastSuspendedTimestamp |
[Output Only] Last suspended timestamp in RFC3339 text format. |
satisfiesPzs |
[Output Only] Reserved for future use. |
satisfiesPzi |
[Output Only] Reserved for future use. |
resourceStatus |
[Output Only] Specifies values set for instance attributes as compared to the values requested by user in the corresponding input only field. |
networkPerformanceConfig |
|
keyRevocationActionType |
KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified. |
partnerMetadata |
Partner Metadata assigned to the instance. A map from a subdomain (namespace) to entries map. |
Status
Enums | |
---|---|
PROVISIONING |
Resources are being allocated for the instance. |
STAGING |
All required resources have been allocated and the instance is being started. |
RUNNING |
The instance is running. |
STOPPING |
The instance is currently stopping (either being deleted or killed). |
STOPPED |
The instance has stopped successfully. |
TERMINATED |
The instance has stopped (either by explicit action or underlying failure). |
SUSPENDING |
The instance is suspending. |
SUSPENDED |
The instance has suspended. |
REPAIRING |
The instance is in repair. |
DEPROVISIONING |
The instance is halted and we are performing tear down tasks like network deprogramming, releasing quota, IP, tearing down disks etc. |
PENDING_STOP |
The instance is gracefully shutting down. |
InstanceParams
Additional instance params.
JSON representation |
---|
{ "resourceManagerTags": { string: string, ... } } |
Fields | |
---|---|
resourceManagerTags |
Resource manager tags to be bound to the instance. Tag keys and values have the same definition as resource manager tags. Keys must be in the format |
ShieldedVmIntegrityPolicy
The policy describes the baseline against which VM instance boot integrity is measured.
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field
|
|
updateAutoLearnPolicy |
Updates the integrity policy baseline using the measurements from the VM instance's most recent boot. |
ShieldedInstanceIntegrityPolicy
The policy describes the baseline against which Instance boot integrity is measured.
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field
|
|
updateAutoLearnPolicy |
Updates the integrity policy baseline using the measurements from the VM instance's most recent boot. |
PostKeyRevocationActionType
Specifies whether this instance will be shut down on key revocation.
Enums | |
---|---|
POST_KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED |
Default value. This value is unused. |
NOOP |
Indicates user chose no operation. |
SHUTDOWN |
Indicates user chose to opt for VM shutdown on key revocation. |
ResourceStatus
Contains output only fields. Use this sub-message for actual values set on Instance attributes as compared to the value requested by the user (intent) in their instance CRUD calls.
JSON representation |
---|
{ "scheduling": { object ( |
Fields | |
---|---|
scheduling |
|
upcomingMaintenance |
|
physicalHost |
[Output Only] The precise location of your instance within the zone's data center, including the block, sub-block, and host. The field is formatted as follows: blockId/subBlockId/hostId. |
physicalHostTopology |
[Output Only] A series of fields containing the global name of the Compute Engine cluster, as well as the ID of the block, sub-block, and host on which the running instance is located. |
shutdownDetails |
[Output Only] Details about the instance stopping state. |
Scheduling
JSON representation |
---|
{ "availabilityDomain": integer, "terminationTimestamp": string } |
Fields | |
---|---|
availabilityDomain |
Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. |
terminationTimestamp |
Time in future when the instance will be terminated in RFC3339 text format. |
ResizeState
Enum defines supported resize states. Applicable only for EK machine family. Internal only enum.
Enums | |
---|---|
RESIZE_STATE_UNSPECIFIED |
|
RESIZE_STATE_AT_INTENT |
AT_INTENT: last resize request was fully successful. |
RESIZE_STATE_IN_PROGRESS |
IN_PROGRESS: there is ongoing resize operation. |
RESIZE_STATE_GUEST_AGENT_ERROR |
GUEST_AGENT_ERROR: last resize request failed with Guest Agent error. The state of Guest OS is unclear. |
RESIZE_STATE_GUEST_AGENT_TIMEOUT |
GUEST_AGENT_TIMEOUT: last resize request failed with Guest Agent timeout. The state of Guest OS is unclear. |
RESIZE_STATE_INTERNAL_ERROR |
There was an internal error when resizing, unclear state. |
PhysicalHostTopology
Represents the physical host topology of the host on which the VM is running.
JSON representation |
---|
{ "cluster": string, "block": string, "subblock": string, "host": string } |
Fields | |
---|---|
cluster |
[Output Only] The global name of the Compute Engine cluster where the running instance is located. |
block |
[Output Only] The ID of the block in which the running instance is located. Instances within the same block experience low network latency. |
subblock |
[Output Only] The ID of the sub-block in which the running instance is located. Instances in the same sub-block experience lower network latency than instances in the same block. |
host |
[Output Only] The ID of the host on which the running instance is located. Instances on the same host experience the lowest possible network latency. |
ShutdownDetails
JSON representation |
---|
{ "stopState": enum ( |
Fields | |
---|---|
stopState |
|
targetState |
|
requestTimestamp |
|
maxDuration |
|
StopState
Enums | |
---|---|
STOPPING |
|
PENDING_STOP |
TargetState
Enums | |
---|---|
STOPPED |
|
DELETED |
Methods |
|
---|---|
|
The method compute.beta.InstancesService.AddAccessConfig is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.InstancesService.AddNetworkInterface is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.InstancesService.AddResourcePolicies is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.InstancesService.AggregatedList is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.InstancesService.AttachDisk is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.InstancesService.BulkInsert is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.InstancesService.Delete is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.InstancesService.DeleteAccessConfig is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.InstancesService.DeleteNetworkInterface is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.InstancesService.DetachDisk is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.InstancesService.Get is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.InstancesService.GetEffectiveFirewalls is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.InstancesService.GetGuestAttributes is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.InstancesService.GetPolicy is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.InstancesService.GetPartnerMetadata is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.InstancesService.GetScreenshot is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.InstancesService.GetSerialPortOutput is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.InstancesService.GetShieldedInstanceIdentity is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.InstancesService.GetShieldedVmIdentity is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.InstancesService.Insert is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.InstancesService.List is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.InstancesService.ListReferrers is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.InstancesService.PatchPartnerMetadata is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.InstancesService.PerformMaintenance is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.InstancesService.RemoveResourcePolicies is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.InstancesService.ReportHostAsFaulty is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.InstancesService.Reset is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.InstancesService.Resume is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.InstancesService.SendDiagnosticInterrupt is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.InstancesService.SetDeletionProtection is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.InstancesService.SetDiskAutoDelete is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.InstancesService.SetPolicy is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.InstancesService.SetLabels is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.InstancesService.SetMachineResources is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.InstancesService.SetMachineType is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.InstancesService.SetMetadata is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.InstancesService.SetMinCpuPlatform is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.InstancesService.SetName is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.InstancesService.SetScheduling is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.InstancesService.SetSecurityPolicy is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.InstancesService.SetServiceAccount is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.InstancesService.SetShieldedInstanceIntegrityPolicy is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.InstancesService.SetShieldedVmIntegrityPolicy is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.InstancesService.SetTags is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.InstancesService.SimulateMaintenanceEvent is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.InstancesService.Start is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.InstancesService.StartWithEncryptionKey is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.InstancesService.Stop is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.InstancesService.Suspend is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.InstancesService.TestPermissions is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.InstancesService.Update is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.InstancesService.UpdateAccessConfig is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.InstancesService.UpdateDisplayDevice is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.InstancesService.UpdateNetworkInterface is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.InstancesService.UpdateShieldedInstanceConfig is not available in Trusted Cloud by S3NS. |
|
The method compute.beta.InstancesService.UpdateShieldedVmConfig is not available in Trusted Cloud by S3NS. |