Skip to main content

Create

Creates an instance in the specified folder. Method starts an asynchronous operation that can be cancelled while it is in progress.

import {
  cloudApi,
  decodeMessage,
  serviceClients,
  Session,
  waitForOperation,
} from "@yandex-cloud/nodejs-sdk";

const AttachedDiskSpec_Mode =
  cloudApi.compute.instance_service.AttachedDiskSpec_Mode;
const AttachedFilesystemSpec_Mode =
  cloudApi.compute.instance_service.AttachedFilesystemSpec_Mode;
const CreateInstanceRequest =
  cloudApi.compute.instance_service.CreateInstanceRequest;
const HostAffinityRule_Operator =
  cloudApi.compute.instance.HostAffinityRule_Operator;
const Instance = cloudApi.compute.instance.Instance;
const IpVersion = cloudApi.compute.instance.IpVersion;
const MaintenancePolicy = cloudApi.compute.maintenance.MaintenancePolicy;
const MetadataOption = cloudApi.compute.instance.MetadataOption;
const NetworkSettings_Type = cloudApi.compute.instance.NetworkSettings_Type;
const SerialPortSettings_SSHAuthorization =
  cloudApi.compute.instance.SerialPortSettings_SSHAuthorization;

(async () => {
  const authToken = process.env["YC_OAUTH_TOKEN"];
  const session = new Session({ oauthToken: authToken });
  const client = session.client(serviceClients.InstanceServiceClient);

  const operation = await client.create(
    CreateInstanceRequest.fromPartial({
      folderId: "folderId",
      // name: "name",
      // description: "description",
      // labels: {"key": "labels"},
      zoneId: "zoneId",
      platformId: "platformId",
      resourcesSpec: {
        memory: 0,
        cores: 0,
        // coreFraction: 0,
        // gpus: 0
      },
      // metadata: {"key": "metadata"},
      // metadataOptions: {
      // gceHttpEndpoint: MetadataOption.ENABLED,
      // awsV1HttpEndpoint: MetadataOption.ENABLED,
      // gceHttpToken: MetadataOption.ENABLED,
      // awsV1HttpToken: MetadataOption.ENABLED
      // },
      bootDiskSpec: {
        // mode: AttachedDiskSpec_Mode.READ_ONLY,
        // deviceName: "deviceName",
        // autoDelete: true,
        // diskSpec: {
        // name: "name",
        // description: "description",
        // typeId: "typeId",
        // size: 0,
        // imageId: "imageId",
        // snapshotId: "snapshotId",
        // diskPlacementPolicy: {
        // placementGroupId: "placementGroupId",
        // placementGroupPartition: 0
        // },
        // blockSize: 0,
        // kmsKeyId: "kmsKeyId"
        // },
        // diskId: "diskId"
      },
      // secondaryDiskSpecs: [{
      // mode: AttachedDiskSpec_Mode.READ_ONLY,
      // deviceName: "deviceName",
      // autoDelete: true,
      // diskSpec: {
      // name: "name",
      // description: "description",
      // typeId: "typeId",
      // size: 0,
      // imageId: "imageId",
      // snapshotId: "snapshotId",
      // diskPlacementPolicy: {
      // placementGroupId: "placementGroupId",
      // placementGroupPartition: 0
      // },
      // blockSize: 0,
      // kmsKeyId: "kmsKeyId"
      // },
      // diskId: "diskId"
      // }],
      // localDiskSpecs: [{
      // size: 0
      // }],
      // filesystemSpecs: [{
      // mode: AttachedFilesystemSpec_Mode.READ_ONLY,
      // deviceName: "deviceName",
      // filesystemId: "filesystemId"
      // }],
      networkInterfaceSpecs: [
        {
          subnetId: "subnetId",
          // primaryV4AddressSpec: {
          // address: "address",
          // oneToOneNatSpec: {
          // ipVersion: IpVersion.IPV4,
          // address: "address",
          // dnsRecordSpecs: [{
          // fqdn: "fqdn",
          // dnsZoneId: "dnsZoneId",
          // ttl: 0,
          // ptr: true
          // }]
          // },
          // dnsRecordSpecs: [{
          // fqdn: "fqdn",
          // dnsZoneId: "dnsZoneId",
          // ttl: 0,
          // ptr: true
          // }]
          // },
          // primaryV6AddressSpec: {
          // address: "address",
          // oneToOneNatSpec: {
          // ipVersion: IpVersion.IPV4,
          // address: "address",
          // dnsRecordSpecs: [{
          // fqdn: "fqdn",
          // dnsZoneId: "dnsZoneId",
          // ttl: 0,
          // ptr: true
          // }]
          // },
          // dnsRecordSpecs: [{
          // fqdn: "fqdn",
          // dnsZoneId: "dnsZoneId",
          // ttl: 0,
          // ptr: true
          // }]
          // },
          // securityGroupIds: ["securityGroupIds"],
          // index: "index"
        },
      ],
      // hostname: "hostname",
      // schedulingPolicy: {
      // preemptible: true
      // },
      // serviceAccountId: "serviceAccountId",
      // networkSettings: {
      // type: NetworkSettings_Type.STANDARD
      // },
      // placementPolicy: {
      // placementGroupId: "placementGroupId",
      // hostAffinityRules: [{
      // key: "key",
      // op: HostAffinityRule_Operator.IN,
      // values: ["values"]
      // }],
      // placementGroupPartition: 0
      // },
      // gpuSettings: {
      // gpuClusterId: "gpuClusterId"
      // },
      // maintenancePolicy: MaintenancePolicy.RESTART,
      // maintenanceGracePeriod: {
      // seconds: 0,
      // nanos: 0
      // },
      // serialPortSettings: {
      // sshAuthorization: SerialPortSettings_SSHAuthorization.INSTANCE_METADATA
      // }
    })
  );
  const finishedOp = await waitForOperation(operation, session);

  if (finishedOp.response) {
    const result = decodeMessage<typeof Instance>(finishedOp.response);
    console.log(result);
  }
})();

CreateInstanceRequest​

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.

name : string​

Name of the instance.

description : string​

Description of the instance.

labels : string​

Resource labels as key:value pairs.

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

platformId : string​

ID of the hardware platform configuration for the instance. This field affects the available values in resources_spec 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.

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.

metadata : 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.

metadataOptions : MetadataOptions​

Options allow user to configure access to instance's metadata

bootDiskSpec : AttachedDiskSpec​

Boot disk to attach to the instance.

secondaryDiskSpecs : AttachedDiskSpec​

Array of secondary disks to attach to the instance.

localDiskSpecs : AttachedLocalDiskSpec​

Array of local disks to attach to the instance.

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.

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.

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.

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 : MaintenancePolicy​

Behaviour on maintenance events

maintenanceGracePeriod : google.protobuf.Duration​

Time between notification via metadata service and maintenance

serialPortSettings : SerialPortSettings​

Serial port settings

ResourcesSpec​

memory : int64​

The amount of memory available to the instance, specified in bytes.

cores : int64​

The number of cores available to the instance.

coreFraction : 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.

gpus : int64​

The number of GPUs available to the instance.

MetadataOptions​

gceHttpEndpoint : MetadataOption​

Enabled access to GCE flavored metadata

awsV1HttpEndpoint : MetadataOption​

Enabled access to AWS flavored metadata (IMDSv1)

gceHttpToken : MetadataOption​

Enabled access to IAM credentials with GCE flavored metadata

awsV1HttpToken : MetadataOption​

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

AttachedDiskSpec​

Mode​
  • MODE_UNSPECIFIED

  • READ_ONLY

    Read-only access.

  • READ_WRITE

    Read/Write access. Default value.

DiskSpec​
name : string​

Name of the disk.

description : string​

Description of the disk.

typeId : string​

ID of the disk type. To get a list of available disk types, use the yandex.cloud.compute.v1.DiskTypeService.List request.

size : int64​

Size of the disk, specified in bytes.

One of source​

  • imageId : string​

    ID of the image to create the disk from.

  • snapshotId : string​

    ID of the snapshot to restore the disk from.

diskPlacementPolicy : DiskPlacementPolicy​

Placement policy configuration.

blockSize : int64​

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

kmsKeyId : string​

ID of KMS key for disk encryption

mode : Mode​

The mode in which to attach this disk.

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.

autoDelete : bool​

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

One of disk​

  • diskSpec : DiskSpec​

    Disk specification.

  • diskId : string​

    ID of the disk that should be attached.

AttachedLocalDiskSpec​

size : int64​

Size of the disk, specified in bytes.

AttachedFilesystemSpec​

Mode​
  • MODE_UNSPECIFIED

  • READ_ONLY

    Read-only access.

  • READ_WRITE

    Read/Write access. Default value.

mode : Mode​

Mode of access to the filesystem that should be attached.

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.

filesystemId : string​

ID of the filesystem that should be attached.

NetworkInterfaceSpec​

subnetId : string​

ID of the subnet.

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

index : string​

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

SchedulingPolicy​

preemptible : bool​

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

NetworkSettings​

Type​
  • TYPE_UNSPECIFIED

  • STANDARD

    Standard network.

  • SOFTWARE_ACCELERATED

    Software accelerated network.

  • HARDWARE_ACCELERATED

    Hardware accelerated network (not available yet, reserved for future use).

type : Type​

Network Type

PlacementPolicy​

HostAffinityRule​

Affinity definition

Operator​
  • OPERATOR_UNSPECIFIED

  • IN

  • NOT_IN

key : string​

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

op : Operator​

Include or exclude action

values : string​

Affinity value or host ID or host group ID

placementGroupId : string​

Placement group ID.

hostAffinityRules : HostAffinityRule​

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

placementGroupPartition : int64​

Placement group partition

GpuSettings​

gpuClusterId : string​

Attach instance to specified GPU cluster.

SerialPortSettings​

SSHAuthorization​
  • SSH_AUTHORIZATION_UNSPECIFIED

  • INSTANCE_METADATA

    Authentication and authorization using SSH keys in instance metadata

  • OS_LOGIN

    Authentication and authorization using Oslogin service

sshAuthorization : SSHAuthorization​

Authentication and authorization in serial console when using SSH protocol

DiskPlacementPolicy​

placementGroupId : string​

Placement group ID.

placementGroupPartition : int64​

DiskSpec​

name : string​

Name of the disk.

description : string​

Description of the disk.

typeId : string​

ID of the disk type. To get a list of available disk types, use the yandex.cloud.compute.v1.DiskTypeService.List request.

size : int64​

Size of the disk, specified in bytes.

  • imageId : string​

    ID of the image to create the disk from.

  • snapshotId : string​

    ID of the snapshot to restore the disk from.

diskPlacementPolicy : DiskPlacementPolicy​

Placement policy configuration.

blockSize : int64​

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

kmsKeyId : string​

ID of KMS key for disk encryption

PrimaryAddressSpec​

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

HostAffinityRule​

Affinity definition

Operator​
  • OPERATOR_UNSPECIFIED

  • IN

  • NOT_IN

key : string​

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

op : Operator​

Include or exclude action

values : string​

Affinity value or host ID or host group ID

OneToOneNatSpec​

ipVersion : IpVersion​

External IP address version.

address : string​
dnsRecordSpecs : DnsRecordSpec​

External DNS configuration

DnsRecordSpec​

fqdn : string​

FQDN (required)

dnsZoneId : string​

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

ttl : int64​

DNS record ttl, values in 0-86400 (optional)

ptr : bool​

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

Operation​

An Operation resource. For more information, see Operation.

id : string​

ID of the operation.

description : string​

Description of the operation. 0-256 characters long.

createdAt : google.protobuf.Timestamp​

Creation timestamp.

createdBy : string​

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

modifiedAt : google.protobuf.Timestamp​

The time when the Operation resource was last modified.

done : bool​

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 : google.protobuf.Any​

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.

One of result​

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.

  • error : google.rpc.Status​

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

  • response : google.protobuf.Any​
    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.