Compute Cloud API, REST: Instance.Create

Field

Description

folderId

string

ID of the folder to create an instance in.
To get the folder ID, use a yandex.cloud.resourcemanager.v1.FolderService.List request.
The length must be less than or equal to 50.
This field is required.

name

string

Name of the instance.
The value must match the regular expression: |[a-z]([-_a-z0-9]{0,61}[a-z0-9])?.

description

string

Description of the instance.
The length must be less than or equal to 256.

labels

object (map<string, string>)

Resource labels as key:value pairs.
Each map key must match the regular expression: [a-z][-_./\\@0-9a-z]*.
Each map value must match the regular expression: [-_./\\@0-9a-z]*.
The length of each map key must be between 1 and 63.
The length of each map value must be less than or equal to 63.
The number of elements must be less than or equal to 64.

zoneId

string

ID of the availability zone where the instance resides.
To get a list of available zones, use the yandex.cloud.compute.v1.ZoneService.List request
The length must be less than or equal to 50.
This field is required.

platformId

string

ID of the hardware platform configuration for the instance.
This field affects the available values in resourcesSpec field.
Platforms allows you to create various types of instances: with a large amount of memory,
with a large number of cores, with a burstable performance.
For more information, see Platforms.
This field is required.

resourcesSpec

ResourcesSpec

Computing resources of the instance, such as the amount of memory and number of cores.
To get a list of available values, see Levels of core performance.
This field is required.

metadata

object (map<string, string>)

The metadata key:value pairs that will be assigned to this instance. This includes custom metadata and predefined keys.
The total size of all keys and values must be less than 512 KB.
Values are free-form strings, and only have meaning as interpreted by the programs which configure the instance.
The values must be 256 KB or less.
For example, you may use the metadata in order to provide your public SSH key to the instance.
For more information, see Metadata.

bootDiskSpec

AttachedDiskSpec

Boot disk to attach to the instance.
This field is required.

secondaryDiskSpecs[]

AttachedDiskSpec

Array of secondary disks to attach to the instance.
The number of elements must be less than or equal to 3.

filesystemSpecs[]

AttachedFilesystemSpec

Array of filesystems to attach to the instance.
The filesystems must reside in the same availability zone as the instance.
To use the instance with an attached filesystem, the latter must be mounted.
For details, see documentation.

localDiskSpecs[]

AttachedLocalDiskSpec

Array of local disks to attach to the instance.

networkInterfaceSpecs[]

NetworkInterfaceSpec

Network configuration for the instance. Specifies how the network interface is configured
to interact with other services on the internal network and on the internet.
This field is required.

hostname

string

Host name for the instance.
This field is used to generate the yandex.cloud.compute.v1.Instance.fqdn value.
The host name must be unique within the network and region.
If not specified, the host name will be equal to yandex.cloud.compute.v1.Instance.id of the instance
and FQDN will be <id>.auto.internal. Otherwise FQDN will be <hostname>.<region_id>.internal.
The value must match the regular expression: |[a-z]([-_a-z0-9]{0,61}[a-z0-9])?.

schedulingPolicy

SchedulingPolicy

Scheduling policy configuration.

serviceAccountId

string

ID of the service account to use for authentication inside the instance.
To get the service account ID, use a yandex.cloud.iam.v1.ServiceAccountService.List request.

networkSettings

NetworkSettings

Network settings.

placementPolicy

PlacementPolicy

Placement policy configuration.

gpuSettings

GpuSettings

GPU settings.

maintenancePolicy

enum (MaintenancePolicy)

Behaviour on maintenance events

• RESTART: Restart instance to move it to another host during maintenance
• MIGRATE: Use live migration to move instance to another host during maintenance

maintenanceGracePeriod

string (duration)

Time between notification via metadata service and maintenance
The value must satisfy: 1s-24h.

metadataOptions

MetadataOptions

Options allow user to configure access to instance's metadata

serialPortSettings

SerialPortSettings

Serial port settings

application

Application

Instance application settings.

reservedInstancePoolId

string

ID of the reserved instance pool that the instance should belong to.
Instance will be created using resources from the reserved instance pool.
Reserved instance pool resource configuration must match the resource configuration of the instance.
The length must be less than or equal to 50.

Field

Description

memory

string (int64)

The amount of memory available to the instance, specified in bytes.
The value must be less than or equal to 274877906944.
This field is required.

cores

string (int64)

The number of cores available to the instance.
The value must satisfy: 2,4,6,8,10,12,14,16,18,20,22,24,26,28,30,32,34,36,40,44,48,52,56,60,64,68,72,76,80.
This field is required.

coreFraction

string (int64)

Baseline level of CPU performance with the ability to burst performance above that baseline level.
This field sets baseline performance for each core.
For example, if you need only 5% of the CPU performance, you can set core_fraction=5.
For more information, see Levels of core performance.
The value must satisfy: 0,5,20,50,100.

gpus

string (int64)

The number of GPUs available to the instance.
The value must satisfy: 0,1,2,4.

Field

Description

mode

enum (Mode)

The mode in which to attach this disk.

• READ_ONLY: Read-only access.
• READ_WRITE: Read/Write access. Default value.

deviceName

string

Specifies a unique serial number of your choice that is reflected into the /dev/disk/by-id/ tree
of a Linux operating system running within the instance.
This value can be used to reference the device for mounting, resizing, and so on, from within the instance.
If not specified, a random value will be generated.
The value must match the regular expression: [a-z][a-z0-9-_]{,19}.

autoDelete

boolean

Specifies whether the disk will be auto-deleted when the instance is deleted.

diskSpec

DiskSpec

Disk specification.

Includes only one of the fields diskSpec, diskId.

Only one field must by specified.

diskId

string

ID of the disk that should be attached.
The length must be less than or equal to 50.

Includes only one of the fields diskSpec, diskId.

Only one field must by specified.

Field

Description

name

string

Name of the disk.
The value must match the regular expression: |[a-z]([-_a-z0-9]{0,61}[a-z0-9])?.

description

string

Description of the disk.
The length must be less than or equal to 256.

typeId

string

ID of the disk type.
To get a list of available disk types, use the yandex.cloud.compute.v1.DiskTypeService.List request.
The length must be less than or equal to 50.

size

string (int64)

Size of the disk, specified in bytes.
The value must be between 4194304 and 4398046511104.
This field is required.

blockSize

string (int64)

Block size of the disk, specified in bytes. The default is 4096.

diskPlacementPolicy

DiskPlacementPolicy

Placement policy configuration.

imageId

string

ID of the image to create the disk from.
The length must be less than or equal to 50.

Includes only one of the fields imageId, snapshotId.

snapshotId

string

ID of the snapshot to restore the disk from.
The length must be less than or equal to 50.

Includes only one of the fields imageId, snapshotId.

kmsKeyId

string

ID of KMS key for disk encryption
The length must be less than or equal to 50.

Field

Description

placementGroupId

string

Placement group ID.

placementGroupPartition

string (int64)

Field

Description

mode

enum (Mode)

Mode of access to the filesystem that should be attached.

• READ_ONLY: Read-only access.
• READ_WRITE: Read/Write access. Default value.

deviceName

string

Name of the device representing the filesystem on the instance.
The name should be used for referencing the filesystem from within the instance
when it's being mounted, resized etc.
If not specified, a random value will be generated.
The value must match the regular expression: [a-z][a-z0-9-_]{,19}.

filesystemId

string

ID of the filesystem that should be attached.
The length must be less than or equal to 50.

Field

Description

size

string (int64)

Size of the disk, specified in bytes.
This field is required.

physicalLocalDisk

PhysicalLocalDiskSpec

Local disk configuration

Includes only one of the fields physicalLocalDisk.

Field

Description

kmsKeyId

string

ID of KMS key for disk encryption

Field

Description

index

string

The index of the network interface, will be generated by the server, 0,1,2... etc if not specified.

subnetId

string

ID of the subnet.
The length must be less than or equal to 50.
This field is required.

primaryV4AddressSpec

PrimaryAddressSpec

Primary IPv4 address that will be assigned to the instance for this network interface.

primaryV6AddressSpec

PrimaryAddressSpec

Primary IPv6 address that will be assigned to the instance for this network interface. IPv6 not available yet.

securityGroupIds[]

string

ID's of security groups attached to the interface

Field

Description

address

string

An IPv4 internal network address that is assigned to the instance for this network interface.
If not specified by the user, an unused internal IP is assigned by the system.

oneToOneNatSpec

OneToOneNatSpec

An external IP address configuration.
If not specified, then this instance will have no external internet access.

dnsRecordSpecs[]

DnsRecordSpec

Internal DNS configuration

Field

Description

ipVersion

enum (IpVersion)

External IP address version.

• IPV4: IPv4 address, for example 192.0.2.235.
• IPV6: IPv6 address. Not available yet.

address

string

set static IP by value

dnsRecordSpecs[]

DnsRecordSpec

External DNS configuration

Field

Description

fqdn

string

FQDN (required)
This field is required.

dnsZoneId

string

DNS zone id (optional, if not set, private zone used)

ttl

string (int64)

DNS record ttl, values in 0-86400 (optional)
The value must be between 0 and 86400.

ptr

boolean

When set to true, also create PTR DNS record (optional)

Field

Description

preemptible

boolean

True for short-lived compute instances. For more information, see Preemptible VMs.

Field

Description

type

enum (Type)

Network Type

• STANDARD: Standard network.
• SOFTWARE_ACCELERATED: Software accelerated network.
• HARDWARE_ACCELERATED: Hardware accelerated network (not available yet, reserved for future use).

Field

Description

placementGroupId

string

Placement group ID.

placementGroupPartition

string (int64)

Placement group partition

hostAffinityRules[]

HostAffinityRule

List of affinity rules. Scheduler will attempt to allocate instances according to order of rules.

Field

Description

key

string

Affinity label or one of reserved values - 'yc.hostId', 'yc.hostGroupId'

op

enum (Operator)

Include or exclude action

• IN: Include action
• NOT_IN: Exclude action

values[]

string

Affinity value or host ID or host group ID

Field

Description

gpuClusterId

string

Attach instance to specified GPU cluster.

Field

Description

gceHttpEndpoint

enum (MetadataOption)

Enabled access to GCE flavored metadata

• ENABLED: Option is enabled
• DISABLED: Option is disabled

awsV1HttpEndpoint

enum (MetadataOption)

Enabled access to AWS flavored metadata (IMDSv1)

• ENABLED: Option is enabled
• DISABLED: Option is disabled

gceHttpToken

enum (MetadataOption)

Enabled access to IAM credentials with GCE flavored metadata

• ENABLED: Option is enabled
• DISABLED: Option is disabled

awsV1HttpToken

enum (MetadataOption)

Enabled access to IAM credentials with AWS flavored metadata (IMDSv1)

• ENABLED: Option is enabled
• DISABLED: Option is disabled

awsV2HttpEndpoint

enum (MetadataOption)

Enabled access to AWS flavored metadata with session token (IMDSv2)

• ENABLED: Option is enabled
• DISABLED: Option is disabled

awsV2HttpToken

enum (MetadataOption)

Enabled access to STS credentials with AWS flavored metadata with session token (IMDSv2)

• ENABLED: Option is enabled
• DISABLED: Option is disabled

Field

Description

sshAuthorization

enum (SSHAuthorization)

Authentication and authorization in serial console when using SSH protocol

• INSTANCE_METADATA: Authentication and authorization using SSH keys in instance metadata
• OS_LOGIN: Authentication and authorization using Oslogin service

Field

Description

containerSolution

ContainerSolutionSpec

Container specification.

Includes only one of the fields containerSolution.

cloudbackup

BackupSpec

Backup settings.

Field

Description

productId

string

ID of the product.
The length must be less than or equal to 50.
This field is required.

secrets

object (map<string, Secret>)

A list of the secrets.
The length of each map key must be less than or equal to 100.
The number of elements must be less than or equal to 100.

environment

object (map<string, string>)

A list of the environmets.
The length of each map key must be less than or equal to 100.
The length of each map value must be less than or equal to 10000.
The number of elements must be less than or equal to 100.

Field

Description

id

string

ID of the secret.
The length must be less than or equal to 50.
This field is required.

key

string

Name of the key.
The length must be less than or equal to 256.
This field is required.

versionId

string

Version of the secret.
The length must be less than or equal to 50.

Field

Description

enabled

boolean

If true, backup is enabled.

initialPolicyIds[]

string

A list of policy IDs to apply after resource registration.
The length of each element must be between 1 and 50.
The number of elements must be less than or equal to 50.

recoveryFromBackup

boolean

If true, recovery from backup starts on instance.

backupId

string

ID of the backup to recover from.
The length must be less than or equal to 100.

instanceRegistrationId

string

ID of the instance registration for cloud backup agent installation.
The length must be less than or equal to 100.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

createdAt

string (date-time)

Creation timestamp.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

createdBy

string

ID of the user or service account who initiated the operation.

modifiedAt

string (date-time)

The time when the Operation resource was last modified.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

done

boolean

If the value is false, it means the operation is still in progress.
If true, the operation is completed, and either error or response is available.

metadata

object

Service-specific metadata associated with the operation.
It typically contains the ID of the target resource that the operation is performed on.
Any method that returns a long-running operation should document the metadata type, if any.

error

Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

response

object

The normal response of the operation in case of success.
If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty.
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

Field

Description

code

integer (int32)

Error code. An enum value of google.rpc.Code.

message

string

An error message.

details[]

object

A list of messages that carry the error details.