Oracle Cloud Infrastructure Documentation

OpenSearch Cluster Backup Functions

Package: DBMS_CLOUD_OCI_OPS_OPENSEARCH_CLUSTER_BACKUP

DELETE_OPENSEARCH_CLUSTER_BACKUP Function

Deletes a OpensearchClusterBackup resource by identifier

Syntax

FUNCTION delete_opensearch_cluster_backup (
  opensearch_cluster_backup_id varchar2,
  if_match 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_ops_opensearch_cluster_backup_delete_opensearch_cluster_backup_response_t;

Parameters

Parameter Description

opensearch_cluster_backup_id

(required) unique OpensearchClusterBackup identifier

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) The client request ID for tracing.

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://search-indexing.{region}.oci.{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_OPENSEARCH_CLUSTER_BACKUP Function

Gets a OpensearchClusterBackup by identifier

Syntax

FUNCTION get_opensearch_cluster_backup (
  opensearch_cluster_backup_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ops_opensearch_cluster_backup_get_opensearch_cluster_backup_response_t;

Parameters

Parameter Description

opensearch_cluster_backup_id

(required) unique OpensearchClusterBackup identifier

opc_request_id

(optional) The client request ID for tracing.

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://search-indexing.{region}.oci.{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_OPENSEARCH_CLUSTER_BACKUPS Function

Returns a list of OpensearchClusterBackups.

Syntax

FUNCTION list_opensearch_cluster_backups (
  compartment_id varchar2,
  lifecycle_state varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  source_opensearch_cluster_id varchar2 DEFAULT NULL,
  id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by 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_ops_opensearch_cluster_backup_list_opensearch_cluster_backups_response_t;

Parameters

Parameter Description

compartment_id

(required) The ID of the compartment in which to list resources.

lifecycle_state

(optional) A filter to return only resources their lifecycleState matches the given lifecycleState.

display_name

(optional) A filter to return only resources that match the entire display name given.

source_opensearch_cluster_id

(optional) A filter to return only resources that match the entire source cluster id given.

id

(optional) unique OpensearchClusterBackup identifier

limit

(optional) The maximum number of items to return.

page

(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

sort_order

(optional) The sort order to use, either 'asc' or 'desc'.

Allowed values are: 'ASC', 'DESC'

sort_by

(optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.

Allowed values are: 'timeCreated', 'displayName'

opc_request_id

(optional) The client request ID for tracing.

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://search-indexing.{region}.oci.{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_OPENSEARCH_CLUSTER_BACKUP Function

Updates the OpensearchClusterBackup

Syntax

FUNCTION update_opensearch_cluster_backup (
  opensearch_cluster_backup_id varchar2,
  update_opensearch_cluster_backup_details dbms_cloud_oci_opensearch_update_opensearch_cluster_backup_details_t,
  if_match 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_ops_opensearch_cluster_backup_update_opensearch_cluster_backup_response_t;

Parameters

Parameter Description

opensearch_cluster_backup_id

(required) unique OpensearchClusterBackup identifier

update_opensearch_cluster_backup_details

(required) Update the opensearch cluster backup details.

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) The client request ID for tracing.

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://search-indexing.{region}.oci.{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.