Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ComputeClient

This service client does not use circuit breakers by default if the user has not defined a circuit breaker configuration.

Hierarchy

  • ComputeClient

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new ComputeClient(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration): ComputeClient

Properties

Protected _bodyDuplexMode

_bodyDuplexMode: any = undefined

Protected _circuitBreaker

_circuitBreaker: typeof Breaker | null = null

Protected _clientConfiguration

_clientConfiguration: ClientConfiguration

Protected _defaultHeaders

_defaultHeaders: any

Protected _endpoint

_endpoint: string = ""

Protected _httpClient

_httpClient: HttpClient

Protected _httpOptions

_httpOptions: any = undefined

Protected _lastSetRegionOrRegionId

_lastSetRegionOrRegionId: string = ""

Protected _realmSpecificEndpointTemplateEnabled

_realmSpecificEndpointTemplateEnabled: boolean | undefined = undefined

Protected _region

_region: Region

Protected _regionId

_regionId: string = ""

Protected _waiters

_waiters: ComputeWaiter

targetService

targetService: string = "Compute"

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

serviceEndpointTemplate: string = "https://iaas.{region}.{secondLevelDomain}"

Accessors

endpoint

  • get endpoint(): string
  • set endpoint(endpoint: string): void

logger

region

  • set region(region: Region): void
  • Sets the region to call (ex, Region.US_PHOENIX_1). Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint.

    Parameters

    • region: Region

      The region of the service.

    Returns void

regionId

  • set regionId(regionId: string): void
  • Sets the regionId to call (ex, 'us-phoenix-1').

    Note, this will first try to map the region ID to a known Region and call {@link #region(Region) region}. If no known Region could be determined, it will create an endpoint assuming its in default Realm OC1 and then call {@link #endpoint(String) endpoint}.

    Parameters

    • regionId: string

      The public region ID.

    Returns void

useRealmSpecificEndpointTemplate

  • set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled: boolean): void
  • Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to "true" if the user wants to enable use of realm specific endpoint template, otherwise set it to "false"

    Parameters

    • realmSpecificEndpointTemplateEnabled: boolean

      flag to enable the use of realm specific endpoint template

    Returns void

Methods

acceptShieldedIntegrityPolicy

addImageShapeCompatibilityEntry

attachBootVolume

  • Attaches the specified boot volume to the specified instance.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use AttachBootVolume API.

    Parameters

    Returns Promise<AttachBootVolumeResponse>

    AttachBootVolumeResponse

attachVnic

attachVolume

  • Attaches the specified storage volume to the specified instance.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use AttachVolume API.

    Parameters

    Returns Promise<AttachVolumeResponse>

    AttachVolumeResponse

captureConsoleHistory

  • Captures the most recent serial console data (up to a megabyte) for the specified instance.

    The `CaptureConsoleHistory` operation works with the other console history operations as described below.

    1. Use `CaptureConsoleHistory` to request the capture of up to a megabyte of the most recent console history. This call returns a `ConsoleHistory` object. The object will have a state of REQUESTED. 2. Wait for the capture operation to succeed by polling `GetConsoleHistory` with the identifier of the console history metadata. The state of the `ConsoleHistory` object will go from REQUESTED to GETTING-HISTORY and then SUCCEEDED (or FAILED). 3. Use `GetConsoleHistoryContent` to get the actual console history data (not the metadata). 4. Optionally, use `DeleteConsoleHistory` to delete the console history metadata and the console history data.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CaptureConsoleHistory API.

    Parameters

    Returns Promise<CaptureConsoleHistoryResponse>

    CaptureConsoleHistoryResponse

changeComputeCapacityReservationCompartment

changeComputeCapacityTopologyCompartment

changeComputeClusterCompartment

  • Moves a compute cluster into a different compartment within the same tenancy. A compute cluster is a remote direct memory access (RDMA) network group.

    For information about moving resources between compartments, see [Moving Resources to a Different Compartment](https://docs.cloud.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ChangeComputeClusterCompartment API.

    Parameters

    Returns Promise<ChangeComputeClusterCompartmentResponse>

    ChangeComputeClusterCompartmentResponse

changeComputeImageCapabilitySchemaCompartment

changeDedicatedVmHostCompartment

changeImageCompartment

changeInstanceCompartment

close

  • close(): void

createAppCatalogSubscription

  • Create a subscription for listing resource version for a compartment. It will take some time to propagate to all regions.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateAppCatalogSubscription API.

    Parameters

    Returns Promise<CreateAppCatalogSubscriptionResponse>

    CreateAppCatalogSubscriptionResponse

createComputeCapacityReport

  • Generates a report of the host capacity within an availability domain that is available for you to create compute instances. Host capacity is the physical infrastructure that resources such as compute instances run on.

    Use the capacity report to determine whether sufficient capacity is available for a shape before you create an instance or change the shape of an instance.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateComputeCapacityReport API.

    Parameters

    Returns Promise<CreateComputeCapacityReportResponse>

    CreateComputeCapacityReportResponse

createComputeCapacityReservation

  • Creates a new compute capacity reservation in the specified compartment and availability domain. Compute capacity reservations let you reserve instances in a compartment. When you launch an instance using this reservation, you are assured that you have enough space for your instance, and you won't get out of capacity errors. For more information, see Reserved Capacity.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateComputeCapacityReservation API.

    Parameters

    Returns Promise<CreateComputeCapacityReservationResponse>

    CreateComputeCapacityReservationResponse

createComputeCapacityTopology

  • Creates a new compute capacity topology in the specified compartment and availability domain.

    Compute capacity topologies provide the RDMA network topology of your bare metal hosts so that you can launch instances on your bare metal hosts with targeted network locations.

    Compute capacity topologies report the health status of your bare metal hosts.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateComputeCapacityTopology API.

    Parameters

    Returns Promise<CreateComputeCapacityTopologyResponse>

    CreateComputeCapacityTopologyResponse

createComputeCluster

  • Creates an empty compute cluster. A compute cluster is a remote direct memory access (RDMA) network group.

    After the compute cluster is created, you can use the compute cluster's OCID with the {@link #launchInstance(LaunchInstanceRequest) launchInstance} operation to create instances in the compute cluster. The instances must be created in the same compartment and availability domain as the cluster.

    Use compute clusters when you want to manage instances in the cluster individually, or when you want to use different types of instances in the RDMA network group.

    If you want predictable capacity for a specific number of identical instances that are managed as a group, create a cluster network that uses instance pools by using the {@link #createClusterNetwork(CreateClusterNetworkRequest) createClusterNetwork} operation.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateComputeCluster API.

    Parameters

    Returns Promise<CreateComputeClusterResponse>

    CreateComputeClusterResponse

createComputeImageCapabilitySchema

createDedicatedVmHost

  • Creates a new dedicated virtual machine host in the specified compartment and the specified availability domain. Dedicated virtual machine hosts enable you to run your Compute virtual machine (VM) instances on dedicated servers that are a single tenant and not shared with other customers. For more information, see Dedicated Virtual Machine Hosts.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateDedicatedVmHost API.

    Parameters

    Returns Promise<CreateDedicatedVmHostResponse>

    CreateDedicatedVmHostResponse

createImage

  • Creates a boot disk image for the specified instance or imports an exported image from the Oracle Cloud Infrastructure Object Storage service.

    When creating a new image, you must provide the OCID of the instance you want to use as the basis for the image, and the OCID of the compartment containing that instance. For more information about images, see [Managing Custom Images](https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/managingcustomimages.htm).

    When importing an exported image from Object Storage, you specify the source information in {@link #imageSourceDetails(ImageSourceDetailsRequest) imageSourceDetails}.

    When importing an image based on the namespace, bucket name, and object name, use {@link #imageSourceViaObjectStorageTupleDetails(ImageSourceViaObjectStorageTupleDetailsRequest) imageSourceViaObjectStorageTupleDetails}.

    When importing an image based on the Object Storage URL, use {@link #imageSourceViaObjectStorageUriDetails(ImageSourceViaObjectStorageUriDetailsRequest) imageSourceViaObjectStorageUriDetails}. See [Object Storage URLs](https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/imageimportexport.htm#URLs) and [Using Pre-Authenticated Requests](https://docs.cloud.oracle.com/iaas/Content/Object/Tasks/usingpreauthenticatedrequests.htm) for constructing URLs for image import/export.

    For more information about importing exported images, see [Image Import/Export](https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/imageimportexport.htm).

    You may optionally specify a *display name* for the image, which is simply a friendly name or description. It does not have to be unique, and you can change it. See {@link #updateImage(UpdateImageRequest) updateImage}. Avoid entering confidential information.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateImage API.

    Parameters

    Returns Promise<CreateImageResponse>

    CreateImageResponse

createInstanceConsoleConnection

  • Creates a new console connection to the specified instance. After the console connection has been created and is available, you connect to the console using SSH.

    For more information about instance console connections, see [Troubleshooting Instances Using Instance Console Connections](https://docs.cloud.oracle.com/iaas/Content/Compute/References/serialconsole.htm).

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateInstanceConsoleConnection API.

    Parameters

    Returns Promise<CreateInstanceConsoleConnectionResponse>

    CreateInstanceConsoleConnectionResponse

createWaiters

  • Creates a new ComputeWaiter for resources for this service.

    Parameters

    • workRequestClient: WorkRequestClient

      The work request service client used to query for work request status

    • Optional config: common.WaiterConfiguration

      The waiter configuration for termination and delay strategy

    Returns ComputeWaiter

    The service waiters.

deleteAppCatalogSubscription

deleteComputeCapacityReservation

deleteComputeCapacityTopology

deleteComputeCluster

  • Deletes a compute cluster. A compute cluster is a remote direct memory access (RDMA) network group.

    Before you delete a compute cluster, first delete all instances in the cluster by using the {@link #terminateInstance(TerminateInstanceRequest) terminateInstance} operation.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteComputeCluster API.

    Parameters

    Returns Promise<DeleteComputeClusterResponse>

    DeleteComputeClusterResponse

deleteComputeImageCapabilitySchema

deleteConsoleHistory

  • Deletes the specified console history metadata and the console history data.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteConsoleHistory API.

    Parameters

    Returns Promise<DeleteConsoleHistoryResponse>

    DeleteConsoleHistoryResponse

deleteDedicatedVmHost

  • Deletes the specified dedicated virtual machine host.

    If any VM instances are assigned to the dedicated virtual machine host, the delete operation will fail and the service will return a 409 response code.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteDedicatedVmHost API.

    Parameters

    Returns Promise<DeleteDedicatedVmHostResponse>

    DeleteDedicatedVmHostResponse

deleteImage

deleteInstanceConsoleConnection

detachBootVolume

  • Detaches a boot volume from an instance. You must specify the OCID of the boot volume attachment.

    This is an asynchronous operation. The attachment's `lifecycleState` will change to DETACHING temporarily until the attachment is completely removed.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DetachBootVolume API.

    Parameters

    Returns Promise<DetachBootVolumeResponse>

    DetachBootVolumeResponse

detachVnic

  • Detaches and deletes the specified secondary VNIC. This operation cannot be used on the instance's primary VNIC. When you terminate an instance, all attached VNICs (primary and secondary) are automatically detached and deleted.

    *Important:** If the VNIC has a PrivateIp that is the [target of a route rule](https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/managingroutetables.htm#privateip), deleting the VNIC causes that route rule to blackhole and the traffic will be dropped.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DetachVnic API.

    Parameters

    Returns Promise<DetachVnicResponse>

    DetachVnicResponse

detachVolume

  • Detaches a storage volume from an instance. You must specify the OCID of the volume attachment.

    This is an asynchronous operation. The attachment's `lifecycleState` will change to DETACHING temporarily until the attachment is completely removed.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DetachVolume API.

    Parameters

    Returns Promise<DetachVolumeResponse>

    DetachVolumeResponse

exportImage

  • Exports the specified image to the Oracle Cloud Infrastructure Object Storage service. You can use the Object Storage URL, or the namespace, bucket name, and object name when specifying the location to export to.

    For more information about exporting images, see [Image Import/Export](https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/imageimportexport.htm).

    To perform an image export, you need write access to the Object Storage bucket for the image, see [Let Users Write Objects to Object Storage Buckets](https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/commonpolicies.htm#Let4).

    See [Object Storage URLs](https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/imageimportexport.htm#URLs) and [Using Pre-Authenticated Requests](https://docs.cloud.oracle.com/iaas/Content/Object/Tasks/usingpreauthenticatedrequests.htm) for constructing URLs for image import/export.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ExportImage API.

    Parameters

    Returns Promise<ExportImageResponse>

    ExportImageResponse

getAppCatalogListing

getAppCatalogListingAgreements

getAppCatalogListingResourceVersion

getBootVolumeAttachment

getComputeCapacityReservation

getComputeCapacityTopology

  • Gets information about the specified compute capacity topology. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetComputeCapacityTopology API.

    Parameters

    Returns Promise<GetComputeCapacityTopologyResponse>

    GetComputeCapacityTopologyResponse

getComputeCluster

getComputeGlobalImageCapabilitySchema

getComputeGlobalImageCapabilitySchemaVersion

getComputeImageCapabilitySchema

getConsoleHistory

  • Shows the metadata for the specified console history. See {@link #captureConsoleHistory(CaptureConsoleHistoryRequest) captureConsoleHistory} for details about using the console history operations.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetConsoleHistory API.

    Parameters

    Returns Promise<GetConsoleHistoryResponse>

    GetConsoleHistoryResponse

getConsoleHistoryContent

  • Gets the actual console history data (not the metadata). See {@link #captureConsoleHistory(CaptureConsoleHistoryRequest) captureConsoleHistory} for details about using the console history operations.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetConsoleHistoryContent API.

    Parameters

    Returns Promise<GetConsoleHistoryContentResponse>

    GetConsoleHistoryContentResponse

getDedicatedVmHost

  • Gets information about the specified dedicated virtual machine host. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetDedicatedVmHost API.

    Parameters

    Returns Promise<GetDedicatedVmHostResponse>

    GetDedicatedVmHostResponse

getImage

  • Gets the specified image. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetImage API.

    Parameters

    Returns Promise<GetImageResponse>

    GetImageResponse

getImageShapeCompatibilityEntry

getInstance

  • Gets information about the specified instance.

    *Note:** To retrieve public and private IP addresses for an instance, use the {@link #listVnicAttachments(ListVnicAttachmentsRequest) listVnicAttachments} operation to get the VNIC ID for the instance, and then call {@link #getVnic(GetVnicRequest) getVnic} with the VNIC ID.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetInstance API.

    Parameters

    Returns Promise<GetInstanceResponse>

    GetInstanceResponse

getInstanceConsoleConnection

getInstanceMaintenanceReboot

getMeasuredBootReport

getVnicAttachment

  • Gets the information for the specified VNIC attachment.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetVnicAttachment API.

    Parameters

    Returns Promise<GetVnicAttachmentResponse>

    GetVnicAttachmentResponse

getVolumeAttachment

getWaiters

getWindowsInstanceInitialCredentials

  • Gets the generated credentials for the instance. Only works for instances that require a password to log in, such as Windows. For certain operating systems, users will be forced to change the initial credentials.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetWindowsInstanceInitialCredentials API.

    Parameters

    Returns Promise<GetWindowsInstanceInitialCredentialsResponse>

    GetWindowsInstanceInitialCredentialsResponse

instanceAction

  • Performs one of the following power actions on the specified instance:

    - **START** - Powers on the instance.

    - **STOP** - Powers off the instance.

    - **RESET** - Powers off the instance and then powers it back on.

    - **SOFTSTOP** - Gracefully shuts down the instance by sending a shutdown command to the operating system. After waiting 15 minutes for the OS to shut down, the instance is powered off. If the applications that run on the instance take more than 15 minutes to shut down, they could be improperly stopped, resulting in data corruption. To avoid this, manually shut down the instance using the commands available in the OS before you softstop the instance.

    - **SOFTRESET** - Gracefully reboots the instance by sending a shutdown command to the operating system. After waiting 15 minutes for the OS to shut down, the instance is powered off and then powered back on.

    • SENDDIAGNOSTICINTERRUPT - For advanced users. Caution: Sending a diagnostic interrupt to a live system can cause data corruption or system failure. Sends a diagnostic interrupt that causes the instance's OS to crash and then reboot. Before you send a diagnostic interrupt, you must configure the instance to generate a crash dump file when it crashes. The crash dump captures information about the state of the OS at the time of the crash. After the OS restarts, you can analyze the crash dump to diagnose the issue. For more information, see Sending a Diagnostic Interrupt.

    - **DIAGNOSTICREBOOT** - Powers off the instance, rebuilds it, and then powers it back on. Before you send a diagnostic reboot, restart the instance's OS, confirm that the instance and networking settings are configured correctly, and try other [troubleshooting steps](https://docs.cloud.oracle.com/iaas/Content/Compute/References/troubleshooting-compute-instances.htm). Use diagnostic reboot as a final attempt to troubleshoot an unreachable instance. For virtual machine (VM) instances only. For more information, see [Performing a Diagnostic Reboot](https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/diagnostic-reboot.htm).

    • REBOOTMIGRATE - Powers off the instance, moves it to new hardware, and then powers it back on. For more information, see Infrastructure Maintenance.

    For more information about managing instance lifecycle states, see Stopping and Starting an Instance.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use InstanceAction API.

    Parameters

    Returns Promise<InstanceActionResponse>

    InstanceActionResponse

launchInstance

  • Creates a new instance in the specified compartment and the specified availability domain. For general information about instances, see Overview of the Compute Service.

    For information about access control and compartments, see [Overview of the IAM Service](https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/overview.htm).

    For information about availability domains, see [Regions and Availability Domains](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/regions.htm). To get a list of availability domains, use the `ListAvailabilityDomains` operation in the Identity and Access Management Service API.

    All Oracle Cloud Infrastructure resources, including instances, get an Oracle-assigned, unique ID called an Oracle Cloud Identifier (OCID). When you create a resource, you can find its OCID in the response. You can also retrieve a resource's OCID by using a List API operation on that resource type, or by viewing the resource in the Console.

    To launch an instance using an image or a boot volume use the `sourceDetails` parameter in LaunchInstanceDetails.

    When you launch an instance, it is automatically attached to a virtual network interface card (VNIC), called the *primary VNIC*. The VNIC has a private IP address from the subnet's CIDR. You can either assign a private IP address of your choice or let Oracle automatically assign one. You can choose whether the instance has a public IP address. To retrieve the addresses, use the {@link #listVnicAttachments(ListVnicAttachmentsRequest) listVnicAttachments} operation to get the VNIC ID for the instance, and then call {@link #getVnic(GetVnicRequest) getVnic} with the VNIC ID.

    You can later add secondary VNICs to an instance. For more information, see [Virtual Network Interface Cards (VNICs)](https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/managingVNICs.htm).

    To launch an instance from a Marketplace image listing, you must provide the image ID of the listing resource version that you want, but you also must subscribe to the listing before you try to launch the instance. To subscribe to the listing, use the {@link #getAppCatalogListingAgreements(GetAppCatalogListingAgreementsRequest) getAppCatalogListingAgreements} operation to get the signature for the terms of use agreement for the desired listing resource version. Then, call {@link #createAppCatalogSubscription(CreateAppCatalogSubscriptionRequest) createAppCatalogSubscription} with the signature. To get the image ID for the LaunchInstance operation, call {@link #getAppCatalogListingResourceVersion(GetAppCatalogListingResourceVersionRequest) getAppCatalogListingResourceVersion}.

    To determine whether capacity is available for a specific shape before you create an instance, use the {@link #createComputeCapacityReport(CreateComputeCapacityReportRequest) createComputeCapacityReport} operation.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use LaunchInstance API.

    Parameters

    Returns Promise<LaunchInstanceResponse>

    LaunchInstanceResponse

listAllAppCatalogListingResourceVersions

  • NOTE: This function is deprecated in favor of listAppCatalogListingResourceVersionsRecordIterator function. Creates a new async iterator which will iterate over the models.AppCatalogListingResourceVersionSummary objects contained in responses from the listAppCatalogListingResourceVersions operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<AppCatalogListingResourceVersionSummary>

listAllAppCatalogListingResourceVersionsResponses

listAllAppCatalogListings

  • NOTE: This function is deprecated in favor of listAppCatalogListingsRecordIterator function. Creates a new async iterator which will iterate over the models.AppCatalogListingSummary objects contained in responses from the listAppCatalogListings operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<AppCatalogListingSummary>

listAllAppCatalogListingsResponses

  • NOTE: This function is deprecated in favor of listAppCatalogListingsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listAppCatalogListings operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListAppCatalogListingsResponse>

listAllAppCatalogSubscriptions

  • NOTE: This function is deprecated in favor of listAppCatalogSubscriptionsRecordIterator function. Creates a new async iterator which will iterate over the models.AppCatalogSubscriptionSummary objects contained in responses from the listAppCatalogSubscriptions operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<AppCatalogSubscriptionSummary>

listAllAppCatalogSubscriptionsResponses

  • NOTE: This function is deprecated in favor of listAppCatalogSubscriptionsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listAppCatalogSubscriptions operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListAppCatalogSubscriptionsResponse>

listAllBootVolumeAttachments

  • NOTE: This function is deprecated in favor of listBootVolumeAttachmentsRecordIterator function. Creates a new async iterator which will iterate over the models.BootVolumeAttachment objects contained in responses from the listBootVolumeAttachments operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<BootVolumeAttachment>

listAllBootVolumeAttachmentsResponses

  • NOTE: This function is deprecated in favor of listBootVolumeAttachmentsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listBootVolumeAttachments operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListBootVolumeAttachmentsResponse>

listAllComputeCapacityReservationInstanceShapes

listAllComputeCapacityReservationInstanceShapesResponses

listAllComputeCapacityReservationInstances

  • NOTE: This function is deprecated in favor of listComputeCapacityReservationInstancesRecordIterator function. Creates a new async iterator which will iterate over the models.CapacityReservationInstanceSummary objects contained in responses from the listComputeCapacityReservationInstances operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<CapacityReservationInstanceSummary>

listAllComputeCapacityReservationInstancesResponses

listAllComputeCapacityReservations

  • NOTE: This function is deprecated in favor of listComputeCapacityReservationsRecordIterator function. Creates a new async iterator which will iterate over the models.ComputeCapacityReservationSummary objects contained in responses from the listComputeCapacityReservations operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ComputeCapacityReservationSummary>

listAllComputeCapacityReservationsResponses

listAllComputeGlobalImageCapabilitySchemaVersions

listAllComputeGlobalImageCapabilitySchemaVersionsResponses

listAllComputeGlobalImageCapabilitySchemas

  • NOTE: This function is deprecated in favor of listComputeGlobalImageCapabilitySchemasRecordIterator function. Creates a new async iterator which will iterate over the models.ComputeGlobalImageCapabilitySchemaSummary objects contained in responses from the listComputeGlobalImageCapabilitySchemas operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ComputeGlobalImageCapabilitySchemaSummary>

listAllComputeGlobalImageCapabilitySchemasResponses

listAllComputeImageCapabilitySchemas

  • NOTE: This function is deprecated in favor of listComputeImageCapabilitySchemasRecordIterator function. Creates a new async iterator which will iterate over the models.ComputeImageCapabilitySchemaSummary objects contained in responses from the listComputeImageCapabilitySchemas operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ComputeImageCapabilitySchemaSummary>

listAllComputeImageCapabilitySchemasResponses

listAllConsoleHistories

  • NOTE: This function is deprecated in favor of listConsoleHistoriesRecordIterator function. Creates a new async iterator which will iterate over the models.ConsoleHistory objects contained in responses from the listConsoleHistories operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ConsoleHistory>

listAllConsoleHistoriesResponses

  • NOTE: This function is deprecated in favor of listConsoleHistoriesResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listConsoleHistories operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListConsoleHistoriesResponse>

listAllDedicatedVmHostInstanceShapes

  • NOTE: This function is deprecated in favor of listDedicatedVmHostInstanceShapesRecordIterator function. Creates a new async iterator which will iterate over the models.DedicatedVmHostInstanceShapeSummary objects contained in responses from the listDedicatedVmHostInstanceShapes operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<DedicatedVmHostInstanceShapeSummary>

listAllDedicatedVmHostInstanceShapesResponses

listAllDedicatedVmHostInstances

  • NOTE: This function is deprecated in favor of listDedicatedVmHostInstancesRecordIterator function. Creates a new async iterator which will iterate over the models.DedicatedVmHostInstanceSummary objects contained in responses from the listDedicatedVmHostInstances operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<DedicatedVmHostInstanceSummary>

listAllDedicatedVmHostInstancesResponses

  • NOTE: This function is deprecated in favor of listDedicatedVmHostInstancesResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listDedicatedVmHostInstances operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListDedicatedVmHostInstancesResponse>

listAllDedicatedVmHostShapes

  • NOTE: This function is deprecated in favor of listDedicatedVmHostShapesRecordIterator function. Creates a new async iterator which will iterate over the models.DedicatedVmHostShapeSummary objects contained in responses from the listDedicatedVmHostShapes operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<DedicatedVmHostShapeSummary>

listAllDedicatedVmHostShapesResponses

  • NOTE: This function is deprecated in favor of listDedicatedVmHostShapesResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listDedicatedVmHostShapes operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListDedicatedVmHostShapesResponse>

listAllDedicatedVmHosts

  • NOTE: This function is deprecated in favor of listDedicatedVmHostsRecordIterator function. Creates a new async iterator which will iterate over the models.DedicatedVmHostSummary objects contained in responses from the listDedicatedVmHosts operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<DedicatedVmHostSummary>

listAllDedicatedVmHostsResponses

  • NOTE: This function is deprecated in favor of listDedicatedVmHostsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listDedicatedVmHosts operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListDedicatedVmHostsResponse>

listAllImageShapeCompatibilityEntries

  • NOTE: This function is deprecated in favor of listImageShapeCompatibilityEntriesRecordIterator function. Creates a new async iterator which will iterate over the models.ImageShapeCompatibilitySummary objects contained in responses from the listImageShapeCompatibilityEntries operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ImageShapeCompatibilitySummary>

listAllImageShapeCompatibilityEntriesResponses

listAllImages

  • NOTE: This function is deprecated in favor of listImagesRecordIterator function. Creates a new async iterator which will iterate over the models.Image objects contained in responses from the listImages operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<Image>

listAllImagesResponses

  • NOTE: This function is deprecated in favor of listImagesResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listImages operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListImagesResponse>

listAllInstanceConsoleConnections

  • NOTE: This function is deprecated in favor of listInstanceConsoleConnectionsRecordIterator function. Creates a new async iterator which will iterate over the models.InstanceConsoleConnection objects contained in responses from the listInstanceConsoleConnections operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<InstanceConsoleConnection>

listAllInstanceConsoleConnectionsResponses

listAllInstanceDevices

  • NOTE: This function is deprecated in favor of listInstanceDevicesRecordIterator function. Creates a new async iterator which will iterate over the models.Device objects contained in responses from the listInstanceDevices operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<Device>

listAllInstanceDevicesResponses

  • NOTE: This function is deprecated in favor of listInstanceDevicesResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listInstanceDevices operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListInstanceDevicesResponse>

listAllInstances

  • NOTE: This function is deprecated in favor of listInstancesRecordIterator function. Creates a new async iterator which will iterate over the models.Instance objects contained in responses from the listInstances operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<Instance>

listAllInstancesResponses

  • NOTE: This function is deprecated in favor of listInstancesResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listInstances operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListInstancesResponse>

listAllShapes

  • NOTE: This function is deprecated in favor of listShapesRecordIterator function. Creates a new async iterator which will iterate over the models.Shape objects contained in responses from the listShapes operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<Shape>

listAllShapesResponses

  • NOTE: This function is deprecated in favor of listShapesResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listShapes operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListShapesResponse>

listAllVnicAttachments

  • NOTE: This function is deprecated in favor of listVnicAttachmentsRecordIterator function. Creates a new async iterator which will iterate over the models.VnicAttachment objects contained in responses from the listVnicAttachments operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<VnicAttachment>

listAllVnicAttachmentsResponses

  • NOTE: This function is deprecated in favor of listVnicAttachmentsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listVnicAttachments operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListVnicAttachmentsResponse>

listAllVolumeAttachments

  • NOTE: This function is deprecated in favor of listVolumeAttachmentsRecordIterator function. Creates a new async iterator which will iterate over the models.VolumeAttachment objects contained in responses from the listVolumeAttachments operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<VolumeAttachment>

listAllVolumeAttachmentsResponses

  • NOTE: This function is deprecated in favor of listVolumeAttachmentsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listVolumeAttachments operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListVolumeAttachmentsResponse>

listAppCatalogListingResourceVersions

listAppCatalogListingResourceVersionsRecordIterator

listAppCatalogListingResourceVersionsResponseIterator

listAppCatalogListings

listAppCatalogListingsRecordIterator

  • Creates a new async iterator which will iterate over the models.AppCatalogListingSummary objects contained in responses from the listAppCatalogListings operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<AppCatalogListingSummary>

listAppCatalogListingsResponseIterator

listAppCatalogSubscriptions

listAppCatalogSubscriptionsRecordIterator

listAppCatalogSubscriptionsResponseIterator

listBootVolumeAttachments

  • Lists the boot volume attachments in the specified compartment. You can filter the list by specifying an instance OCID, boot volume OCID, or both.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListBootVolumeAttachments API.

    Parameters

    Returns Promise<ListBootVolumeAttachmentsResponse>

    ListBootVolumeAttachmentsResponse

listBootVolumeAttachmentsRecordIterator

  • Creates a new async iterator which will iterate over the models.BootVolumeAttachment objects contained in responses from the listBootVolumeAttachments operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<BootVolumeAttachment>

listBootVolumeAttachmentsResponseIterator

listComputeCapacityReservationInstanceShapes

listComputeCapacityReservationInstanceShapesRecordIterator

listComputeCapacityReservationInstanceShapesResponseIterator

listComputeCapacityReservationInstances

listComputeCapacityReservationInstancesRecordIterator

listComputeCapacityReservationInstancesResponseIterator

listComputeCapacityReservations

  • Lists the compute capacity reservations that match the specified criteria and compartment.

    You can limit the list by specifying a compute capacity reservation display name (the list will include all the identically-named compute capacity reservations in the compartment).

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListComputeCapacityReservations API.

    Parameters

    Returns Promise<ListComputeCapacityReservationsResponse>

    ListComputeCapacityReservationsResponse

listComputeCapacityReservationsRecordIterator

listComputeCapacityReservationsResponseIterator

listComputeCapacityTopologies

  • Lists the compute capacity topologies in the specified compartment. You can filter the list by a compute capacity topology display name.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListComputeCapacityTopologies API.

    Parameters

    Returns Promise<ListComputeCapacityTopologiesResponse>

    ListComputeCapacityTopologiesResponse

listComputeCapacityTopologyComputeBareMetalHosts

listComputeCapacityTopologyComputeHpcIslands

listComputeCapacityTopologyComputeNetworkBlocks

listComputeClusters

listComputeGlobalImageCapabilitySchemaVersions

listComputeGlobalImageCapabilitySchemaVersionsRecordIterator

listComputeGlobalImageCapabilitySchemaVersionsResponseIterator

listComputeGlobalImageCapabilitySchemas

listComputeGlobalImageCapabilitySchemasRecordIterator

listComputeGlobalImageCapabilitySchemasResponseIterator

listComputeImageCapabilitySchemas

  • Lists Compute Image Capability Schema in the specified compartment. You can also query by a specific imageId.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListComputeImageCapabilitySchemas API.

    Parameters

    Returns Promise<ListComputeImageCapabilitySchemasResponse>

    ListComputeImageCapabilitySchemasResponse

listComputeImageCapabilitySchemasRecordIterator

listComputeImageCapabilitySchemasResponseIterator

listConsoleHistories

  • Lists the console history metadata for the specified compartment or instance.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListConsoleHistories API.

    Parameters

    Returns Promise<ListConsoleHistoriesResponse>

    ListConsoleHistoriesResponse

listConsoleHistoriesRecordIterator

  • Creates a new async iterator which will iterate over the models.ConsoleHistory objects contained in responses from the listConsoleHistories operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ConsoleHistory>

listConsoleHistoriesResponseIterator

listDedicatedVmHostInstanceShapes

  • Lists the shapes that can be used to launch a virtual machine instance on a dedicated virtual machine host within the specified compartment. You can filter the list by compatibility with a specific dedicated virtual machine host shape.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListDedicatedVmHostInstanceShapes API.

    Parameters

    Returns Promise<ListDedicatedVmHostInstanceShapesResponse>

    ListDedicatedVmHostInstanceShapesResponse

listDedicatedVmHostInstanceShapesRecordIterator

listDedicatedVmHostInstanceShapesResponseIterator

listDedicatedVmHostInstances

listDedicatedVmHostInstancesRecordIterator

listDedicatedVmHostInstancesResponseIterator

listDedicatedVmHostShapes

  • Lists the shapes that can be used to launch a dedicated virtual machine host within the specified compartment.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListDedicatedVmHostShapes API.

    Parameters

    Returns Promise<ListDedicatedVmHostShapesResponse>

    ListDedicatedVmHostShapesResponse

listDedicatedVmHostShapesRecordIterator

listDedicatedVmHostShapesResponseIterator

listDedicatedVmHosts

  • Returns the list of dedicated virtual machine hosts that match the specified criteria in the specified compartment.

    You can limit the list by specifying a dedicated virtual machine host display name. The list will include all the identically-named dedicated virtual machine hosts in the compartment.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListDedicatedVmHosts API.

    Parameters

    Returns Promise<ListDedicatedVmHostsResponse>

    ListDedicatedVmHostsResponse

listDedicatedVmHostsRecordIterator

  • Creates a new async iterator which will iterate over the models.DedicatedVmHostSummary objects contained in responses from the listDedicatedVmHosts operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<DedicatedVmHostSummary>

listDedicatedVmHostsResponseIterator

listImageShapeCompatibilityEntries

listImageShapeCompatibilityEntriesRecordIterator

listImageShapeCompatibilityEntriesResponseIterator

listImages

  • Lists a subset of images available in the specified compartment, including platform images and custom images. The list of platform images includes the three most recently published versions of each major distribution. The list does not support filtering based on image tags.

    The list of images returned is ordered to first show the recent platform images, then all of the custom images.

    *Caution:** Platform images are refreshed regularly. When new images are released, older versions are replaced. The image OCIDs remain available, but when the platform image is replaced, the image OCIDs are no longer returned as part of the platform image list.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListImages API.

    Parameters

    Returns Promise<ListImagesResponse>

    ListImagesResponse

listImagesRecordIterator

  • Creates a new async iterator which will iterate over the models.Image objects contained in responses from the listImages operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<Image>

listImagesResponseIterator

  • Creates a new async iterator which will iterate over the responses received from the listImages operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListImagesResponse>

listInstanceConsoleConnections

  • Lists the console connections for the specified compartment or instance.

    For more information about instance console connections, see [Troubleshooting Instances Using Instance Console Connections](https://docs.cloud.oracle.com/iaas/Content/Compute/References/serialconsole.htm).

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListInstanceConsoleConnections API.

    Parameters

    Returns Promise<ListInstanceConsoleConnectionsResponse>

    ListInstanceConsoleConnectionsResponse

listInstanceConsoleConnectionsRecordIterator

listInstanceConsoleConnectionsResponseIterator

listInstanceDevices

  • Gets a list of all the devices for given instance. You can optionally filter results by device availability. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListInstanceDevices API.

    Parameters

    Returns Promise<ListInstanceDevicesResponse>

    ListInstanceDevicesResponse

listInstanceDevicesRecordIterator

  • Creates a new async iterator which will iterate over the models.Device objects contained in responses from the listInstanceDevices operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<Device>

listInstanceDevicesResponseIterator

listInstances

  • Lists the instances in the specified compartment and the specified availability domain. You can filter the results by specifying an instance name (the list will include all the identically-named instances in the compartment).

    *Note:** To retrieve public and private IP addresses for an instance, use the {@link #listVnicAttachments(ListVnicAttachmentsRequest) listVnicAttachments} operation to get the VNIC ID for the instance, and then call {@link #getVnic(GetVnicRequest) getVnic} with the VNIC ID.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListInstances API.

    Parameters

    Returns Promise<ListInstancesResponse>

    ListInstancesResponse

listInstancesRecordIterator

  • Creates a new async iterator which will iterate over the models.Instance objects contained in responses from the listInstances operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<Instance>

listInstancesResponseIterator

  • Creates a new async iterator which will iterate over the responses received from the listInstances operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListInstancesResponse>

listShapes

  • Lists the shapes that can be used to launch an instance within the specified compartment. You can filter the list by compatibility with a specific image.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListShapes API.

    Parameters

    Returns Promise<ListShapesResponse>

    ListShapesResponse

listShapesRecordIterator

  • Creates a new async iterator which will iterate over the models.Shape objects contained in responses from the listShapes operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<Shape>

listShapesResponseIterator

  • Creates a new async iterator which will iterate over the responses received from the listShapes operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListShapesResponse>

listVnicAttachments

  • Lists the VNIC attachments in the specified compartment. A VNIC attachment resides in the same compartment as the attached instance. The list can be filtered by instance, VNIC, or availability domain.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListVnicAttachments API.

    Parameters

    Returns Promise<ListVnicAttachmentsResponse>

    ListVnicAttachmentsResponse

listVnicAttachmentsRecordIterator

  • Creates a new async iterator which will iterate over the models.VnicAttachment objects contained in responses from the listVnicAttachments operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<VnicAttachment>

listVnicAttachmentsResponseIterator

listVolumeAttachments

listVolumeAttachmentsRecordIterator

  • Creates a new async iterator which will iterate over the models.VolumeAttachment objects contained in responses from the listVolumeAttachments operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<VolumeAttachment>

listVolumeAttachmentsResponseIterator

removeImageShapeCompatibilityEntry

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

terminateInstance

  • Permanently terminates (deletes) the specified instance. Any attached VNICs and volumes are automatically detached when the instance terminates.

    To preserve the boot volume associated with the instance, specify `true` for `PreserveBootVolumeQueryParam`. To delete the boot volume when the instance is deleted, specify `false` or do not specify a value for `PreserveBootVolumeQueryParam`.

    To preserve data volumes created with the instance, specify `true` or do not specify a value for `PreserveDataVolumesQueryParam`. To delete the data volumes when the instance itself is deleted, specify `false` for `PreserveDataVolumesQueryParam`.

    This is an asynchronous operation. The instance's `lifecycleState` changes to TERMINATING temporarily until the instance is completely deleted. After the instance is deleted, the record remains visible in the list of instances with the state TERMINATED for at least 12 hours, but no further action is needed.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use TerminateInstance API.

    Parameters

    Returns Promise<TerminateInstanceResponse>

    TerminateInstanceResponse

updateComputeCapacityReservation

  • Updates the specified capacity reservation and its associated capacity configurations. Fields that are not provided in the request will not be updated. Capacity configurations that are not included will be deleted. Avoid entering confidential information.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateComputeCapacityReservation API.

    Parameters

    Returns Promise<UpdateComputeCapacityReservationResponse>

    UpdateComputeCapacityReservationResponse

updateComputeCapacityTopology

  • Updates the specified compute capacity topology. Fields that are not provided in the request will not be updated.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateComputeCapacityTopology API.

    Parameters

    Returns Promise<UpdateComputeCapacityTopologyResponse>

    UpdateComputeCapacityTopologyResponse

updateComputeCluster

  • Updates a compute cluster. A compute cluster is a remote direct memory access (RDMA) network group.

    To create instances within a compute cluster, use the {@link #launchInstance(LaunchInstanceRequest) launchInstance} operation.

    To delete instances from a compute cluster, use the {@link #terminateInstance(TerminateInstanceRequest) terminateInstance} operation.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateComputeCluster API.

    Parameters

    Returns Promise<UpdateComputeClusterResponse>

    UpdateComputeClusterResponse

updateComputeImageCapabilitySchema

updateConsoleHistory

updateDedicatedVmHost

  • Updates the displayName, freeformTags, and definedTags attributes for the specified dedicated virtual machine host. If an attribute value is not included, it will not be updated.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateDedicatedVmHost API.

    Parameters

    Returns Promise<UpdateDedicatedVmHostResponse>

    UpdateDedicatedVmHostResponse

updateImage

  • Updates the display name of the image. Avoid entering confidential information.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateImage API.

    Parameters

    Returns Promise<UpdateImageResponse>

    UpdateImageResponse

updateInstance

  • Updates certain fields on the specified instance. Fields that are not provided in the request will not be updated. Avoid entering confidential information.

    Changes to metadata fields will be reflected in the instance metadata service (this may take up to a minute).

    The OCID of the instance remains the same.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateInstance API.

    Parameters

    Returns Promise<UpdateInstanceResponse>

    UpdateInstanceResponse

updateInstanceConsoleConnection

updateVolumeAttachment