Class InstanceService

constructor

• new InstanceService(sdk: SDKInterface): InstanceService

  Parameters

  • sdk: SDKInterface

  Returns InstanceService

$type

create

• create(
      request: CreateInstanceRequest,
  ): Request<CreateInstanceRequest, Operation<GetOperationRequest>>

  Creates a new VM instance based on the provided specification. For details, see https://docs.nebius.com/compute/virtual-machines/manage

  Parameters

  • request: CreateInstanceRequest

  Returns Request<CreateInstanceRequest, Operation<GetOperationRequest>>

• create(
      request: CreateInstanceRequest,
      metadata: Metadata,
  ): Request<CreateInstanceRequest, Operation<GetOperationRequest>>

  Parameters

  • request: CreateInstanceRequest
  • metadata: Metadata

  Returns Request<CreateInstanceRequest, Operation<GetOperationRequest>>

• create(
      request: CreateInstanceRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<CreateInstanceRequest, Operation<GetOperationRequest>>

  Parameters

  • request: CreateInstanceRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<CreateInstanceRequest, Operation<GetOperationRequest>>

• create(
      request: CreateInstanceRequest,
  ): Request<CreateInstanceRequest, Operation<GetOperationRequest>>

  Creates a new VM instance based on the provided specification. For details, see https://docs.nebius.com/compute/virtual-machines/manage

  Parameters

  • request: CreateInstanceRequest

  Returns Request<CreateInstanceRequest, Operation<GetOperationRequest>>

• create(
      request: CreateInstanceRequest,
      metadata: Metadata,
  ): Request<CreateInstanceRequest, Operation<GetOperationRequest>>

  Creates a new VM instance based on the provided specification. For details, see https://docs.nebius.com/compute/virtual-machines/manage

  Parameters

  • request: CreateInstanceRequest
  • metadata: Metadata

  Returns Request<CreateInstanceRequest, Operation<GetOperationRequest>>

• create(
      request: CreateInstanceRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<CreateInstanceRequest, Operation<GetOperationRequest>>

  Creates a new VM instance based on the provided specification. For details, see https://docs.nebius.com/compute/virtual-machines/manage

  Parameters

  • request: CreateInstanceRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<CreateInstanceRequest, Operation<GetOperationRequest>>

delete

• delete(
      request: DeleteInstanceRequest,
  ): Request<DeleteInstanceRequest, Operation<GetOperationRequest>>

  Deletes a VM instance by its ID.

  Parameters

  • request: DeleteInstanceRequest

  Returns Request<DeleteInstanceRequest, Operation<GetOperationRequest>>

• delete(
      request: DeleteInstanceRequest,
      metadata: Metadata,
  ): Request<DeleteInstanceRequest, Operation<GetOperationRequest>>

  Parameters

  • request: DeleteInstanceRequest
  • metadata: Metadata

  Returns Request<DeleteInstanceRequest, Operation<GetOperationRequest>>

• delete(
      request: DeleteInstanceRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<DeleteInstanceRequest, Operation<GetOperationRequest>>

  Parameters

  • request: DeleteInstanceRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<DeleteInstanceRequest, Operation<GetOperationRequest>>

• delete(
      request: DeleteInstanceRequest,
  ): Request<DeleteInstanceRequest, Operation<GetOperationRequest>>

  Deletes a VM instance by its ID.

  Parameters

  • request: DeleteInstanceRequest

  Returns Request<DeleteInstanceRequest, Operation<GetOperationRequest>>

• delete(
      request: DeleteInstanceRequest,
      metadata: Metadata,
  ): Request<DeleteInstanceRequest, Operation<GetOperationRequest>>

  Deletes a VM instance by its ID.

  Parameters

  • request: DeleteInstanceRequest
  • metadata: Metadata

  Returns Request<DeleteInstanceRequest, Operation<GetOperationRequest>>

• delete(
      request: DeleteInstanceRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<DeleteInstanceRequest, Operation<GetOperationRequest>>

  Deletes a VM instance by its ID.

  Parameters

  • request: DeleteInstanceRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<DeleteInstanceRequest, Operation<GetOperationRequest>>

get

• get(request: GetInstanceRequest): Request<GetInstanceRequest, Instance>

  Retrieves detailed information about a specific VM instance by its ID.

  Parameters

  • request: GetInstanceRequest

  Returns Request<GetInstanceRequest, Instance>

• get(
      request: GetInstanceRequest,
      metadata: Metadata,
  ): Request<GetInstanceRequest, Instance>

  Parameters

  • request: GetInstanceRequest
  • metadata: Metadata

  Returns Request<GetInstanceRequest, Instance>

• get(
      request: GetInstanceRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<GetInstanceRequest, Instance>

  Parameters

  • request: GetInstanceRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<GetInstanceRequest, Instance>

• get(request: GetInstanceRequest): Request<GetInstanceRequest, Instance>

  Retrieves detailed information about a specific VM instance by its ID.

  Parameters

  • request: GetInstanceRequest

  Returns Request<GetInstanceRequest, Instance>

• get(
      request: GetInstanceRequest,
      metadata: Metadata,
  ): Request<GetInstanceRequest, Instance>

  Retrieves detailed information about a specific VM instance by its ID.

  Parameters

  • request: GetInstanceRequest
  • metadata: Metadata

  Returns Request<GetInstanceRequest, Instance>

• get(
      request: GetInstanceRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<GetInstanceRequest, Instance>

  Retrieves detailed information about a specific VM instance by its ID.

  Parameters

  • request: GetInstanceRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<GetInstanceRequest, Instance>

getByName

• getByName(request: GetByNameRequest): Request<GetByNameRequest, Instance>

  Retrieves detailed information about a specific VM instance by its parent and name.

  Parameters

  • request: GetByNameRequest

  Returns Request<GetByNameRequest, Instance>

• getByName(
      request: GetByNameRequest,
      metadata: Metadata,
  ): Request<GetByNameRequest, Instance>

  Parameters

  • request: GetByNameRequest
  • metadata: Metadata

  Returns Request<GetByNameRequest, Instance>

• getByName(
      request: GetByNameRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<GetByNameRequest, Instance>

  Parameters

  • request: GetByNameRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<GetByNameRequest, Instance>

• getByName(request: GetByNameRequest): Request<GetByNameRequest, Instance>

  Retrieves detailed information about a specific VM instance by its parent and name.

  Parameters

  • request: GetByNameRequest

  Returns Request<GetByNameRequest, Instance>

• getByName(
      request: GetByNameRequest,
      metadata: Metadata,
  ): Request<GetByNameRequest, Instance>

  Retrieves detailed information about a specific VM instance by its parent and name.

  Parameters

  • request: GetByNameRequest
  • metadata: Metadata

  Returns Request<GetByNameRequest, Instance>

• getByName(
      request: GetByNameRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<GetByNameRequest, Instance>

  Retrieves detailed information about a specific VM instance by its parent and name.

  Parameters

  • request: GetByNameRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<GetByNameRequest, Instance>

getOperationService

• getOperationService(): OperationService

  Returns OperationService

list

• list(
      request: ListInstancesRequest,
  ): Request<ListInstancesRequest, ListInstancesResponse>

  Lists all VM instances within a specified parent.

  Parameters

  • request: ListInstancesRequest

  Returns Request<ListInstancesRequest, ListInstancesResponse>

• list(
      request: ListInstancesRequest,
      metadata: Metadata,
  ): Request<ListInstancesRequest, ListInstancesResponse>

  Parameters

  • request: ListInstancesRequest
  • metadata: Metadata

  Returns Request<ListInstancesRequest, ListInstancesResponse>

• list(
      request: ListInstancesRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<ListInstancesRequest, ListInstancesResponse>

  Parameters

  • request: ListInstancesRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<ListInstancesRequest, ListInstancesResponse>

• list(
      request: ListInstancesRequest,
  ): Request<ListInstancesRequest, ListInstancesResponse>

  Lists all VM instances within a specified parent.

  Parameters

  • request: ListInstancesRequest

  Returns Request<ListInstancesRequest, ListInstancesResponse>

• list(
      request: ListInstancesRequest,
      metadata: Metadata,
  ): Request<ListInstancesRequest, ListInstancesResponse>

  Lists all VM instances within a specified parent.

  Parameters

  • request: ListInstancesRequest
  • metadata: Metadata

  Returns Request<ListInstancesRequest, ListInstancesResponse>

• list(
      request: ListInstancesRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<ListInstancesRequest, ListInstancesResponse>

  Lists all VM instances within a specified parent.

  Parameters

  • request: ListInstancesRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<ListInstancesRequest, ListInstancesResponse>

listOperationsByParent

• listOperationsByParent(
      request: ListOperationsByParentRequest,
  ): Request<ListOperationsByParentRequest, ListOperationsResponse>

  Lists all operations that were performed within a specific parent resource.

  Parameters

  • request: ListOperationsByParentRequest

  Returns Request<ListOperationsByParentRequest, ListOperationsResponse>

• listOperationsByParent(
      request: ListOperationsByParentRequest,
      metadata: Metadata,
  ): Request<ListOperationsByParentRequest, ListOperationsResponse>

  Parameters

  • request: ListOperationsByParentRequest
  • metadata: Metadata

  Returns Request<ListOperationsByParentRequest, ListOperationsResponse>

• listOperationsByParent(
      request: ListOperationsByParentRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<ListOperationsByParentRequest, ListOperationsResponse>

  Parameters

  • request: ListOperationsByParentRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<ListOperationsByParentRequest, ListOperationsResponse>

• listOperationsByParent(
      request: ListOperationsByParentRequest,
  ): Request<ListOperationsByParentRequest, ListOperationsResponse>

  Lists all operations that were performed within a specific parent resource.

  Parameters

  • request: ListOperationsByParentRequest

  Returns Request<ListOperationsByParentRequest, ListOperationsResponse>

• listOperationsByParent(
      request: ListOperationsByParentRequest,
      metadata: Metadata,
  ): Request<ListOperationsByParentRequest, ListOperationsResponse>

  Lists all operations that were performed within a specific parent resource.

  Parameters

  • request: ListOperationsByParentRequest
  • metadata: Metadata

  Returns Request<ListOperationsByParentRequest, ListOperationsResponse>

• listOperationsByParent(
      request: ListOperationsByParentRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<ListOperationsByParentRequest, ListOperationsResponse>

  Lists all operations that were performed within a specific parent resource.

  Parameters

  • request: ListOperationsByParentRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<ListOperationsByParentRequest, ListOperationsResponse>

start

• start(
      request: StartInstanceRequest,
  ): Request<StartInstanceRequest, Operation<GetOperationRequest>>

  Starts a stopped VM instance.

  Parameters

  • request: StartInstanceRequest

  Returns Request<StartInstanceRequest, Operation<GetOperationRequest>>

• start(
      request: StartInstanceRequest,
      metadata: Metadata,
  ): Request<StartInstanceRequest, Operation<GetOperationRequest>>

  Parameters

  • request: StartInstanceRequest
  • metadata: Metadata

  Returns Request<StartInstanceRequest, Operation<GetOperationRequest>>

• start(
      request: StartInstanceRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<StartInstanceRequest, Operation<GetOperationRequest>>

  Parameters

  • request: StartInstanceRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<StartInstanceRequest, Operation<GetOperationRequest>>

• start(
      request: StartInstanceRequest,
  ): Request<StartInstanceRequest, Operation<GetOperationRequest>>

  Starts a stopped VM instance.

  Parameters

  • request: StartInstanceRequest

  Returns Request<StartInstanceRequest, Operation<GetOperationRequest>>

• start(
      request: StartInstanceRequest,
      metadata: Metadata,
  ): Request<StartInstanceRequest, Operation<GetOperationRequest>>

  Starts a stopped VM instance.

  Parameters

  • request: StartInstanceRequest
  • metadata: Metadata

  Returns Request<StartInstanceRequest, Operation<GetOperationRequest>>

• start(
      request: StartInstanceRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<StartInstanceRequest, Operation<GetOperationRequest>>

  Starts a stopped VM instance.

  Parameters

  • request: StartInstanceRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<StartInstanceRequest, Operation<GetOperationRequest>>

stop

• stop(
      request: StopInstanceRequest,
  ): Request<StopInstanceRequest, Operation<GetOperationRequest>>

  Stops a running VM instance.

  Parameters

  • request: StopInstanceRequest

  Returns Request<StopInstanceRequest, Operation<GetOperationRequest>>

• stop(
      request: StopInstanceRequest,
      metadata: Metadata,
  ): Request<StopInstanceRequest, Operation<GetOperationRequest>>

  Parameters

  • request: StopInstanceRequest
  • metadata: Metadata

  Returns Request<StopInstanceRequest, Operation<GetOperationRequest>>

• stop(
      request: StopInstanceRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<StopInstanceRequest, Operation<GetOperationRequest>>

  Parameters

  • request: StopInstanceRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<StopInstanceRequest, Operation<GetOperationRequest>>

• stop(
      request: StopInstanceRequest,
  ): Request<StopInstanceRequest, Operation<GetOperationRequest>>

  Stops a running VM instance.

  Parameters

  • request: StopInstanceRequest

  Returns Request<StopInstanceRequest, Operation<GetOperationRequest>>

• stop(
      request: StopInstanceRequest,
      metadata: Metadata,
  ): Request<StopInstanceRequest, Operation<GetOperationRequest>>

  Stops a running VM instance.

  Parameters

  • request: StopInstanceRequest
  • metadata: Metadata

  Returns Request<StopInstanceRequest, Operation<GetOperationRequest>>

• stop(
      request: StopInstanceRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<StopInstanceRequest, Operation<GetOperationRequest>>

  Stops a running VM instance.

  Parameters

  • request: StopInstanceRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<StopInstanceRequest, Operation<GetOperationRequest>>

update

• update(
      request: UpdateInstanceRequest,
  ): Request<UpdateInstanceRequest, Operation<GetOperationRequest>>

  Updates an existing VM instance with new configuration parameters.

  Parameters

  • request: UpdateInstanceRequest

  Returns Request<UpdateInstanceRequest, Operation<GetOperationRequest>>

• update(
      request: UpdateInstanceRequest,
      metadata: Metadata,
  ): Request<UpdateInstanceRequest, Operation<GetOperationRequest>>

  Parameters

  • request: UpdateInstanceRequest
  • metadata: Metadata

  Returns Request<UpdateInstanceRequest, Operation<GetOperationRequest>>

• update(
      request: UpdateInstanceRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<UpdateInstanceRequest, Operation<GetOperationRequest>>

  Parameters

  • request: UpdateInstanceRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<UpdateInstanceRequest, Operation<GetOperationRequest>>

• update(
      request: UpdateInstanceRequest,
  ): Request<UpdateInstanceRequest, Operation<GetOperationRequest>>

  Updates an existing VM instance with new configuration parameters.

  Parameters

  • request: UpdateInstanceRequest

  Returns Request<UpdateInstanceRequest, Operation<GetOperationRequest>>

• update(
      request: UpdateInstanceRequest,
      metadata: Metadata,
  ): Request<UpdateInstanceRequest, Operation<GetOperationRequest>>

  Updates an existing VM instance with new configuration parameters.

  Parameters

  • request: UpdateInstanceRequest
  • metadata: Metadata

  Returns Request<UpdateInstanceRequest, Operation<GetOperationRequest>>

• update(
      request: UpdateInstanceRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<UpdateInstanceRequest, Operation<GetOperationRequest>>

  Updates an existing VM instance with new configuration parameters.

  Parameters

  • request: UpdateInstanceRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<UpdateInstanceRequest, Operation<GetOperationRequest>>