nebius.api.nebius.compute.v1.InstanceSpec

class documentation

class InstanceSpec(Message): (source)

Constructor: InstanceSpec(initial_message, service_account_id, resources, gpu_cluster, ...)

View In Hierarchy

Undocumented

Class __OneOfClass_pricing_model__ Default is on_demand.
Class __OneOfClass_pricing_model_follows_spot_price__ The preemptible VM accepts the current spot price.
Class __OneOfClass_pricing_model_on_demand__ A regular, non-preemptible VM.
Class __OneOfClass_pricing_model_spot_pricing_policy__ The preemptible VM accepts the current spot price unless it exceeds the maximum price specified by the selected pricing policy. When the spot price exceeds that maximum price, the VM is preempted.
Method __init__ Create a message from a source message and field values.
Method boot_disk.setter Set or clear the generated boot_disk field.
Method cloud_init_user_data.setter Set or clear the generated cloud_init_user_data field.
Method filesystems.setter Set or clear the generated filesystems field.
Method follows_spot_price.setter Set or clear the generated follows_spot_price field.
Method gpu_cluster.setter Set or clear the generated gpu_cluster field.
Method hostname.setter Set or clear the generated hostname field.
Method local_disks.setter Set or clear the generated local_disks field.
Method network_interfaces.setter Set or clear the generated network_interfaces field.
Method nvl_instance_group_id.setter Set or clear the generated nvl_instance_group_id field.
Method on_demand.setter Set or clear the generated on_demand field.
Method preemptible.setter Set or clear the generated preemptible field.
Method recovery_policy.setter Set or clear the generated recovery_policy field.
Method reservation_policy.setter Set or clear the generated reservation_policy field.
Method resources.setter Set or clear the generated resources field.
Method secondary_disks.setter Set or clear the generated secondary_disks field.
Method service_account_id.setter Set or clear the generated service_account_id field.
Method spot_pricing_policy.setter Set or clear the generated spot_pricing_policy field.
Method stopped.setter Set or clear the generated stopped field.
Property boot_disk Specified boot disk attached to the instance.
Property cloud_init_user_data Data in cloud-init format for customizing instance initialization. For details, see https://docs.nebius.com/compute/virtual-machines/manage#user-data
Property filesystems List of Shared Filesystems attached to the instance.
Property follows_spot_price The preemptible VM accepts the current spot price.
Property gpu_cluster 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 ...
Property hostname 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.
Property local_disks 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...
Property network_interfaces List of network interfaces attached to the instance.
Property nvl_instance_group_id NVLink Instance Group ID associated with the VM
Property on_demand A regular, non-preemptible VM.
Property preemptible Set this field to create a preemptible VM, or omit it to create a regular VM. For details, see https://docs.nebius.com/compute/virtual-machines/preemptible A preemptible VM cannot be converted to a regular VM or vice versa...
Property pricing_model Default is on_demand.
Property recovery_policy 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...
Property reservation_policy Undocumented
Property resources Specification of compute resources allocated to the instance. For details, see https://docs.nebius.com/compute/virtual-machines/types
Property secondary_disks List of additional data disks attached to the instance beyond the boot disk.
Property service_account_id Unique identifier of the service account associated with this instance. For details, see https://docs.nebius.com/iam/service-accounts/manage
Property spot_pricing_policy The preemptible VM accepts the current spot price unless it exceeds the maximum price specified by the selected pricing policy. When the spot price exceeds that maximum price, the VM is preempted.
Property stopped Indicates whether the instance should be stopped.

Inherited from Message:

Class Method from_json Create a message from protobuf JSON mapping.
Class Method FromString Create a message by parsing protobuf wire-format bytes.
Class Method get_descriptor Return the message descriptor from the registry.
Class Method is_credentials Return True if a Python field contains credentials.
Class Method is_sensitive Return True if a Python field has the sensitive annotation.
Method __dir__ List generated fields, oneofs, and nested declarations.
Method __repr__ Render non-default fields without disclosing annotated secrets.
Method ByteSize Return the serialized protobuf wire size in bytes.
Method check_presence Check presence using a generated Python field name.
Method Clear Clear all fields, extensions, unknown fields, and the reset mask.
Method clear_extension Clear an extension value.
Method ClearField Clear a protobuf field or oneof and record it in the reset mask.
Method CopyFrom Replace this message with an independent copy of another message.
Method FindInitializationErrors Return paths of missing required fields.
Method get_extension Return an extension value.
Method get_full_update_reset_mask Create a reset mask from the current protobuf state.
Method get_mask Return the reset mask for field changes.
Method has_extension Return True if an extension has explicit presence.
Method HasField Return True if a protobuf field or oneof has explicit presence.
Method is_default Return True if a generated field has its default value.
Method IsInitialized Return True if every required field is initialized.
Method MergeFrom Merge fields from another message of the same generated type.
Method MergeFromString Merge protobuf wire-format bytes into this message.
Method ParseFromString Parse protobuf wire-format bytes and replace this message.
Method SerializeToString Serialize the message using protobuf wire format.
Method set_extension Set an extension value.
Method set_mask Set the reset mask for this message.
Method to_json Serialize this message using protobuf JSON mapping.
Method which_field_in_oneof Return the selected Python field name for a protobuf oneof.
Method WhichOneof Return the selected protobuf field name for a oneof.
Constant __DEPRECATION_DETAILS__ Undocumented
Constant __EXTENSION_REGISTRY__ Registry that decodes protobuf extensions.
Constant __FIELDS__ Runtime field data that the generator creates.
Constant __MAX_NESTING_DEPTH__ Maximum protobuf nesting depth for serialization, parsing, and initialization checks.
Constant __PB2_DESCRIPTOR__ Alias for code that expects a protobuf descriptor.
Constant __PROTO_DESCRIPTOR__ Message descriptor from the registry.
Constant __PY_TO_PB2__ Mapping from Python names to protobuf names.
Constant __REGISTRY__ Registry for the message and its descriptor.
Class Variable __PROTO_FULL_NAME__ Fully qualified protobuf message name.
Property Extensions Provide protobuf-compatible mapping access to extension values.
Class Method _fields_by_number Undocumented
Class Method _fields_by_proto_name Undocumented
Class Method _fields_by_python_name Undocumented
Class Method _from_string Deserialize internally without invoking generated user warnings.
Class Method _oneof_python_name Undocumented
Class Method _public_fields_by_proto_name Undocumented
Class Method _public_fields_by_python_name Undocumented
Static Method _format_map_key Undocumented
Static Method _repr_field Undocumented
Method _bind_child Undocumented
Method _bind_mutation Undocumented
Method _check_same_type Undocumented
Method _child_changed Undocumented
Method _clear_state Undocumented
Method _closed_enum_unknown Undocumented
Method _converted_view Undocumented
Method _decode_map_entry Undocumented
Method _detach_child Undocumented
Method _field_has_value Undocumented
Method _field_is_default Undocumented
Method _find_initialization_errors Undocumented
Method _get_field Undocumented
Method _initialize Initialize message state, optionally suppressing generated warnings.
Method _map Undocumented
Method _merge_from_string Undocumented
Method _nesting_limit Undocumented
Method _notify Undocumented
Method _record_reset Undocumented
Method _repeated Undocumented
Method _select Undocumented
Method _serialize_to_string Undocumented
Method _set_field Undocumented
Method _suspend_mutation Undocumented
Method _suspend_reset_mask Undocumented
Method _try_decode_field Undocumented
Method _write_field Undocumented
Instance Variable _extensions Undocumented
Instance Variable _mutation_suspended Undocumented
Instance Variable _on_mutation Undocumented
Instance Variable _oneofs Undocumented
Instance Variable _present Undocumented
Instance Variable _reset_mask Undocumented
Instance Variable _reset_mask_suspended Undocumented
Instance Variable _unknown_fields Undocumented
Instance Variable _values Undocumented
Instance Variable _views Undocumented
def __init__(self, initial_message: SerializableMessage | None = None, *, service_account_id: str | None | UnsetType = ..., resources: ResourcesSpec | None | UnsetType = ..., gpu_cluster: InstanceGpuClusterSpec | None | UnsetType = ..., network_interfaces: Iterable[NetworkInterfaceSpec] | None | UnsetType = ..., boot_disk: AttachedDiskSpec | None | UnsetType = ..., secondary_disks: Iterable[AttachedDiskSpec] | None | UnsetType = ..., filesystems: Iterable[AttachedFilesystemSpec] | None | UnsetType = ..., cloud_init_user_data: str | None | UnsetType = ..., stopped: bool | None | UnsetType = ..., recovery_policy: InstanceRecoveryPolicy | None | UnsetType = ..., preemptible: PreemptibleSpec | None | UnsetType = ..., hostname: str | None | UnsetType = ..., nvl_instance_group_id: str | None | UnsetType = ..., reservation_policy: ReservationPolicy | None | UnsetType = ..., local_disks: LocalDisksSpec | None | UnsetType = ..., on_demand: OnDemandSpec | None | UnsetType = ..., follows_spot_price: FollowsSpotPriceSpec | None | UnsetType = ..., spot_pricing_policy: SpotPricingPolicySpec | None | UnsetType = ...): (source)
overrides nebius.base.protos.direct.Message.__init__

Create a message from a source message and field values.

@boot_disk.setter
def boot_disk(self, value: AttachedDiskSpec | None): (source)

Set or clear the generated boot_disk field.

@cloud_init_user_data.setter
def cloud_init_user_data(self, value: str | None): (source)

Set or clear the generated cloud_init_user_data field.

@filesystems.setter
def filesystems(self, value: Iterable[AttachedFilesystemSpec] | None): (source)

Set or clear the generated filesystems field.

@follows_spot_price.setter
def follows_spot_price(self, value: FollowsSpotPriceSpec | None): (source)

Set or clear the generated follows_spot_price field.

@gpu_cluster.setter
def gpu_cluster(self, value: InstanceGpuClusterSpec | None): (source)

Set or clear the generated gpu_cluster field.

@hostname.setter
def hostname(self, value: str | None): (source)

Set or clear the generated hostname field.

@local_disks.setter
def local_disks(self, value: LocalDisksSpec | None): (source)

Set or clear the generated local_disks field.

@network_interfaces.setter
def network_interfaces(self, value: Iterable[NetworkInterfaceSpec] | None): (source)

Set or clear the generated network_interfaces field.

@nvl_instance_group_id.setter
def nvl_instance_group_id(self, value: str | None): (source)

Set or clear the generated nvl_instance_group_id field.

@on_demand.setter
def on_demand(self, value: OnDemandSpec | None): (source)

Set or clear the generated on_demand field.

@preemptible.setter
def preemptible(self, value: PreemptibleSpec | None): (source)

Set or clear the generated preemptible field.

@recovery_policy.setter
def recovery_policy(self, value: InstanceRecoveryPolicy | None): (source)

Set or clear the generated recovery_policy field.

@reservation_policy.setter
def reservation_policy(self, value: ReservationPolicy | None): (source)

Set or clear the generated reservation_policy field.

@resources.setter
def resources(self, value: ResourcesSpec | None): (source)

Set or clear the generated resources field.

@secondary_disks.setter
def secondary_disks(self, value: Iterable[AttachedDiskSpec] | None): (source)

Set or clear the generated secondary_disks field.

@service_account_id.setter
def service_account_id(self, value: str | None): (source)

Set or clear the generated service_account_id field.

@spot_pricing_policy.setter
def spot_pricing_policy(self, value: SpotPricingPolicySpec | None): (source)

Set or clear the generated spot_pricing_policy field.

@stopped.setter
def stopped(self, value: bool | None): (source)

Set or clear the generated stopped field.

@property
boot_disk: AttachedDiskSpec = (source)

Specified boot disk attached to the instance.

@property
cloud_init_user_data: str = (source)

Data in cloud-init format for customizing instance initialization. For details, see https://docs.nebius.com/compute/virtual-machines/manage#user-data

@property
filesystems: MutableSequence[AttachedFilesystemSpec] = (source)

List of Shared Filesystems attached to the instance.

@property
follows_spot_price: FollowsSpotPriceSpec | None = (source)

The preemptible VM accepts the current spot price.

@property
gpu_cluster: InstanceGpuClusterSpec = (source)

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

@property
hostname: str = (source)

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.

@property
local_disks: LocalDisksSpec = (source)

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.

@property
network_interfaces: MutableSequence[NetworkInterfaceSpec] = (source)

List of network interfaces attached to the instance.

@property
nvl_instance_group_id: str = (source)

NVLink Instance Group ID associated with the VM

@property
on_demand: OnDemandSpec | None = (source)

A regular, non-preemptible VM.

@property
preemptible: PreemptibleSpec = (source)

Set this field to create a preemptible VM, or omit it to create a regular VM. For details, see https://docs.nebius.com/compute/virtual-machines/preemptible A preemptible VM cannot be converted to a regular VM or vice versa. Once set, this field cannot be removed; if the VM was created without it, the field cannot be added later.

@property
pricing_model: __OneOfClass_pricing_model_on_demand__ | __OneOfClass_pricing_model_follows_spot_price__ | __OneOfClass_pricing_model_spot_pricing_policy__ | None = (source)

Default is on_demand.

@property
recovery_policy: InstanceRecoveryPolicy = (source)

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.
  • If set to ALWAYS, keep retrying recovery indefinitely until the instance is recovered. Available only for instances in nvlinstancegroup
@property
reservation_policy: ReservationPolicy = (source)

Undocumented

@property
resources: ResourcesSpec = (source)

Specification of compute resources allocated to the instance. For details, see https://docs.nebius.com/compute/virtual-machines/types

@property
secondary_disks: MutableSequence[AttachedDiskSpec] = (source)

List of additional data disks attached to the instance beyond the boot disk.

@property
service_account_id: str = (source)

Unique identifier of the service account associated with this instance. For details, see https://docs.nebius.com/iam/service-accounts/manage

@property
spot_pricing_policy: SpotPricingPolicySpec | None = (source)

The preemptible VM accepts the current spot price unless it exceeds the maximum price specified by the selected pricing policy. When the spot price exceeds that maximum price, the VM is preempted.

@property
stopped: bool = (source)

Indicates whether the instance should be stopped.