Options
All
  • Public
  • Public/Protected
  • All
Menu

Class BlockstorageClient

This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user.

Hierarchy

  • BlockstorageClient

Constructors

Properties

Accessors

Methods

Constructors

constructor

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

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

targetService

targetService: string = "Blockstorage"

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

changeBootVolumeBackupCompartment

changeBootVolumeCompartment

changeVolumeBackupCompartment

changeVolumeCompartment

changeVolumeGroupBackupCompartment

changeVolumeGroupCompartment

close

  • close(): void

copyBootVolumeBackup

copyVolumeBackup

copyVolumeGroupBackup

createBootVolume

  • Creates a new boot volume in the specified compartment from an existing boot volume or a boot volume backup. For general information about boot volumes, see Boot Volumes. You may optionally specify a display name for the volume, which is simply a friendly name or description. It does not have to be unique, and you can change it. 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 CreateBootVolume API.

    Parameters

    Returns Promise<CreateBootVolumeResponse>

    CreateBootVolumeResponse

createBootVolumeBackup

  • Creates a new boot volume backup of the specified boot volume. For general information about boot volume backups, see Overview of Boot Volume Backups

    When the request is received, the backup object is in a REQUEST_RECEIVED state. When the data is imaged, it goes into a CREATING state. After the backup is fully uploaded to the cloud, it goes into an AVAILABLE state.

    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 CreateBootVolumeBackup API.

    Parameters

    Returns Promise<CreateBootVolumeBackupResponse>

    CreateBootVolumeBackupResponse

createVolume

  • Creates a new volume in the specified compartment. Volumes can be created in sizes ranging from 50 GB (51200 MB) to 32 TB (33554432 MB), in 1 GB (1024 MB) increments. By default, volumes are 1 TB (1048576 MB). For general information about block volumes, see Overview of Block Volume Service.

    A volume and instance can be in separate compartments but must be in the same availability domain. 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.

    You may optionally specify a *display name* for the volume, which is simply a friendly name or description. It does not have to be unique, and you can change it. 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 CreateVolume API.

    Parameters

    Returns Promise<CreateVolumeResponse>

    CreateVolumeResponse

createVolumeBackup

  • Creates a new backup of the specified volume. For general information about volume backups, see Overview of Block Volume Service Backups

    When the request is received, the backup object is in a REQUEST_RECEIVED state. When the data is imaged, it goes into a CREATING state. After the backup is fully uploaded to the cloud, it goes into an AVAILABLE state.

    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 CreateVolumeBackup API.

    Parameters

    Returns Promise<CreateVolumeBackupResponse>

    CreateVolumeBackupResponse

createVolumeBackupPolicy

  • Creates a new user defined backup policy.

    For more information about Oracle defined backup policies and user defined backup policies, see [Policy-Based Backups](https://docs.cloud.oracle.com/iaas/Content/Block/Tasks/schedulingvolumebackups.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 CreateVolumeBackupPolicy API.

    Parameters

    Returns Promise<CreateVolumeBackupPolicyResponse>

    CreateVolumeBackupPolicyResponse

createVolumeBackupPolicyAssignment

  • Assigns a volume backup policy to the specified volume. Note that a given volume can only have one backup policy assigned to it. If this operation is used for a volume that already has a different backup policy assigned, the prior backup policy will be silently unassigned.

    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 CreateVolumeBackupPolicyAssignment API.

    Parameters

    Returns Promise<CreateVolumeBackupPolicyAssignmentResponse>

    CreateVolumeBackupPolicyAssignmentResponse

createVolumeGroup

  • Creates a new volume group in the specified compartment. A volume group is a collection of volumes and may be created from a list of volumes, cloning an existing volume group, or by restoring a volume group backup. You may optionally specify a display name for the volume group, which is simply a friendly name or description. It does not have to be unique, and you can change it. Avoid entering confidential information.

    For more information, see [Volume Groups](https://docs.cloud.oracle.com/iaas/Content/Block/Concepts/volumegroups.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 CreateVolumeGroup API.

    Parameters

    Returns Promise<CreateVolumeGroupResponse>

    CreateVolumeGroupResponse

createVolumeGroupBackup

createWaiters

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

    The service waiters.

deleteBootVolume

  • Deletes the specified boot volume. The volume cannot have an active connection to an instance. To disconnect the boot volume from a connected instance, see Disconnecting From a Boot Volume. Warning: All data on the boot volume will be permanently lost when the boot volume is deleted.

    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 DeleteBootVolume API.

    Parameters

    Returns Promise<DeleteBootVolumeResponse>

    DeleteBootVolumeResponse

deleteBootVolumeBackup

deleteBootVolumeKmsKey

  • Removes the specified boot volume's assigned Vault Service encryption key.

    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 DeleteBootVolumeKmsKey API.

    Parameters

    Returns Promise<DeleteBootVolumeKmsKeyResponse>

    DeleteBootVolumeKmsKeyResponse

deleteVolume

  • Deletes the specified volume. The volume cannot have an active connection to an instance. To disconnect the volume from a connected instance, see Disconnecting From a Volume. Warning: All data on the volume will be permanently lost when the volume is deleted.

    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 DeleteVolume API.

    Parameters

    Returns Promise<DeleteVolumeResponse>

    DeleteVolumeResponse

deleteVolumeBackup

deleteVolumeBackupPolicy

deleteVolumeBackupPolicyAssignment

deleteVolumeGroup

  • Deletes the specified volume group. Individual volumes are not deleted, only the volume group is deleted. For more information, see Volume Groups.

    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 DeleteVolumeGroup API.

    Parameters

    Returns Promise<DeleteVolumeGroupResponse>

    DeleteVolumeGroupResponse

deleteVolumeGroupBackup

deleteVolumeKmsKey

  • Removes the specified volume's assigned Vault service encryption key.

    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 DeleteVolumeKmsKey API.

    Parameters

    Returns Promise<DeleteVolumeKmsKeyResponse>

    DeleteVolumeKmsKeyResponse

getAllVolumeBackupPolicyAssetAssignment

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

    Parameters

    Returns AsyncIterableIterator<VolumeBackupPolicyAssignment>

getAllVolumeBackupPolicyAssetAssignmentResponses

getBlockVolumeReplica

getBootVolume

  • Gets information for the specified boot volume. 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 GetBootVolume API.

    Parameters

    Returns Promise<GetBootVolumeResponse>

    GetBootVolumeResponse

getBootVolumeBackup

getBootVolumeKmsKey

  • Gets the Vault service encryption key assigned to the specified boot volume.

    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 GetBootVolumeKmsKey API.

    Parameters

    Returns Promise<GetBootVolumeKmsKeyResponse>

    GetBootVolumeKmsKeyResponse

getBootVolumeReplica

getVolume

  • Gets information for the specified volume. 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 GetVolume API.

    Parameters

    Returns Promise<GetVolumeResponse>

    GetVolumeResponse

getVolumeBackup

  • Gets information for the specified volume backup. 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 GetVolumeBackup API.

    Parameters

    Returns Promise<GetVolumeBackupResponse>

    GetVolumeBackupResponse

getVolumeBackupPolicy

getVolumeBackupPolicyAssetAssignment

  • Gets the volume backup policy assignment for the specified volume. The assetId query parameter is required, and the returned list will contain at most one item, since volume can only have one volume backup policy assigned at a time.

    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 GetVolumeBackupPolicyAssetAssignment API.

    Parameters

    Returns Promise<GetVolumeBackupPolicyAssetAssignmentResponse>

    GetVolumeBackupPolicyAssetAssignmentResponse

getVolumeBackupPolicyAssetAssignmentRecordIterator

getVolumeBackupPolicyAssetAssignmentResponseIterator

getVolumeBackupPolicyAssignment

getVolumeGroup

getVolumeGroupBackup

getVolumeGroupReplica

getVolumeKmsKey

  • Gets the Vault service encryption key assigned to the specified volume.

    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 GetVolumeKmsKey API.

    Parameters

    Returns Promise<GetVolumeKmsKeyResponse>

    GetVolumeKmsKeyResponse

getWaiters

listAllBlockVolumeReplicas

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

    Parameters

    Returns AsyncIterableIterator<BlockVolumeReplica>

listAllBlockVolumeReplicasResponses

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

    Parameters

    Returns AsyncIterableIterator<ListBlockVolumeReplicasResponse>

listAllBootVolumeBackups

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

    Parameters

    Returns AsyncIterableIterator<BootVolumeBackup>

listAllBootVolumeBackupsResponses

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

    Parameters

    Returns AsyncIterableIterator<ListBootVolumeBackupsResponse>

listAllBootVolumeReplicas

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

    Parameters

    Returns AsyncIterableIterator<BootVolumeReplica>

listAllBootVolumeReplicasResponses

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

    Parameters

    Returns AsyncIterableIterator<ListBootVolumeReplicasResponse>

listAllBootVolumes

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

    Parameters

    Returns AsyncIterableIterator<BootVolume>

listAllBootVolumesResponses

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

    Parameters

    Returns AsyncIterableIterator<ListBootVolumesResponse>

listAllVolumeBackupPolicies

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

    Parameters

    Returns AsyncIterableIterator<VolumeBackupPolicy>

listAllVolumeBackupPoliciesResponses

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

    Parameters

    Returns AsyncIterableIterator<ListVolumeBackupPoliciesResponse>

listAllVolumeBackups

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

    Parameters

    Returns AsyncIterableIterator<VolumeBackup>

listAllVolumeBackupsResponses

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

    Parameters

    Returns AsyncIterableIterator<ListVolumeBackupsResponse>

listAllVolumeGroupBackups

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

    Parameters

    Returns AsyncIterableIterator<VolumeGroupBackup>

listAllVolumeGroupBackupsResponses

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

    Parameters

    Returns AsyncIterableIterator<ListVolumeGroupBackupsResponse>

listAllVolumeGroupReplicas

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

    Parameters

    Returns AsyncIterableIterator<VolumeGroupReplica>

listAllVolumeGroupReplicasResponses

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

    Parameters

    Returns AsyncIterableIterator<ListVolumeGroupReplicasResponse>

listAllVolumeGroups

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

    Parameters

    Returns AsyncIterableIterator<VolumeGroup>

listAllVolumeGroupsResponses

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

    Parameters

    Returns AsyncIterableIterator<ListVolumeGroupsResponse>

listAllVolumes

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

    Parameters

    Returns AsyncIterableIterator<Volume>

listAllVolumesResponses

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

    Parameters

    Returns AsyncIterableIterator<ListVolumesResponse>

listBlockVolumeReplicas

  • Lists the block volume replicas in the specified compartment and 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 ListBlockVolumeReplicas API.

    Parameters

    Returns Promise<ListBlockVolumeReplicasResponse>

    ListBlockVolumeReplicasResponse

listBlockVolumeReplicasRecordIterator

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

    Parameters

    Returns AsyncIterableIterator<BlockVolumeReplica>

listBlockVolumeReplicasResponseIterator

listBootVolumeBackups

  • Lists the boot volume backups in the specified compartment. You can filter the results by boot volume.

    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 ListBootVolumeBackups API.

    Parameters

    Returns Promise<ListBootVolumeBackupsResponse>

    ListBootVolumeBackupsResponse

listBootVolumeBackupsRecordIterator

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

    Parameters

    Returns AsyncIterableIterator<BootVolumeBackup>

listBootVolumeBackupsResponseIterator

listBootVolumeReplicas

  • Lists the boot volume replicas in the specified compartment and 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 ListBootVolumeReplicas API.

    Parameters

    Returns Promise<ListBootVolumeReplicasResponse>

    ListBootVolumeReplicasResponse

listBootVolumeReplicasRecordIterator

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

    Parameters

    Returns AsyncIterableIterator<BootVolumeReplica>

listBootVolumeReplicasResponseIterator

listBootVolumes

  • Lists the boot volumes in the specified compartment and 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 ListBootVolumes API.

    Parameters

    Returns Promise<ListBootVolumesResponse>

    ListBootVolumesResponse

listBootVolumesRecordIterator

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

    Parameters

    Returns AsyncIterableIterator<BootVolume>

listBootVolumesResponseIterator

listVolumeBackupPolicies

  • Lists all the volume backup policies available in the specified compartment.

    For more information about Oracle defined backup policies and user defined backup policies, see [Policy-Based Backups](https://docs.cloud.oracle.com/iaas/Content/Block/Tasks/schedulingvolumebackups.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 ListVolumeBackupPolicies API.

    Parameters

    Returns Promise<ListVolumeBackupPoliciesResponse>

    ListVolumeBackupPoliciesResponse

listVolumeBackupPoliciesRecordIterator

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

    Parameters

    Returns AsyncIterableIterator<VolumeBackupPolicy>

listVolumeBackupPoliciesResponseIterator

listVolumeBackups

  • Lists the volume backups in the specified compartment. You can filter the results by volume.

    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 ListVolumeBackups API.

    Parameters

    Returns Promise<ListVolumeBackupsResponse>

    ListVolumeBackupsResponse

listVolumeBackupsRecordIterator

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

    Parameters

    Returns AsyncIterableIterator<VolumeBackup>

listVolumeBackupsResponseIterator

listVolumeGroupBackups

  • Lists the volume group backups in the specified compartment. You can filter the results by volume group. For more information, see Volume Groups.

    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 ListVolumeGroupBackups API.

    Parameters

    Returns Promise<ListVolumeGroupBackupsResponse>

    ListVolumeGroupBackupsResponse

listVolumeGroupBackupsRecordIterator

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

    Parameters

    Returns AsyncIterableIterator<VolumeGroupBackup>

listVolumeGroupBackupsResponseIterator

listVolumeGroupReplicas

listVolumeGroupReplicasRecordIterator

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

    Parameters

    Returns AsyncIterableIterator<VolumeGroupReplica>

listVolumeGroupReplicasResponseIterator

listVolumeGroups

  • Lists the volume groups in the specified compartment and availability domain. For more information, see Volume Groups.

    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 ListVolumeGroups API.

    Parameters

    Returns Promise<ListVolumeGroupsResponse>

    ListVolumeGroupsResponse

listVolumeGroupsRecordIterator

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

    Parameters

    Returns AsyncIterableIterator<VolumeGroup>

listVolumeGroupsResponseIterator

listVolumes

  • Lists the volumes in the specified compartment and 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 ListVolumes API.

    Parameters

    Returns Promise<ListVolumesResponse>

    ListVolumesResponse

listVolumesRecordIterator

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

    Parameters

    Returns AsyncIterableIterator<Volume>

listVolumesResponseIterator

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

    Parameters

    Returns AsyncIterableIterator<ListVolumesResponse>

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

updateBootVolume

  • Updates the specified boot volume's display name, defined tags, and free-form tags. 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 UpdateBootVolume API.

    Parameters

    Returns Promise<UpdateBootVolumeResponse>

    UpdateBootVolumeResponse

updateBootVolumeBackup

  • Updates the display name for the specified boot volume backup. 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 UpdateBootVolumeBackup API.

    Parameters

    Returns Promise<UpdateBootVolumeBackupResponse>

    UpdateBootVolumeBackupResponse

updateBootVolumeKmsKey

  • Updates the specified volume with a new Vault service master encryption key.

    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 UpdateBootVolumeKmsKey API.

    Parameters

    Returns Promise<UpdateBootVolumeKmsKeyResponse>

    UpdateBootVolumeKmsKeyResponse

updateVolume

  • Updates the specified volume's display name. 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 UpdateVolume API.

    Parameters

    Returns Promise<UpdateVolumeResponse>

    UpdateVolumeResponse

updateVolumeBackup

  • Updates the display name for the specified volume backup. 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 UpdateVolumeBackup API.

    Parameters

    Returns Promise<UpdateVolumeBackupResponse>

    UpdateVolumeBackupResponse

updateVolumeBackupPolicy

updateVolumeGroup

  • Updates the set of volumes in a volume group along with the display name. Use this operation to add or remove volumes in a volume group. Specify the full list of volume IDs to include in the volume group. If the volume ID is not specified in the call, it will be removed from the volume group. Avoid entering confidential information.

    For more information, see [Volume Groups](https://docs.cloud.oracle.com/iaas/Content/Block/Concepts/volumegroups.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 UpdateVolumeGroup API.

    Parameters

    Returns Promise<UpdateVolumeGroupResponse>

    UpdateVolumeGroupResponse

updateVolumeGroupBackup

updateVolumeKmsKey

  • Updates the specified volume with a new Key Management master encryption key.

    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 UpdateVolumeKmsKey API.

    Parameters

    Returns Promise<UpdateVolumeKmsKeyResponse>

    UpdateVolumeKmsKeyResponse