@nebius/js-sdk - v0.2.54
    Preparing search index...

    Interface InstanceServiceBaseClient

    Defines the low-level gRPC client for the nebius.compute.v1.InstanceService service.

    interface InstanceServiceBaseClient {
        batchGet(
            request: BatchGetRequest,
            metadata: Metadata,
            options: Partial<CallOptions>,
            callback: (error: ServiceError | null, response: BatchGetResponse) => void,
        ): SurfaceCall;
        create(
            request: CreateInstanceRequest,
            metadata: Metadata,
            options: Partial<CallOptions>,
            callback: (error: ServiceError | null, response: Operation) => void,
        ): SurfaceCall;
        delete(
            request: DeleteInstanceRequest,
            metadata: Metadata,
            options: Partial<CallOptions>,
            callback: (error: ServiceError | null, response: Operation) => void,
        ): SurfaceCall;
        get(
            request: GetInstanceRequest,
            metadata: Metadata,
            options: Partial<CallOptions>,
            callback: (error: ServiceError | null, response: Instance) => void,
        ): SurfaceCall;
        getByName(
            request: GetByNameRequest,
            metadata: Metadata,
            options: Partial<CallOptions>,
            callback: (error: ServiceError | null, response: Instance) => void,
        ): SurfaceCall;
        list(
            request: ListInstancesRequest,
            metadata: Metadata,
            options: Partial<CallOptions>,
            callback: (
                error: ServiceError | null,
                response: ListInstancesResponse,
            ) => void,
        ): SurfaceCall;
        listInstancesByNVLInstanceGroup(
            request: ListInstancesByNVLInstanceGroupRequest,
            metadata: Metadata,
            options: Partial<CallOptions>,
            callback: (
                error: ServiceError | null,
                response: ListInstancesResponse,
            ) => void,
        ): SurfaceCall;
        listOperationsByParent(
            request: ListOperationsByParentRequest,
            metadata: Metadata,
            options: Partial<CallOptions>,
            callback: (
                error: ServiceError | null,
                response: ListOperationsResponse,
            ) => void,
        ): SurfaceCall;
        start(
            request: StartInstanceRequest,
            metadata: Metadata,
            options: Partial<CallOptions>,
            callback: (error: ServiceError | null, response: Operation) => void,
        ): SurfaceCall;
        stop(
            request: StopInstanceRequest,
            metadata: Metadata,
            options: Partial<CallOptions>,
            callback: (error: ServiceError | null, response: Operation) => void,
        ): SurfaceCall;
        update(
            request: UpdateInstanceRequest,
            metadata: Metadata,
            options: Partial<CallOptions>,
            callback: (error: ServiceError | null, response: Operation) => void,
        ): SurfaceCall;
    }

    Hierarchy

    • Client
      • InstanceServiceBaseClient
    Index
    batchGet create delete get getByName list listInstancesByNVLInstanceGroup listOperationsByParent start stop update

    • Retrieves detailed information about specific VMs by their IDs. If instance cannot be retrieved (e.g. not found) error is returned in place of instance instead.

      Parameters

      • request: BatchGetRequest
      • metadata: Metadata
      • options: Partial<CallOptions>
      • callback: (error: ServiceError | null, response: BatchGetResponse) => void
          • (error: ServiceError | null, response: BatchGetResponse): void

          • Retrieves detailed information about specific VMs by their IDs. If instance cannot be retrieved (e.g. not found) error is returned in place of instance instead.

            Parameters

            Returns void

      Returns SurfaceCall

    • Deletes a VM instance by its ID. Also deletes all the managed disks, declared in the instance spec. Fails if cannot delete any of the managed disks.

      Parameters

      • request: DeleteInstanceRequest
      • metadata: Metadata
      • options: Partial<CallOptions>
      • callback: (error: ServiceError | null, response: Operation) => void
          • (error: ServiceError | null, response: Operation): void

          • Deletes a VM instance by its ID. Also deletes all the managed disks, declared in the instance spec. Fails if cannot delete any of the managed disks.

            Parameters

            • error: ServiceError | null
            • response: Operation

            Returns void

      Returns SurfaceCall

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

      Parameters

      • request: GetInstanceRequest
      • metadata: Metadata
      • options: Partial<CallOptions>
      • callback: (error: ServiceError | null, response: Instance) => void
          • (error: ServiceError | null, response: Instance): void

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

            Parameters

            • error: ServiceError | null
            • response: Instance

            Returns void

      Returns SurfaceCall

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

      Parameters

      • request: GetByNameRequest
      • metadata: Metadata
      • options: Partial<CallOptions>
      • callback: (error: ServiceError | null, response: Instance) => void
          • (error: ServiceError | null, response: Instance): void

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

            Parameters

            • error: ServiceError | null
            • response: Instance

            Returns void

      Returns SurfaceCall

    • Lists all VM instances within a specified parent.

      Parameters

      Returns SurfaceCall

    • Lists all VM instances that belong to the specified NVL instance group.

      Parameters

      Returns SurfaceCall

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

      Parameters

      Returns SurfaceCall

    • Starts a stopped VM instance.

      Parameters

      • request: StartInstanceRequest
      • metadata: Metadata
      • options: Partial<CallOptions>
      • callback: (error: ServiceError | null, response: Operation) => void
          • (error: ServiceError | null, response: Operation): void

          • Starts a stopped VM instance.

            Parameters

            • error: ServiceError | null
            • response: Operation

            Returns void

      Returns SurfaceCall

    • Stops a running VM instance.

      Parameters

      • request: StopInstanceRequest
      • metadata: Metadata
      • options: Partial<CallOptions>
      • callback: (error: ServiceError | null, response: Operation) => void
          • (error: ServiceError | null, response: Operation): void

          • Stops a running VM instance.

            Parameters

            • error: ServiceError | null
            • response: Operation

            Returns void

      Returns SurfaceCall

    • Updates an existing VM instance with new configuration parameters.

      Parameters

      • request: UpdateInstanceRequest
      • metadata: Metadata
      • options: Partial<CallOptions>
      • callback: (error: ServiceError | null, response: Operation) => void
          • (error: ServiceError | null, response: Operation): void

          • Updates an existing VM instance with new configuration parameters.

            Parameters

            • error: ServiceError | null
            • response: Operation

            Returns void

      Returns SurfaceCall

    Settings
    Member Visibility

    On This Page
    Methods