Core Blockstorage Functions

CHANGE_BOOT_VOLUME_BACKUP_COMPARTMENT Function

Moves a boot volume backup into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Syntax

FUNCTION change_boot_volume_backup_compartment (
  boot_volume_backup_id varchar2,
  change_boot_volume_backup_compartment_details dbms_cloud_oci_core_change_boot_volume_backup_compartment_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_blockstorage_change_boot_volume_backup_compartment_response_t;

Parameters

Parameter	Description
`boot_volume_backup_id`	(required) The OCID of the boot volume backup.
`change_boot_volume_backup_compartment_details`	(required) Request to change the compartment of given boot volume backup.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_BOOT_VOLUME_COMPARTMENT Function

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

Syntax

FUNCTION change_boot_volume_compartment (
  boot_volume_id varchar2,
  change_boot_volume_compartment_details dbms_cloud_oci_core_change_boot_volume_compartment_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_blockstorage_change_boot_volume_compartment_response_t;

Parameters

Parameter	Description
`boot_volume_id`	(required) The OCID of the boot volume.
`change_boot_volume_compartment_details`	(required) Request to change the compartment of given boot volume.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_VOLUME_BACKUP_COMPARTMENT Function

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

Syntax

FUNCTION change_volume_backup_compartment (
  volume_backup_id varchar2,
  change_volume_backup_compartment_details dbms_cloud_oci_core_change_volume_backup_compartment_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_blockstorage_change_volume_backup_compartment_response_t;

Parameters

Parameter	Description
`volume_backup_id`	(required) The OCID of the volume backup.
`change_volume_backup_compartment_details`	(required) Request to change the compartment of given volume backup.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_VOLUME_COMPARTMENT Function

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

Syntax

FUNCTION change_volume_compartment (
  volume_id varchar2,
  change_volume_compartment_details dbms_cloud_oci_core_change_volume_compartment_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_blockstorage_change_volume_compartment_response_t;

Parameters

Parameter	Description
`volume_id`	(required) The OCID of the volume.
`change_volume_compartment_details`	(required) Request to change the compartment of given volume.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_VOLUME_GROUP_BACKUP_COMPARTMENT Function

Moves a volume group backup into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Syntax

FUNCTION change_volume_group_backup_compartment (
  volume_group_backup_id varchar2,
  change_volume_group_backup_compartment_details dbms_cloud_oci_core_change_volume_group_backup_compartment_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_blockstorage_change_volume_group_backup_compartment_response_t;

Parameters

Parameter	Description
`volume_group_backup_id`	(required) The Oracle Cloud ID (OCID) that uniquely identifies the volume group backup.
`change_volume_group_backup_compartment_details`	(required) Request to change the compartment of given volume group backup.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_VOLUME_GROUP_COMPARTMENT Function

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

Syntax

FUNCTION change_volume_group_compartment (
  volume_group_id varchar2,
  change_volume_group_compartment_details dbms_cloud_oci_core_change_volume_group_compartment_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_blockstorage_change_volume_group_compartment_response_t;

Parameters

Parameter	Description
`volume_group_id`	(required) The Oracle Cloud ID (OCID) that uniquely identifies the volume group.
`change_volume_group_compartment_details`	(required) Request to change the compartment of given volume group.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

COPY_BOOT_VOLUME_BACKUP Function

Creates a boot volume backup copy in specified region. For general information about volume backups, see Overview of Boot Volume Backups

Syntax

FUNCTION copy_boot_volume_backup (
  boot_volume_backup_id varchar2,
  copy_boot_volume_backup_details dbms_cloud_oci_core_copy_boot_volume_backup_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_blockstorage_copy_boot_volume_backup_response_t;

Parameters

Parameter	Description
`boot_volume_backup_id`	(required) The OCID of the boot volume backup.
`copy_boot_volume_backup_details`	(required) Request to create a cross-region copy of given boot volume backup.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

COPY_VOLUME_BACKUP Function

Creates a volume backup copy in specified region. For general information about volume backups, see Overview of Block Volume Service Backups

Syntax

FUNCTION copy_volume_backup (
  volume_backup_id varchar2,
  copy_volume_backup_details dbms_cloud_oci_core_copy_volume_backup_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_blockstorage_copy_volume_backup_response_t;

Parameters

Parameter	Description
`volume_backup_id`	(required) The OCID of the volume backup.
`copy_volume_backup_details`	(required) Request to create a cross-region copy of given backup.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

COPY_VOLUME_GROUP_BACKUP Function

Creates a volume group backup copy in specified region. For general information about volume group backups, see Overview of Block Volume Backups.

Syntax

FUNCTION copy_volume_group_backup (
  volume_group_backup_id varchar2,
  copy_volume_group_backup_details dbms_cloud_oci_core_copy_volume_group_backup_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_blockstorage_copy_volume_group_backup_response_t;

Parameters

Parameter	Description
`volume_group_backup_id`	(required) The Oracle Cloud ID (OCID) that uniquely identifies the volume group backup.
`copy_volume_group_backup_details`	(required) Request to create a cross-region copy of given volume group backup.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_BOOT_VOLUME Function

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.

Syntax

FUNCTION create_boot_volume (
  create_boot_volume_details dbms_cloud_oci_core_create_boot_volume_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_blockstorage_create_boot_volume_response_t;

Parameters

Parameter	Description
`create_boot_volume_details`	(required) Request to create a new boot volume.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_BOOT_VOLUME_BACKUP Function

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.

Syntax

FUNCTION create_boot_volume_backup (
  create_boot_volume_backup_details dbms_cloud_oci_core_create_boot_volume_backup_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_blockstorage_create_boot_volume_backup_response_t;

Parameters

Parameter	Description
`create_boot_volume_backup_details`	(required) Request to create a new backup of given boot volume.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_VOLUME Function

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. For information about availability domains, see Regions and Availability Domains. 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.

Syntax

FUNCTION create_volume (
  create_volume_details dbms_cloud_oci_core_create_volume_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_blockstorage_create_volume_response_t;

Parameters

Parameter	Description
`create_volume_details`	(required) Request to create a new volume.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_VOLUME_BACKUP Function

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.

Syntax

FUNCTION create_volume_backup (
  create_volume_backup_details dbms_cloud_oci_core_create_volume_backup_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_blockstorage_create_volume_backup_response_t;

Parameters

Parameter	Description
`create_volume_backup_details`	(required) Request to create a new backup of given volume.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_VOLUME_BACKUP_POLICY Function

Creates a new user defined backup policy. For more information about Oracle defined backup policies and user defined backup policies, see Policy-Based Backups.

Syntax

FUNCTION create_volume_backup_policy (
  create_volume_backup_policy_details dbms_cloud_oci_core_create_volume_backup_policy_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_blockstorage_create_volume_backup_policy_response_t;

Parameters

Parameter	Description
`create_volume_backup_policy_details`	(required) Request to create a new scheduled backup policy.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_VOLUME_BACKUP_POLICY_ASSIGNMENT Function

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.

Syntax

FUNCTION create_volume_backup_policy_assignment (
  create_volume_backup_policy_assignment_details dbms_cloud_oci_core_create_volume_backup_policy_assignment_details_t,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_blockstorage_create_volume_backup_policy_assignment_response_t;

Parameters

Parameter	Description
`create_volume_backup_policy_assignment_details`	(required) Request to assign a specified policy to a particular volume.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_VOLUME_GROUP Function

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.

Syntax

FUNCTION create_volume_group (
  create_volume_group_details dbms_cloud_oci_core_create_volume_group_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_blockstorage_create_volume_group_response_t;

Parameters

Parameter	Description
`create_volume_group_details`	(required) Request to create a new volume group.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_VOLUME_GROUP_BACKUP Function

Creates a new backup volume group of the specified volume group. For more information, see Volume Groups.

Syntax

FUNCTION create_volume_group_backup (
  create_volume_group_backup_details dbms_cloud_oci_core_create_volume_group_backup_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_blockstorage_create_volume_group_backup_response_t;

Parameters

Parameter	Description
`create_volume_group_backup_details`	(required) Request to create a new backup group of given volume group.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_BOOT_VOLUME Function

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.

Syntax

FUNCTION delete_boot_volume (
  boot_volume_id varchar2,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_blockstorage_delete_boot_volume_response_t;

Parameters

Parameter	Description
`boot_volume_id`	(required) The OCID of the boot volume.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_BOOT_VOLUME_BACKUP Function

Deletes a boot volume backup.

Syntax

FUNCTION delete_boot_volume_backup (
  boot_volume_backup_id varchar2,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_blockstorage_delete_boot_volume_backup_response_t;

Parameters

Parameter	Description
`boot_volume_backup_id`	(required) The OCID of the boot volume backup.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_BOOT_VOLUME_KMS_KEY Function

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

Syntax

FUNCTION delete_boot_volume_kms_key (
  boot_volume_id varchar2,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_blockstorage_delete_boot_volume_kms_key_response_t;

Parameters

Parameter	Description
`boot_volume_id`	(required) The OCID of the boot volume.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_VOLUME Function

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.

Syntax

FUNCTION delete_volume (
  volume_id varchar2,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_blockstorage_delete_volume_response_t;

Parameters

Parameter	Description
`volume_id`	(required) The OCID of the volume.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_VOLUME_BACKUP Function

Deletes a volume backup.

Syntax

FUNCTION delete_volume_backup (
  volume_backup_id varchar2,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_blockstorage_delete_volume_backup_response_t;

Parameters

Parameter	Description
`volume_backup_id`	(required) The OCID of the volume backup.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_VOLUME_BACKUP_POLICY Function

Deletes a user defined backup policy. For more information about user defined backup policies, see Policy-Based Backups. Avoid entering confidential information.

Syntax

FUNCTION delete_volume_backup_policy (
  policy_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_blockstorage_delete_volume_backup_policy_response_t;

Parameters

Parameter	Description
`policy_id`	(required) The OCID of the volume backup policy.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_VOLUME_BACKUP_POLICY_ASSIGNMENT Function

Deletes a volume backup policy assignment.

Syntax

FUNCTION delete_volume_backup_policy_assignment (
  policy_assignment_id varchar2,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_blockstorage_delete_volume_backup_policy_assignment_response_t;

Parameters

Parameter	Description
`policy_assignment_id`	(required) The OCID of the volume backup policy assignment.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_VOLUME_GROUP Function

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

Syntax

FUNCTION delete_volume_group (
  volume_group_id varchar2,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_blockstorage_delete_volume_group_response_t;

Parameters

Parameter	Description
`volume_group_id`	(required) The Oracle Cloud ID (OCID) that uniquely identifies the volume group.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_VOLUME_GROUP_BACKUP Function

Deletes a volume group backup. This operation deletes all the backups in the volume group. For more information, see Volume Groups.

Syntax

FUNCTION delete_volume_group_backup (
  volume_group_backup_id varchar2,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_blockstorage_delete_volume_group_backup_response_t;

Parameters

Parameter	Description
`volume_group_backup_id`	(required) The Oracle Cloud ID (OCID) that uniquely identifies the volume group backup.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_VOLUME_KMS_KEY Function

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

Syntax

FUNCTION delete_volume_kms_key (
  volume_id varchar2,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_blockstorage_delete_volume_kms_key_response_t;

Parameters

Parameter	Description
`volume_id`	(required) The OCID of the volume.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_BLOCK_VOLUME_REPLICA Function

Gets information for the specified block volume replica.

Syntax

FUNCTION get_block_volume_replica (
  block_volume_replica_id varchar2,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_blockstorage_get_block_volume_replica_response_t;

Parameters

Parameter	Description
`block_volume_replica_id`	(required) The OCID of the block volume replica.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_BOOT_VOLUME Function

Gets information for the specified boot volume.

Syntax

FUNCTION get_boot_volume (
  boot_volume_id varchar2,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_blockstorage_get_boot_volume_response_t;

Parameters

Parameter	Description
`boot_volume_id`	(required) The OCID of the boot volume.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_BOOT_VOLUME_BACKUP Function

Gets information for the specified boot volume backup.

Syntax

FUNCTION get_boot_volume_backup (
  boot_volume_backup_id varchar2,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_blockstorage_get_boot_volume_backup_response_t;

Parameters

Parameter	Description
`boot_volume_backup_id`	(required) The OCID of the boot volume backup.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_BOOT_VOLUME_KMS_KEY Function

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

Syntax

FUNCTION get_boot_volume_kms_key (
  boot_volume_id varchar2,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_blockstorage_get_boot_volume_kms_key_response_t;

Parameters

Parameter	Description
`boot_volume_id`	(required) The OCID of the boot volume.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_BOOT_VOLUME_REPLICA Function

Gets information for the specified boot volume replica.

Syntax

FUNCTION get_boot_volume_replica (
  boot_volume_replica_id varchar2,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_blockstorage_get_boot_volume_replica_response_t;

Parameters

Parameter	Description
`boot_volume_replica_id`	(required) The OCID of the boot volume replica.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_VOLUME Function

Gets information for the specified volume.

Syntax

FUNCTION get_volume (
  volume_id varchar2,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_blockstorage_get_volume_response_t;

Parameters

Parameter	Description
`volume_id`	(required) The OCID of the volume.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_VOLUME_BACKUP Function

Gets information for the specified volume backup.

Syntax

FUNCTION get_volume_backup (
  volume_backup_id varchar2,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_blockstorage_get_volume_backup_response_t;

Parameters

Parameter	Description
`volume_backup_id`	(required) The OCID of the volume backup.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_VOLUME_BACKUP_POLICY Function

Gets information for the specified volume backup policy.

Syntax

FUNCTION get_volume_backup_policy (
  policy_id varchar2,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_blockstorage_get_volume_backup_policy_response_t;

Parameters

Parameter	Description
`policy_id`	(required) The OCID of the volume backup policy.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_VOLUME_BACKUP_POLICY_ASSET_ASSIGNMENT Function

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.

Syntax

FUNCTION get_volume_backup_policy_asset_assignment (
  asset_id varchar2,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_blockstorage_get_volume_backup_policy_asset_assignment_response_t;

Parameters

Parameter	Description
`asset_id`	(required) The OCID of an asset (e.g. a volume).
`limit`	(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. For important details about how pagination works, see List Pagination. Example: `50`
`page`	(optional) For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. For important details about how pagination works, see List Pagination.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_VOLUME_BACKUP_POLICY_ASSIGNMENT Function

Gets information for the specified volume backup policy assignment.

Syntax

FUNCTION get_volume_backup_policy_assignment (
  policy_assignment_id varchar2,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_blockstorage_get_volume_backup_policy_assignment_response_t;

Parameters

Parameter	Description
`policy_assignment_id`	(required) The OCID of the volume backup policy assignment.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_VOLUME_GROUP Function

Gets information for the specified volume group. For more information, see Volume Groups.

Syntax

FUNCTION get_volume_group (
  volume_group_id varchar2,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_blockstorage_get_volume_group_response_t;

Parameters

Parameter	Description
`volume_group_id`	(required) The Oracle Cloud ID (OCID) that uniquely identifies the volume group.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_VOLUME_GROUP_BACKUP Function

Gets information for the specified volume group backup. For more information, see Volume Groups.

Syntax

FUNCTION get_volume_group_backup (
  volume_group_backup_id varchar2,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_blockstorage_get_volume_group_backup_response_t;

Parameters

Parameter	Description
`volume_group_backup_id`	(required) The Oracle Cloud ID (OCID) that uniquely identifies the volume group backup.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_VOLUME_GROUP_REPLICA Function

Gets information for the specified volume group replica.

Syntax

FUNCTION get_volume_group_replica (
  volume_group_replica_id varchar2,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_blockstorage_get_volume_group_replica_response_t;

Parameters

Parameter	Description
`volume_group_replica_id`	(required) The OCID of the volume replica group.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_VOLUME_KMS_KEY Function

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

Syntax

FUNCTION get_volume_kms_key (
  volume_id varchar2,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_blockstorage_get_volume_kms_key_response_t;

Parameters

Parameter	Description
`volume_id`	(required) The OCID of the volume.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_BLOCK_VOLUME_REPLICAS Function

Lists the block volume replicas in the specified compartment and availability domain.

Syntax

FUNCTION list_block_volume_replicas (
  availability_domain varchar2 DEFAULT NULL,
  compartment_id varchar2 DEFAULT NULL,
  volume_group_replica_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_blockstorage_list_block_volume_replicas_response_t;

Parameters

Parameter	Description
`availability_domain`	(optional) The name of the availability domain. Example: `Uocm:PHX-AD-1`
`compartment_id`	(optional) The OCID of the compartment.
`volume_group_replica_id`	(optional) The OCID of the volume group replica.
`limit`	(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. For important details about how pagination works, see List Pagination. Example: `50`
`page`	(optional) For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. For important details about how pagination works, see List Pagination.
`display_name`	(optional) A filter to return only resources that match the given display name exactly.
`sort_by`	(optional) The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. Note: In general, some \"List\" operations (for example, `ListInstances`) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these \"List\" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`sort_order`	(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order is case sensitive. Allowed values are: 'ASC', 'DESC'
`lifecycle_state`	(optional) A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_BOOT_VOLUME_BACKUPS Function

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

Syntax

FUNCTION list_boot_volume_backups (
  compartment_id varchar2,
  boot_volume_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  source_boot_volume_backup_id varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_blockstorage_list_boot_volume_backups_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment.
`boot_volume_id`	(optional) The OCID of the boot volume.
`limit`	(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. For important details about how pagination works, see List Pagination. Example: `50`
`page`	(optional) For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. For important details about how pagination works, see List Pagination.
`display_name`	(optional) A filter to return only resources that match the given display name exactly.
`source_boot_volume_backup_id`	(optional) A filter to return only resources that originated from the given source boot volume backup.
`sort_by`	(optional) The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. Note: In general, some \"List\" operations (for example, `ListInstances`) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these \"List\" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`sort_order`	(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order is case sensitive. Allowed values are: 'ASC', 'DESC'
`lifecycle_state`	(optional) A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_BOOT_VOLUME_REPLICAS Function

Lists the boot volume replicas in the specified compartment and availability domain.

Syntax

FUNCTION list_boot_volume_replicas (
  availability_domain varchar2 DEFAULT NULL,
  compartment_id varchar2 DEFAULT NULL,
  volume_group_replica_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_blockstorage_list_boot_volume_replicas_response_t;

Parameters

Parameter	Description
`availability_domain`	(optional) The name of the availability domain. Example: `Uocm:PHX-AD-1`
`compartment_id`	(optional) The OCID of the compartment.
`volume_group_replica_id`	(optional) The OCID of the volume group replica.
`limit`	(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. For important details about how pagination works, see List Pagination. Example: `50`
`page`	(optional) For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. For important details about how pagination works, see List Pagination.
`display_name`	(optional) A filter to return only resources that match the given display name exactly.
`sort_by`	(optional) The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. Note: In general, some \"List\" operations (for example, `ListInstances`) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these \"List\" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`sort_order`	(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order is case sensitive. Allowed values are: 'ASC', 'DESC'
`lifecycle_state`	(optional) A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_BOOT_VOLUMES Function

Lists the boot volumes in the specified compartment and availability domain.

Syntax

FUNCTION list_boot_volumes (
  availability_domain varchar2 DEFAULT NULL,
  compartment_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  volume_group_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_blockstorage_list_boot_volumes_response_t;

Parameters

Parameter	Description
`availability_domain`	(optional) The name of the availability domain. Example: `Uocm:PHX-AD-1`
`compartment_id`	(optional) The OCID of the compartment.
`limit`	(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. For important details about how pagination works, see List Pagination. Example: `50`
`page`	(optional) For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. For important details about how pagination works, see List Pagination.
`volume_group_id`	(optional) The OCID of the volume group.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_VOLUME_BACKUP_POLICIES Function

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.

Syntax

FUNCTION list_volume_backup_policies (
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  compartment_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_blockstorage_list_volume_backup_policies_response_t;

Parameters

Parameter	Description
`limit`	(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. For important details about how pagination works, see List Pagination. Example: `50`
`page`	(optional) For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. For important details about how pagination works, see List Pagination.
`compartment_id`	(optional) The OCID of the compartment. If no compartment is specified, the Oracle defined backup policies are listed.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_VOLUME_BACKUPS Function

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

Syntax

FUNCTION list_volume_backups (
  compartment_id varchar2,
  volume_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  source_volume_backup_id varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_blockstorage_list_volume_backups_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment.
`volume_id`	(optional) The OCID of the volume.
`limit`	(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. For important details about how pagination works, see List Pagination. Example: `50`
`page`	(optional) For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. For important details about how pagination works, see List Pagination.
`display_name`	(optional) A filter to return only resources that match the given display name exactly.
`source_volume_backup_id`	(optional) A filter to return only resources that originated from the given source volume backup.
`sort_by`	(optional) The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. Note: In general, some \"List\" operations (for example, `ListInstances`) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these \"List\" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`sort_order`	(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order is case sensitive. Allowed values are: 'ASC', 'DESC'
`lifecycle_state`	(optional) A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_VOLUME_GROUP_BACKUPS Function

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

Syntax

FUNCTION list_volume_group_backups (
  compartment_id varchar2,
  volume_group_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_blockstorage_list_volume_group_backups_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment.
`volume_group_id`	(optional) The OCID of the volume group.
`limit`	(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. For important details about how pagination works, see List Pagination. Example: `50`
`page`	(optional) For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. For important details about how pagination works, see List Pagination.
`display_name`	(optional) A filter to return only resources that match the given display name exactly.
`sort_by`	(optional) The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. Note: In general, some \"List\" operations (for example, `ListInstances`) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these \"List\" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`sort_order`	(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order is case sensitive. Allowed values are: 'ASC', 'DESC'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_VOLUME_GROUP_REPLICAS Function

Lists the volume group replicas in the specified compartment. You can filter the results by volume group. For more information, see Volume Group Replication.

Syntax

FUNCTION list_volume_group_replicas (
  availability_domain varchar2,
  compartment_id varchar2,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_blockstorage_list_volume_group_replicas_response_t;

Parameters

Parameter	Description
`availability_domain`	(required) The name of the availability domain. Example: `Uocm:PHX-AD-1`
`compartment_id`	(required) The OCID of the compartment.
`limit`	(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. For important details about how pagination works, see List Pagination. Example: `50`
`page`	(optional) For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. For important details about how pagination works, see List Pagination.
`display_name`	(optional) A filter to return only resources that match the given display name exactly.
`sort_by`	(optional) The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. Note: In general, some \"List\" operations (for example, `ListInstances`) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these \"List\" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`sort_order`	(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order is case sensitive. Allowed values are: 'ASC', 'DESC'
`lifecycle_state`	(optional) A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_VOLUME_GROUPS Function

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

Syntax

FUNCTION list_volume_groups (
  compartment_id varchar2,
  availability_domain varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_blockstorage_list_volume_groups_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment.
`availability_domain`	(optional) The name of the availability domain. Example: `Uocm:PHX-AD-1`
`limit`	(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. For important details about how pagination works, see List Pagination. Example: `50`
`page`	(optional) For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. For important details about how pagination works, see List Pagination.
`display_name`	(optional) A filter to return only resources that match the given display name exactly.
`sort_by`	(optional) The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. Note: In general, some \"List\" operations (for example, `ListInstances`) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these \"List\" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`sort_order`	(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order is case sensitive. Allowed values are: 'ASC', 'DESC'
`lifecycle_state`	(optional) A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_VOLUMES Function

Lists the volumes in the specified compartment and availability domain.

Syntax

FUNCTION list_volumes (
  availability_domain varchar2 DEFAULT NULL,
  compartment_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  volume_group_id varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_blockstorage_list_volumes_response_t;

Parameters

Parameter	Description
`availability_domain`	(optional) The name of the availability domain. Example: `Uocm:PHX-AD-1`
`compartment_id`	(optional) The OCID of the compartment.
`limit`	(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. For important details about how pagination works, see List Pagination. Example: `50`
`page`	(optional) For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. For important details about how pagination works, see List Pagination.
`display_name`	(optional) A filter to return only resources that match the given display name exactly.
`sort_by`	(optional) The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. Note: In general, some \"List\" operations (for example, `ListInstances`) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these \"List\" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`sort_order`	(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order is case sensitive. Allowed values are: 'ASC', 'DESC'
`volume_group_id`	(optional) The OCID of the volume group.
`lifecycle_state`	(optional) A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_BOOT_VOLUME Function

Updates the specified boot volume's display name, defined tags, and free-form tags.

Syntax

FUNCTION update_boot_volume (
  boot_volume_id varchar2,
  update_boot_volume_details dbms_cloud_oci_core_update_boot_volume_details_t,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_blockstorage_update_boot_volume_response_t;

Parameters

Parameter	Description
`boot_volume_id`	(required) The OCID of the boot volume.
`update_boot_volume_details`	(required) Update boot volume's display name.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_BOOT_VOLUME_BACKUP Function

Updates the display name for the specified boot volume backup. Avoid entering confidential information.

Syntax

FUNCTION update_boot_volume_backup (
  boot_volume_backup_id varchar2,
  update_boot_volume_backup_details dbms_cloud_oci_core_update_boot_volume_backup_details_t,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_blockstorage_update_boot_volume_backup_response_t;

Parameters

Parameter	Description
`boot_volume_backup_id`	(required) The OCID of the boot volume backup.
`update_boot_volume_backup_details`	(required) Update boot volume backup fields
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_BOOT_VOLUME_KMS_KEY Function

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

Syntax

FUNCTION update_boot_volume_kms_key (
  boot_volume_id varchar2,
  update_boot_volume_kms_key_details dbms_cloud_oci_core_update_boot_volume_kms_key_details_t,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_blockstorage_update_boot_volume_kms_key_response_t;

Parameters

Parameter	Description
`boot_volume_id`	(required) The OCID of the boot volume.
`update_boot_volume_kms_key_details`	(required) Updates the Vault service master encryption key assigned to the specified boot volume.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_VOLUME Function

Updates the specified volume's display name. Avoid entering confidential information.

Syntax

FUNCTION update_volume (
  volume_id varchar2,
  update_volume_details dbms_cloud_oci_core_update_volume_details_t,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_blockstorage_update_volume_response_t;

Parameters

Parameter	Description
`volume_id`	(required) The OCID of the volume.
`update_volume_details`	(required) Update volume's display name. Avoid entering confidential information.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_VOLUME_BACKUP Function

Updates the display name for the specified volume backup. Avoid entering confidential information.

Syntax

FUNCTION update_volume_backup (
  volume_backup_id varchar2,
  update_volume_backup_details dbms_cloud_oci_core_update_volume_backup_details_t,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_blockstorage_update_volume_backup_response_t;

Parameters

Parameter	Description
`volume_backup_id`	(required) The OCID of the volume backup.
`update_volume_backup_details`	(required) Update volume backup fields
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_VOLUME_BACKUP_POLICY Function

Updates a user defined backup policy. For more information about user defined backup policies, see Policy-Based Backups. Avoid entering confidential information.

Syntax

FUNCTION update_volume_backup_policy (
  policy_id varchar2,
  update_volume_backup_policy_details dbms_cloud_oci_core_update_volume_backup_policy_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_blockstorage_update_volume_backup_policy_response_t;

Parameters

Parameter	Description
`policy_id`	(required) The OCID of the volume backup policy.
`update_volume_backup_policy_details`	(required) Update volume backup policy fields
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_VOLUME_GROUP Function

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.

Syntax

FUNCTION update_volume_group (
  volume_group_id varchar2,
  update_volume_group_details dbms_cloud_oci_core_update_volume_group_details_t,
  if_match varchar2 DEFAULT NULL,
  preserve_volume_replica number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_blockstorage_update_volume_group_response_t;

Parameters

Parameter	Description
`volume_group_id`	(required) The Oracle Cloud ID (OCID) that uniquely identifies the volume group.
`update_volume_group_details`	(required) Update volume group's set of volumes and/or display name
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`preserve_volume_replica`	(optional) Specifies whether to disable or preserve the individual volume replication when removing a volume from the replication enabled volume group. When set to `true`, the individual volume replica is preserved. The default value is `true`.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_VOLUME_GROUP_BACKUP Function

Updates the display name for the specified volume group backup. For more information, see Volume Groups.

Syntax

FUNCTION update_volume_group_backup (
  volume_group_backup_id varchar2,
  update_volume_group_backup_details dbms_cloud_oci_core_update_volume_group_backup_details_t,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_blockstorage_update_volume_group_backup_response_t;

Parameters

Parameter	Description
`volume_group_backup_id`	(required) The Oracle Cloud ID (OCID) that uniquely identifies the volume group backup.
`update_volume_group_backup_details`	(required) Update volume group backup fields
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_VOLUME_KMS_KEY Function

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

Syntax

FUNCTION update_volume_kms_key (
  volume_id varchar2,
  update_volume_kms_key_details dbms_cloud_oci_core_update_volume_kms_key_details_t,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_blockstorage_update_volume_kms_key_response_t;

Parameters

Parameter	Description
`volume_id`	(required) The OCID of the volume.
`update_volume_kms_key_details`	(required) Updates the Vault service master encryption key assigned to the specified volume.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

Oracle Cloud Infrastructure Documentation Try Free Tier

CHANGE_BOOT_VOLUME_BACKUP_COMPARTMENT Function 🔗

CHANGE_BOOT_VOLUME_COMPARTMENT Function 🔗

CHANGE_VOLUME_BACKUP_COMPARTMENT Function 🔗

CHANGE_VOLUME_COMPARTMENT Function 🔗

CHANGE_VOLUME_GROUP_BACKUP_COMPARTMENT Function 🔗

CHANGE_VOLUME_GROUP_COMPARTMENT Function 🔗

COPY_BOOT_VOLUME_BACKUP Function 🔗

COPY_VOLUME_BACKUP Function 🔗

COPY_VOLUME_GROUP_BACKUP Function 🔗

CREATE_BOOT_VOLUME Function 🔗

CREATE_BOOT_VOLUME_BACKUP Function 🔗

CREATE_VOLUME Function 🔗

CREATE_VOLUME_BACKUP Function 🔗

CREATE_VOLUME_BACKUP_POLICY Function 🔗

CREATE_VOLUME_BACKUP_POLICY_ASSIGNMENT Function 🔗

CREATE_VOLUME_GROUP Function 🔗

CREATE_VOLUME_GROUP_BACKUP Function 🔗

DELETE_BOOT_VOLUME Function 🔗

DELETE_BOOT_VOLUME_BACKUP Function 🔗

DELETE_BOOT_VOLUME_KMS_KEY Function 🔗

DELETE_VOLUME Function 🔗

DELETE_VOLUME_BACKUP Function 🔗

DELETE_VOLUME_BACKUP_POLICY Function 🔗

DELETE_VOLUME_BACKUP_POLICY_ASSIGNMENT Function 🔗

DELETE_VOLUME_GROUP Function 🔗

DELETE_VOLUME_GROUP_BACKUP Function 🔗

DELETE_VOLUME_KMS_KEY Function 🔗

GET_BLOCK_VOLUME_REPLICA Function 🔗

GET_BOOT_VOLUME Function 🔗

GET_BOOT_VOLUME_BACKUP Function 🔗

GET_BOOT_VOLUME_KMS_KEY Function 🔗

GET_BOOT_VOLUME_REPLICA Function 🔗

GET_VOLUME Function 🔗

GET_VOLUME_BACKUP Function 🔗

GET_VOLUME_BACKUP_POLICY Function 🔗

GET_VOLUME_BACKUP_POLICY_ASSET_ASSIGNMENT Function 🔗

GET_VOLUME_BACKUP_POLICY_ASSIGNMENT Function 🔗

GET_VOLUME_GROUP Function 🔗

GET_VOLUME_GROUP_BACKUP Function 🔗

GET_VOLUME_GROUP_REPLICA Function 🔗

GET_VOLUME_KMS_KEY Function 🔗

LIST_BLOCK_VOLUME_REPLICAS Function 🔗

LIST_BOOT_VOLUME_BACKUPS Function 🔗

LIST_BOOT_VOLUME_REPLICAS Function 🔗

LIST_BOOT_VOLUMES Function 🔗

LIST_VOLUME_BACKUP_POLICIES Function 🔗

LIST_VOLUME_BACKUPS Function 🔗

LIST_VOLUME_GROUP_BACKUPS Function 🔗

LIST_VOLUME_GROUP_REPLICAS Function 🔗

LIST_VOLUME_GROUPS Function 🔗

LIST_VOLUMES Function 🔗

UPDATE_BOOT_VOLUME Function 🔗

UPDATE_BOOT_VOLUME_BACKUP Function 🔗

UPDATE_BOOT_VOLUME_KMS_KEY Function 🔗

UPDATE_VOLUME Function 🔗

UPDATE_VOLUME_BACKUP Function 🔗

UPDATE_VOLUME_BACKUP_POLICY Function 🔗

UPDATE_VOLUME_GROUP Function 🔗

UPDATE_VOLUME_GROUP_BACKUP Function 🔗

UPDATE_VOLUME_KMS_KEY Function 🔗

Oracle Cloud Infrastructure Documentation
Try Free Tier

CHANGE_BOOT_VOLUME_BACKUP_COMPARTMENT Function

CHANGE_BOOT_VOLUME_COMPARTMENT Function

CHANGE_VOLUME_BACKUP_COMPARTMENT Function

CHANGE_VOLUME_COMPARTMENT Function

CHANGE_VOLUME_GROUP_BACKUP_COMPARTMENT Function

CHANGE_VOLUME_GROUP_COMPARTMENT Function

COPY_BOOT_VOLUME_BACKUP Function

COPY_VOLUME_BACKUP Function

COPY_VOLUME_GROUP_BACKUP Function

CREATE_BOOT_VOLUME Function

CREATE_BOOT_VOLUME_BACKUP Function

CREATE_VOLUME Function

CREATE_VOLUME_BACKUP Function

CREATE_VOLUME_BACKUP_POLICY Function

CREATE_VOLUME_BACKUP_POLICY_ASSIGNMENT Function

CREATE_VOLUME_GROUP Function

CREATE_VOLUME_GROUP_BACKUP Function

DELETE_BOOT_VOLUME Function

DELETE_BOOT_VOLUME_BACKUP Function

DELETE_BOOT_VOLUME_KMS_KEY Function

DELETE_VOLUME Function

DELETE_VOLUME_BACKUP Function

DELETE_VOLUME_BACKUP_POLICY Function

DELETE_VOLUME_BACKUP_POLICY_ASSIGNMENT Function

DELETE_VOLUME_GROUP Function

DELETE_VOLUME_GROUP_BACKUP Function

DELETE_VOLUME_KMS_KEY Function

GET_BLOCK_VOLUME_REPLICA Function

GET_BOOT_VOLUME Function

GET_BOOT_VOLUME_BACKUP Function

GET_BOOT_VOLUME_KMS_KEY Function

GET_BOOT_VOLUME_REPLICA Function

GET_VOLUME Function

GET_VOLUME_BACKUP Function

GET_VOLUME_BACKUP_POLICY Function

GET_VOLUME_BACKUP_POLICY_ASSET_ASSIGNMENT Function

GET_VOLUME_BACKUP_POLICY_ASSIGNMENT Function

GET_VOLUME_GROUP Function

GET_VOLUME_GROUP_BACKUP Function

GET_VOLUME_GROUP_REPLICA Function

GET_VOLUME_KMS_KEY Function

LIST_BLOCK_VOLUME_REPLICAS Function

LIST_BOOT_VOLUME_BACKUPS Function

LIST_BOOT_VOLUME_REPLICAS Function

LIST_BOOT_VOLUMES Function

LIST_VOLUME_BACKUP_POLICIES Function

LIST_VOLUME_BACKUPS Function

LIST_VOLUME_GROUP_BACKUPS Function

LIST_VOLUME_GROUP_REPLICAS Function

LIST_VOLUME_GROUPS Function

LIST_VOLUMES Function

UPDATE_BOOT_VOLUME Function

UPDATE_BOOT_VOLUME_BACKUP Function

UPDATE_BOOT_VOLUME_KMS_KEY Function

UPDATE_VOLUME Function

UPDATE_VOLUME_BACKUP Function

UPDATE_VOLUME_BACKUP_POLICY Function

UPDATE_VOLUME_GROUP Function

UPDATE_VOLUME_GROUP_BACKUP Function

UPDATE_VOLUME_KMS_KEY Function