Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ComputeManagementClient

Hierarchy

  • ComputeManagementClient

Constructors

Properties

Accessors

Methods

Constructors

constructor

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

Properties

Protected _circuitBreaker

_circuitBreaker: null = null

Protected _clientConfiguration

_clientConfiguration: ClientConfiguration

Protected _defaultHeaders

_defaultHeaders: any

Protected _endpoint

_endpoint: string = ""

Protected _httpClient

_httpClient: HttpClient

Protected _waiters

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}.

    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

Methods

attachInstancePoolInstance

attachLoadBalancer

changeClusterNetworkCompartment

changeInstanceConfigurationCompartment

  • Moves an instance configuration into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

    When you move an instance configuration to a different compartment, associated resources such as instance pools are not moved.

    *Important:** Most of the properties for an existing instance configuration, including the compartment, cannot be modified after you create the instance configuration. Although you can move an instance configuration to a different compartment, you will not be able to use the instance configuration to manage instance pools in the new compartment. If you want to update an instance configuration to point to a different compartment, you should instead create a new instance configuration in the target compartment using [CreateInstanceConfiguration](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/20160918/InstanceConfiguration/CreateInstanceConfiguration).

    throws

    OciError when an error occurs

    example

    Click here to see how to use ChangeInstanceConfigurationCompartment API.

    Parameters

    Returns Promise<ChangeInstanceConfigurationCompartmentResponse>

    ChangeInstanceConfigurationCompartmentResponse

changeInstancePoolCompartment

createClusterNetwork

createInstanceConfiguration

createInstancePool

createWaiters

  • Creates a new ComputeManagementWaiter 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 ComputeManagementWaiter

    The service waiters.

deleteInstanceConfiguration

detachInstancePoolInstance

detachLoadBalancer

getClusterNetwork

getInstanceConfiguration

getInstancePool

getInstancePoolInstance

getInstancePoolLoadBalancerAttachment

getWaiters

launchInstanceConfiguration

  • Launches an instance from an instance configuration.

    If the instance configuration does not include all of the parameters that are required to launch an instance, such as the availability domain and subnet ID, you must provide these parameters when you launch an instance from the instance configuration. For more information, see the InstanceConfiguration resource.

    throws

    OciError when an error occurs

    example

    Click here to see how to use LaunchInstanceConfiguration API.

    Parameters

    Returns Promise<LaunchInstanceConfigurationResponse>

    LaunchInstanceConfigurationResponse

listAllClusterNetworkInstances

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

    Parameters

    Returns AsyncIterableIterator<InstanceSummary>

listAllClusterNetworkInstancesResponses

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

    Parameters

    Returns AsyncIterableIterator<ListClusterNetworkInstancesResponse>

listAllClusterNetworks

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

    Parameters

    Returns AsyncIterableIterator<ClusterNetworkSummary>

listAllClusterNetworksResponses

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

    Parameters

    Returns AsyncIterableIterator<ListClusterNetworksResponse>

listAllInstanceConfigurations

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

    Parameters

    Returns AsyncIterableIterator<InstanceConfigurationSummary>

listAllInstanceConfigurationsResponses

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

    Parameters

    Returns AsyncIterableIterator<ListInstanceConfigurationsResponse>

listAllInstancePoolInstances

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

    Parameters

    Returns AsyncIterableIterator<InstanceSummary>

listAllInstancePoolInstancesResponses

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

    Parameters

    Returns AsyncIterableIterator<ListInstancePoolInstancesResponse>

listAllInstancePools

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

    Parameters

    Returns AsyncIterableIterator<InstancePoolSummary>

listAllInstancePoolsResponses

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

    Parameters

    Returns AsyncIterableIterator<ListInstancePoolsResponse>

listClusterNetworkInstances

listClusterNetworkInstancesRecordIterator

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

    Parameters

    Returns AsyncIterableIterator<InstanceSummary>

listClusterNetworkInstancesResponseIterator

listClusterNetworks

listClusterNetworksRecordIterator

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

    Parameters

    Returns AsyncIterableIterator<ClusterNetworkSummary>

listClusterNetworksResponseIterator

listInstanceConfigurations

listInstanceConfigurationsRecordIterator

listInstanceConfigurationsResponseIterator

listInstancePoolInstances

listInstancePoolInstancesRecordIterator

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

    Parameters

    Returns AsyncIterableIterator<InstanceSummary>

listInstancePoolInstancesResponseIterator

listInstancePools

listInstancePoolsRecordIterator

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

    Parameters

    Returns AsyncIterableIterator<InstancePoolSummary>

listInstancePoolsResponseIterator

resetInstancePool

  • Performs the reset (immediate power off and power on) action on the specified instance pool, which performs the action on all the instances in the pool.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ResetInstancePool API.

    Parameters

    Returns Promise<ResetInstancePoolResponse>

    ResetInstancePoolResponse

softresetInstancePool

  • Performs the softreset (ACPI shutdown and power on) action on the specified instance pool, which performs the action on all the instances in the pool.

    Softreset gracefully reboots the instances by sending a shutdown command to the operating systems. After waiting 15 minutes for the OS to shut down, the instances are powered off and then powered back on.

    throws

    OciError when an error occurs

    example

    Click here to see how to use SoftresetInstancePool API.

    Parameters

    Returns Promise<SoftresetInstancePoolResponse>

    SoftresetInstancePoolResponse

startInstancePool

stopInstancePool

terminateClusterNetwork

terminateInstancePool

  • Terminate the specified instance pool.

    *Warning:** When you delete an instance pool, the resources that were created by the pool are permanently deleted, including associated instances, attached boot volumes, and block volumes.

    If an autoscaling configuration applies to the instance pool, the autoscaling configuration will be deleted asynchronously after the pool is deleted. You can also manually delete the autoscaling configuration using the `DeleteAutoScalingConfiguration` operation in the Autoscaling API.

    throws

    OciError when an error occurs

    example

    Click here to see how to use TerminateInstancePool API.

    Parameters

    Returns Promise<TerminateInstancePoolResponse>

    TerminateInstancePoolResponse

updateClusterNetwork

updateInstanceConfiguration

updateInstancePool