nebius_compute_v1_instance data source

Documentation Index

Fetch the complete documentation index at: https://docs.nebius.com/llms.txt

Use this file to discover all available pages before exploring further.

​

Retrieving the Data Source

Retrieve by ID

data ... {
    id = "your-ID"
}

Retrieve by Name

data ... {
    name      = "your name"
    parent_id = "data-source-parent-id"
}

​

Schema

​

Optional

• id (String) Identifier for the resource, unique for its resource type.
• name (String) Human readable name for the resource.
• parent_id (String) Identifier of the parent resource to which the resource belongs.

​

Read-Only

• boot_disk (Attributes) Specified boot disk attached to the instance. (see below for nested schema)
• cloud_init_user_data (String, Sensitive) : Data in cloud-init format for customizing instance initialization. For details, see https://docs.nebius.com/compute/virtual-machines/manage#user-data
• created_at (String) : Timestamp indicating when the resource was created. A string representing a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DDTHH:MM:SS.SSS±HH:MM
• filesystems (Attributes List) List of Shared Filesystems attached to the instance. (see below for nested schema)
• gpu_cluster (Attributes) : If you want to interconnect several instances in a GPU cluster via NVIDIA InfiniBand, set the ID of an existing GPU cluster. You can only add the VM to the cluster when creating the VM. For details, see https://docs.nebius.com/compute/clusters/gpu (see below for nested schema)
• hostname (String) : Instance’s hostname. Used to generate default DNS record in format <hostname>.<network_id>.compute.internal. or <instance_id>.<network_id>.compute.internal. if hostname is not specified.
• labels (Map of String) : Labels associated with the resource.
• local_disks (Attributes) : Local disks are meaningfully different from regular (remote) disks: they are provided by the underlying host and are tied to a particular VM run. Local disk data is not preserved across Stop-Start initiated via Compute API. Local disks are not provided by default. To get them, explicitly request them via this field. Availability depends on the selected platform, preset and region. Changing this field will result in disks change and content loss, but only after stop and start the instance. (see below for nested schema)
• metadata (Attributes) :

  ​

  Inner value description

  Common resource metadata. (see below for nested schema)
• network_interfaces (Attributes List) : List of network interfaces attached to the instance.

  ​

  Inner value description

  Describes the specification of a network interface. (see below for nested schema)
• preemptible (Attributes) : Include these parameters to create a Preemptible VM and omit them to create a Regular VM For details, see https://docs.nebius.com/compute/virtual-machines/preemptible (see below for nested schema)
• recovery_policy (String) : Recovery policy defines how the instance will be treated in case of a failure. Common source of failure is a host failure, but it can be any other failure. Instance undergoing a guest shutdown (poweroff, etc.) will be subject to recovery policy, meaning that it could be restarted and billed accordingly. Stop instance via API or UI to stop it to avoid recovering.
  • If set to RECOVER, instance will be restarted, if possible. It could be restarted on the same host or on another host.
  • If set to FAIL, instance will be stopped and not restarted.

  ​

  Supported values

  Possible values:
  • RECOVER
  • FAIL
• reservation_policy (Attributes) (see below for nested schema)
• resource_version (Number) : Version of the resource for safe concurrent modifications and consistent reads. Positive and monotonically increases on each resource spec change (but not on each change of the resource’s container(s) or status). Service allows zero value or current.
• resources (Attributes) : Specification of compute resources allocated to the instance. For details, see https://docs.nebius.com/compute/virtual-machines/types (see below for nested schema)
• secondary_disks (Attributes List) List of additional data disks attached to the instance beyond the boot disk. (see below for nested schema)
• service_account_id (String) : Unique identifier of the service account associated with this instance. For details, see https://docs.nebius.dev/en/iam/about-iam/concepts/service-accounts
• status (Attributes) (see below for nested schema)
• stopped (Boolean) Indicates whether the instance should be stopped.
• updated_at (String) : Timestamp indicating when the resource was last updated. A string representing a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DDTHH:MM:SS.SSS±HH:MM

​

Nested Schema for boot_disk

• attach_mode (String) :

  ​

  Supported values

  Possible values:
  • UNSPECIFIED
  • READ_ONLY
  • READ_WRITE
• device_id (String) Specifies the user-defined identifier, allowing to use ‘/dev/disk/by-id/virtio-’ as a device path in mount command.
• existing_disk (Attributes) : Attach an existing disk. Lifecycle:
  • The disk is preserved when the instance is deleted (it will be detached).
  Switching to a managed disk:
  • To delete the disk together with the instance, switch to ManagedDisk in the instance spec.
  • For the switch, ManagedDisk.name MUST match the current disk name (see DiskService.Get for the disk referenced by ExistingDisk.id).
  • When converting an ExistingDisk to a ManagedDisk, you must provide ManagedDisk.name and ManagedDisk.spec exactly as they are currently defined in the disk resource. Obtain the current values via DiskService.Get and copy them verbatim. If ManagedDisk.spec differs from the current disk spec, the instance update will fail.
  Cannot be set alongside managed_disk. (see below for nested schema)
• managed_disk (Attributes) : Attach a managed disk. Lifecycle:
  • The disk is deleted when the instance is deleted.
  Semantics:
  • Specifying a ManagedDisk expresses an intent to have that managed disk attached.
  • If this intent cannot be satisfied, the entire operation fails.
  • You can check the intent status in instance.status.disk_attachments.
  Updates and matching:
  • Managed disks can be updated only via instance spec updates. Updates via DiskService are not allowed.
  • During updates, disks are matched by name.
  Renaming and data loss:
  • Changing the disk name triggers disk replacement (create a new disk and delete the old one), which causes data loss.
  • To rename a managed disk safely:
    1. switch it to ExistingDisk in the instance spec, and
    2. update/rename it via DiskService.
  Conflicts:
  • Instance create/update fails if there is already a disk with the same name. as requested by any ManagedDisk.
  Finding the disk ID:
  • The disk ID is available in instance.status.disk_attachments after it is created. Use DiskAttachmentStatus.name to find the desired disk which matches name.
  Switching to an existing (non-managed) disk:
  • To preserve the disk after instance deletion, switch it to ExistingDisk in the instance spec, use the disk ID from instance.status.disk_attachments.
  Deletion protection:
  • Switching ExistingDisk to ManagedDisk fails if Disk.spec.deletion_protection is enabled.
  • Deleting an instance that has a ManagedDisk fails if Disk.spec.deletion_protection is enabled.
  Cannot be set alongside existing_disk. (see below for nested schema)

​

Nested Schema for boot_disk.existing_disk

• id (String)

​

Nested Schema for boot_disk.managed_disk

• labels (Map of String) : Labels associated with disk resource.
• name (String) : Name of a dependent disk. Use it to convert an ExistingDisk to a dependent disk. Changing the name will replace the disk and cause data loss.
• spec (Attributes) Specification of a dependent disk to be created. (see below for nested schema)

​

Nested Schema for boot_disk.managed_disk.spec

• block_size_bytes (Number) : Block size in bytes. The block size must be a power of two between 4096 bytes (4 KiB) and 131072 bytes (128 KiB). The default value is 4096 bytes (4 KiB).
• disk_encryption (Attributes) Defines how data on the disk is encrypted. By default, no encryption is applied. (see below for nested schema)
• forbid_deletion (Boolean) Prevents deletion whilst set
• size_bytes (Number) Cannot be set alongside size_kibibytes, size_mebibytes or size_gibibytes.
• size_gibibytes (Number) Cannot be set alongside size_bytes, size_kibibytes or size_mebibytes.
• size_kibibytes (Number) Cannot be set alongside size_bytes, size_mebibytes or size_gibibytes.
• size_mebibytes (Number) Cannot be set alongside size_bytes, size_kibibytes or size_gibibytes.
• source_image_family (Attributes) Cannot be set alongside source_image_id. (see below for nested schema)
• source_image_id (String) Cannot be set alongside source_image_family.
• type (String) : The type of disk defines the performance and reliability characteristics of the block device. For details, see https://docs.nebius.com/compute/storage/types#disks-types

  ​

  Supported values

  the list of available types will be clarified later, it is not final version Possible values:
  • UNSPECIFIED
  • NETWORK_SSD
  • NETWORK_HDD
  • NETWORK_SSD_NON_REPLICATED
  • NETWORK_SSD_IO_M3

​

Nested Schema for boot_disk.managed_disk.spec.disk_encryption

• type (String) :

  ​

  Supported values

  Possible values:
  • DISK_ENCRYPTION_UNSPECIFIED - No encryption is applied unless explicitly specified.
  • DISK_ENCRYPTION_MANAGED: Enables encryption using the platform’s default root key from KMS. Available for disks with NETWORK_SSD_NON_REPLICATED and NETWORK_SSD_IO_M3 types only.

​

Nested Schema for boot_disk.managed_disk.spec.source_image_family

• image_family (String)
• parent_id (String)

​

Nested Schema for filesystems

• attach_mode (String) :

  ​

  Supported values

  Possible values:
  • UNSPECIFIED
  • READ_ONLY
  • READ_WRITE
• existing_filesystem (Attributes) (see below for nested schema)
• mount_tag (String) Specifies the user-defined identifier, allowing to use it as a device in mount command.

​

Nested Schema for filesystems.existing_filesystem

• id (String)

​

Nested Schema for gpu_cluster

• id (String) : If you want to interconnect several instances in a GPU cluster via NVIDIA InfiniBand, set the ID of an existing GPU cluster. You can only add the VM to the cluster when creating the VM. For details, see https://docs.nebius.com/compute/clusters/gpu

​

Nested Schema for local_disks

• passthrough_group (Attributes) : Requests passthrough local disks from the host. Topology of the provided disks is preserved during stop and start for every instance of a specific platform and preset in the region. (see below for nested schema)

​

Nested Schema for local_disks.passthrough_group

• requested (Boolean) : Passthrough local disks from the underlying host. Devices are expected to appear in the guest as NVMe devices (nvme0, nvme1, …), but the exact number depends on the preset. Enabled only when this field is explicitly set.

​

Nested Schema for metadata

​

Nested Schema for network_interfaces

• aliases (Attributes List) Assign ranges of IP addresses as aliases (see below for nested schema)
• ip_address (Attributes) : Private IPv4 address associated with the interface.

  ​

  Inner value description

  Describes an IPv4 address. (see below for nested schema)
• name (String) : Interface name Value of this field configures the name of the network interface inside VM’s OS. Longer values will persist in the specification but will be truncated to 15 symbols before being passed to VM configuration.
• public_ip_address (Attributes) : Public IPv4 address associated with the interface.

  ​

  Inner value description

  Describes a public IP address. (see below for nested schema)
• security_groups (Attributes List) : Security groups associated with the network interface. If an empty list is provided, the default security group for the network will be used. Effective security groups can be seen in the status. (see below for nested schema)
• subnet_id (String) Subnet ID

​

Nested Schema for network_interfaces.aliases

• allocation_id (String) ID of allocation

​

Nested Schema for network_interfaces.ip_address

• allocation_id (String) Allocation identifier if it was created before.

​

Nested Schema for network_interfaces.public_ip_address

• allocation_id (String) Allocation identifier if it was created before.
• static (Boolean) : If false - Allocation will be created/deleted during NetworkInterface.Allocate/NetworkInterface.Deallocate If true - Allocation will be created/deleted during NetworkInterface.Create/NetworkInterface.Delete False by default

​

Nested Schema for network_interfaces.security_groups

• id (String) Security group identifier

​

Nested Schema for preemptible

• on_preemption (String) : Specifies what happens when the VM is preempted. The only supported value is STOP: Compute stops the VM without deleting or restarting it.

  ​

  Supported values

  Possible values:
  • UNSPECIFIED
  • STOP
• priority (Number) : The value can range from 1 to 5, where 5 indicates the highest priority. Affects the order in which Compute tries to preempt VMs, but does not guarantee the exact order.

​

Nested Schema for reservation_policy

• policy (String) :

  ​

  Supported values

  Possible values:
  • AUTO:
    1. Will try to launch instance in any reservation_ids if provided.
    2. Will try to launch instance in any of the available capacity block.
    3. Will try to launch instance in PAYG if 1 & 2 are not satisfied.
  • FORBID: The instance is launched only using on-demand (PAYG) capacity. No attempt is made to find or use a Capacity Block. It’s an error to provide reservation_ids with policy = FORBID
  • STRICT:
    1. Will try to launch the instance in Capacity Blocks from reservation_ids if provided.
    2. If reservation_ids are not provided will try to launch instance in suitable & available Capacity Block.
    3. Fail otherwise.
• reservation_ids (List of String) Capacity block groups, order matters

​

Nested Schema for resources

• platform (String)
• preset (String)

​

Nested Schema for secondary_disks

• attach_mode (String) :

  ​

  Supported values

  Possible values:
  • UNSPECIFIED
  • READ_ONLY
  • READ_WRITE
• device_id (String) Specifies the user-defined identifier, allowing to use ‘/dev/disk/by-id/virtio-’ as a device path in mount command.
• existing_disk (Attributes) : Attach an existing disk. Lifecycle:
  • The disk is preserved when the instance is deleted (it will be detached).
  Switching to a managed disk:
  • To delete the disk together with the instance, switch to ManagedDisk in the instance spec.
  • For the switch, ManagedDisk.name MUST match the current disk name (see DiskService.Get for the disk referenced by ExistingDisk.id).
  • When converting an ExistingDisk to a ManagedDisk, you must provide ManagedDisk.name and ManagedDisk.spec exactly as they are currently defined in the disk resource. Obtain the current values via DiskService.Get and copy them verbatim. If ManagedDisk.spec differs from the current disk spec, the instance update will fail.
  Cannot be set alongside managed_disk. (see below for nested schema)
• managed_disk (Attributes) : Attach a managed disk. Lifecycle:
  • The disk is deleted when the instance is deleted.
  Semantics:
  • Specifying a ManagedDisk expresses an intent to have that managed disk attached.
  • If this intent cannot be satisfied, the entire operation fails.
  • You can check the intent status in instance.status.disk_attachments.
  Updates and matching:
  • Managed disks can be updated only via instance spec updates. Updates via DiskService are not allowed.
  • During updates, disks are matched by name.
  Renaming and data loss:
  • Changing the disk name triggers disk replacement (create a new disk and delete the old one), which causes data loss.
  • To rename a managed disk safely:
    1. switch it to ExistingDisk in the instance spec, and
    2. update/rename it via DiskService.
  Conflicts:
  • Instance create/update fails if there is already a disk with the same name. as requested by any ManagedDisk.
  Finding the disk ID:
  • The disk ID is available in instance.status.disk_attachments after it is created. Use DiskAttachmentStatus.name to find the desired disk which matches name.
  Switching to an existing (non-managed) disk:
  • To preserve the disk after instance deletion, switch it to ExistingDisk in the instance spec, use the disk ID from instance.status.disk_attachments.
  Deletion protection:
  • Switching ExistingDisk to ManagedDisk fails if Disk.spec.deletion_protection is enabled.
  • Deleting an instance that has a ManagedDisk fails if Disk.spec.deletion_protection is enabled.
  Cannot be set alongside existing_disk. (see below for nested schema)

​

Nested Schema for secondary_disks.existing_disk

• id (String)

​

Nested Schema for secondary_disks.managed_disk

• labels (Map of String) : Labels associated with disk resource.
• name (String) : Name of a dependent disk. Use it to convert an ExistingDisk to a dependent disk. Changing the name will replace the disk and cause data loss.
• spec (Attributes) Specification of a dependent disk to be created. (see below for nested schema)

​

Nested Schema for secondary_disks.managed_disk.spec

• block_size_bytes (Number) : Block size in bytes. The block size must be a power of two between 4096 bytes (4 KiB) and 131072 bytes (128 KiB). The default value is 4096 bytes (4 KiB).
• disk_encryption (Attributes) Defines how data on the disk is encrypted. By default, no encryption is applied. (see below for nested schema)
• forbid_deletion (Boolean) Prevents deletion whilst set
• size_bytes (Number) Cannot be set alongside size_kibibytes, size_mebibytes or size_gibibytes.
• size_gibibytes (Number) Cannot be set alongside size_bytes, size_kibibytes or size_mebibytes.
• size_kibibytes (Number) Cannot be set alongside size_bytes, size_mebibytes or size_gibibytes.
• size_mebibytes (Number) Cannot be set alongside size_bytes, size_kibibytes or size_gibibytes.
• source_image_family (Attributes) Cannot be set alongside source_image_id. (see below for nested schema)
• source_image_id (String) Cannot be set alongside source_image_family.
• type (String) : The type of disk defines the performance and reliability characteristics of the block device. For details, see https://docs.nebius.com/compute/storage/types#disks-types

  ​

  Supported values

  the list of available types will be clarified later, it is not final version Possible values:
  • UNSPECIFIED
  • NETWORK_SSD
  • NETWORK_HDD
  • NETWORK_SSD_NON_REPLICATED
  • NETWORK_SSD_IO_M3

​

Nested Schema for secondary_disks.managed_disk.spec.disk_encryption

• type (String) :

  ​

  Supported values

  Possible values:
  • DISK_ENCRYPTION_UNSPECIFIED - No encryption is applied unless explicitly specified.
  • DISK_ENCRYPTION_MANAGED: Enables encryption using the platform’s default root key from KMS. Available for disks with NETWORK_SSD_NON_REPLICATED and NETWORK_SSD_IO_M3 types only.

​

Nested Schema for secondary_disks.managed_disk.spec.source_image_family

• image_family (String)
• parent_id (String)

​

Nested Schema for status

• disk_attachments (Attributes List) Status of the requested disk attachments. (see below for nested schema)
• infiniband_topology_path (Attributes) (see below for nested schema)
• maintenance_event_id (String)
• network_interfaces (Attributes List) :

  ​

  Inner value description

  Describes the status of a network interface. (see below for nested schema)
• reconciling (Boolean) Indicates whether there is an ongoing operation
• reservation_id (String)
• state (String) :

  ​

  Supported values

  Possible values:
  • UNSPECIFIED
  • CREATING
  • UPDATING
  • STARTING
  • RUNNING
  • STOPPING
  • STOPPED
  • DELETING
  • ERROR

​

Nested Schema for status.disk_attachments

• id (String) : Disk ID.
  • For ExistingDisk, this is the referenced disk ID.
  • For ManagedDisk, may be empty while the attachment intent is still pending.
• is_managed (Boolean) : Indicates whether this attachment is managed by the instance lifecycle. If true, the disk is expected to be deleted when the instance is deleted. If false, the disk is preserved and only detached on instance deletion.
• name (String) : Disk name used to match this status entry with the desired attachment from the instance specification. Consistency:
  • For ManagedDisk, this value is derived from the instance spec (ManagedDisk.name).
  • For ExistingDisk, this value is derived from the disk resource name and may lag behind in case of renaming. It is updated asynchronously and is eventually consistent.

​

Nested Schema for status.infiniband_topology_path

• path (List of String)

​

Nested Schema for status.network_interfaces

• aliases (Attributes) Effective IP Aliases (see below for nested schema)
• fqdn (String) FQDN of the interface
• index (Number) The index of the network interface
• ip_address (Attributes) Effective Private IPv4 address (see below for nested schema)
• mac_address (String) MAC address
• name (String) : Name for interface. Unique within instance’s network interfaces
• public_ip_address (Attributes) Effective Public IPv4 address (see below for nested schema)

​

Nested Schema for status.network_interfaces.aliases

• cidrs (List of String)

​

Nested Schema for status.network_interfaces.ip_address

• address (String) Effective private IPv4 address assigned to the interface.
• allocation_id (String) Allocation identifier.

​

Nested Schema for status.network_interfaces.public_ip_address

• address (String) Effective public IPv4 address assigned to the interface.
• allocation_id (String) Allocation identifier.
• static (Boolean) : If false - Allocation will be created/deleted during NetworkInterface.Allocate/NetworkInterface.Deallocate If true - Allocation will be created/deleted during NetworkInterface.Create/NetworkInterface.Delete False by default