Recovery Database Recovery Functions

Package: DBMS_CLOUD_OCI_R_DATABASE_RECOVERY

CHANGE_PROTECTED_DATABASE_COMPARTMENT Function

Moves a protected database resource from the existing compartment to the specified compartment. When provided, If-Match is checked against ETag values of the resource.

Syntax

FUNCTION change_protected_database_compartment (
  protected_database_id varchar2,
  change_protected_database_compartment_details dbms_cloud_oci_recovery_change_protected_database_compartment_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_r_database_recovery_change_protected_database_compartment_response_t;

Parameters

Parameter	Description
`protected_database_id`	(required) The protected database OCID.
`change_protected_database_compartment_details`	(required) The configuration details required to move a protected database from the existing compartment to a specified compartment.
`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.
`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://recovery.{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.

CHANGE_PROTECTION_POLICY_COMPARTMENT Function

Moves a protection policy resource from the existing compartment to the specified compartment. When provided, If-Match is checked against ETag values of the resource.

Syntax

FUNCTION change_protection_policy_compartment (
  protection_policy_id varchar2,
  change_protection_policy_compartment_details dbms_cloud_oci_recovery_change_protection_policy_compartment_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_r_database_recovery_change_protection_policy_compartment_response_t;

Parameters

Parameter	Description
`protection_policy_id`	(required) The protection policy OCID.
`change_protection_policy_compartment_details`	(required) The configuration details required to move a protection policy from the existing compartment to a specified compartment.
`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.
`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://recovery.{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.

CHANGE_RECOVERY_SERVICE_SUBNET_COMPARTMENT Function

Moves a recovery service subnet resource from the existing compartment to the specified compartment. When provided, If-Match is checked against ETag values of the resource.

Syntax

FUNCTION change_recovery_service_subnet_compartment (
  recovery_service_subnet_id varchar2,
  change_recovery_service_subnet_compartment_details dbms_cloud_oci_recovery_change_recovery_service_subnet_compartment_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_r_database_recovery_change_recovery_service_subnet_compartment_response_t;

Parameters

Parameter	Description
`recovery_service_subnet_id`	(required) The recovery service subnet OCID.
`change_recovery_service_subnet_compartment_details`	(required) The configuration details required to move a Recovery Service subnet from the existing compartment to a specified compartment.
`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.
`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://recovery.{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.

CREATE_PROTECTED_DATABASE Function

Creates a new Protected Database.

Syntax

FUNCTION create_protected_database (
  create_protected_database_details dbms_cloud_oci_recovery_create_protected_database_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_r_database_recovery_create_protected_database_response_t;

Parameters

Parameter	Description
`create_protected_database_details`	(required) Describes the parameters required to create a protected database.
`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 might be rejected.
`opc_request_id`	(optional) Unique identifier for the request.
`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://recovery.{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.

CREATE_PROTECTION_POLICY Function

Creates a new Protection Policy.

Syntax

FUNCTION create_protection_policy (
  create_protection_policy_details dbms_cloud_oci_recovery_create_protection_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_r_database_recovery_create_protection_policy_response_t;

Parameters

Parameter	Description
`create_protection_policy_details`	(required) Describes the parameters required to create a custom protection 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 might be rejected.
`opc_request_id`	(optional) Unique identifier for the request.
`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://recovery.{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.

CREATE_RECOVERY_SERVICE_SUBNET Function

Creates a new Recovery Service Subnet.

Syntax

FUNCTION create_recovery_service_subnet (
  create_recovery_service_subnet_details dbms_cloud_oci_recovery_create_recovery_service_subnet_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_r_database_recovery_create_recovery_service_subnet_response_t;

Parameters

Parameter	Description
`create_recovery_service_subnet_details`	(required) Describes the parameters required to create a recovery service subnet.
`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 might be rejected.
`opc_request_id`	(optional) Unique identifier for the request.
`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://recovery.{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.

DELETE_PROTECTED_DATABASE Function

Deletes a protected database based on the specified protected database ID.

Syntax

FUNCTION delete_protected_database (
  protected_database_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_r_database_recovery_delete_protected_database_response_t;

Parameters

Parameter	Description
`protected_database_id`	(required) The protected database OCID.
`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.
`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://recovery.{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.

DELETE_PROTECTION_POLICY Function

Deletes a specified protection policy. You can delete custom policies only. Deleting a Oracle predefined policies will result in status code 405 Method Not Allowed.

Syntax

FUNCTION delete_protection_policy (
  protection_policy_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_r_database_recovery_delete_protection_policy_response_t;

Parameters

Parameter	Description
`protection_policy_id`	(required) The protection policy OCID.
`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.
`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://recovery.{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.

DELETE_RECOVERY_SERVICE_SUBNET Function

Deletes a specified recovery service subnet.

Syntax

FUNCTION delete_recovery_service_subnet (
  recovery_service_subnet_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_r_database_recovery_delete_recovery_service_subnet_response_t;

Parameters

Parameter	Description
`recovery_service_subnet_id`	(required) The recovery service subnet OCID.
`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.
`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://recovery.{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.

FETCH_PROTECTED_DATABASE_CONFIGURATION Function

Downloads the network service configuration file 'tnsnames.ora' for a specified protected database. Applies to user-defined recovery systems only.

Syntax

FUNCTION fetch_protected_database_configuration (
  protected_database_id varchar2,
  fetch_protected_database_configuration_details dbms_cloud_oci_recovery_fetch_protected_database_configuration_details_t DEFAULT NULL,
  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_r_database_recovery_fetch_protected_database_configuration_response_t;

Parameters

Parameter	Description
`protected_database_id`	(required) The protected database OCID.
`fetch_protected_database_configuration_details`	(optional) Which configuration to get
`opc_request_id`	(optional) Unique identifier for the request.
`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://recovery.{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_PROTECTED_DATABASE Function

Gets information about a specified protected database.

Syntax

FUNCTION get_protected_database (
  protected_database_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_r_database_recovery_get_protected_database_response_t;

Parameters

Parameter	Description
`protected_database_id`	(required) The protected database OCID.
`opc_request_id`	(optional) Unique identifier for the request.
`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://recovery.{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_PROTECTION_POLICY Function

Gets information about a specified protection policy.

Syntax

FUNCTION get_protection_policy (
  protection_policy_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_r_database_recovery_get_protection_policy_response_t;

Parameters

Parameter	Description
`protection_policy_id`	(required) The protection policy OCID.
`opc_request_id`	(optional) Unique identifier for the request.
`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://recovery.{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_RECOVERY_SERVICE_SUBNET Function

Gets information about a specified recovery service subnet.

Syntax

FUNCTION get_recovery_service_subnet (
  recovery_service_subnet_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_r_database_recovery_get_recovery_service_subnet_response_t;

Parameters

Parameter	Description
`recovery_service_subnet_id`	(required) The recovery service subnet OCID.
`opc_request_id`	(optional) Unique identifier for the request.
`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://recovery.{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_WORK_REQUEST Function

Gets the status of the work request based on the specified ID

Syntax

FUNCTION get_work_request (
  work_request_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_r_database_recovery_get_work_request_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The OCID of the work request.
`opc_request_id`	(optional) Unique identifier for the request.
`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://recovery.{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_PROTECTED_DATABASES Function

Lists the protected databases based on the specified parameters.

Syntax

FUNCTION list_protected_databases (
  compartment_id varchar2,
  lifecycle_state varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  id varchar2 DEFAULT NULL,
  protection_policy_id varchar2 DEFAULT NULL,
  recovery_service_subnet_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_r_database_recovery_list_protected_databases_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The compartment OCID.
`lifecycle_state`	(optional) A filter to return only the resources that match the specified lifecycle state. Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'DELETING', 'DELETED', 'FAILED'
`display_name`	(optional) A filter to return only resources that match the entire 'displayname' given.
`id`	(optional) The protected database OCID.
`protection_policy_id`	(optional) The protection policy OCID.
`recovery_service_subnet_id`	(optional) The recovery service subnet OCID.
`limit`	(optional) The maximum number of items to return per page.
`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 ascending (ASC) or descending (DESC). Allowed values are: - ASC - DESC Allowed values are: 'ASC', 'DESC'
`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. If you do not specify a value, then TIMECREATED is used as the default sort order. Allowed values are: - TIMECREATED - DISPLAYNAME Allowed values are: 'timeCreated', 'displayName'
`opc_request_id`	(optional) Unique identifier for the request.
`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://recovery.{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_PROTECTION_POLICIES Function

Gets a list of protection policies based on the specified parameters.

Syntax

FUNCTION list_protection_policies (
  compartment_id varchar2,
  lifecycle_state varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  protection_policy_id varchar2 DEFAULT NULL,
  owner 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_r_database_recovery_list_protection_policies_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The compartment OCID.
`lifecycle_state`	(optional) A filter to return only resources their lifecycleState matches the given lifecycleState. Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'DELETING', 'DELETED', 'FAILED'
`display_name`	(optional) A filter to return only resources that match the entire 'displayname' given.
`protection_policy_id`	(optional) The protection policy OCID.
`owner`	(optional) A filter to return only the policies that match the owner as 'Customer' or 'Oracle'. Allowed values are: 'oracle', 'customer'
`limit`	(optional) The maximum number of items to return. Specify a value greater than 4.
`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 ascending (ASC) or descending (DESC). Allowed values are: - ASC - DESC Allowed values are: 'ASC', 'DESC'
`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. If you do not specify a value, then TIMECREATED is used as the default sort order. Allowed values are: - TIMECREATED - DISPLAYNAME Allowed values are: 'timeCreated', 'displayName'
`opc_request_id`	(optional) Unique identifier for the request.
`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://recovery.{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_RECOVERY_SERVICE_SUBNETS Function

Returns a list of Recovery Service Subnets.

Syntax

FUNCTION list_recovery_service_subnets (
  compartment_id varchar2,
  lifecycle_state varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  id varchar2 DEFAULT NULL,
  vcn_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_r_database_recovery_list_recovery_service_subnets_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The compartment OCID.
`lifecycle_state`	(optional) A filter to return only the resources that match the specified lifecycle state. Allowed values are: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'DELETING', 'DELETED', 'FAILED'
`display_name`	(optional) A filter to return only resources that match the entire 'displayname' given.
`id`	(optional) The recovery service subnet OCID.
`vcn_id`	(optional) The OCID of the virtual cloud network (VCN) associated with the recovery service subnet.
`limit`	(optional) The maximum number of items to return per page.
`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 ascending (ASC) or descending (DESC). Allowed values are: - ASC - DESC Allowed values are: 'ASC', 'DESC'
`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. If you do not specify a value, then TIMECREATED is used as the default sort order. Allowed values are: - TIMECREATED - DISPLAYNAME Allowed values are: 'timeCreated', 'displayName'
`opc_request_id`	(optional) Unique identifier for the request.
`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://recovery.{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_WORK_REQUEST_ERRORS Function

Return a (paginated) list of errors for a given work request.

Syntax

FUNCTION list_work_request_errors (
  work_request_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number 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_r_database_recovery_list_work_request_errors_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The OCID of the work request.
`opc_request_id`	(optional) Unique identifier for the request.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`limit`	(optional) The maximum number of items to return per page.
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Allowed values are: 'timeCreated'
`sort_order`	(optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: - ASC - DESC 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://recovery.{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_WORK_REQUEST_LOGS Function

Return a (paginated) list of logs for a given work request.

Syntax

FUNCTION list_work_request_logs (
  work_request_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number 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_r_database_recovery_list_work_request_logs_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The OCID of the work request.
`opc_request_id`	(optional) Unique identifier for the request.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`limit`	(optional) The maximum number of items to return per page.
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Allowed values are: 'timeCreated'
`sort_order`	(optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: - ASC - DESC 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://recovery.{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_WORK_REQUESTS Function

Lists the work requests in a compartment.

Syntax

FUNCTION list_work_requests (
  compartment_id varchar2,
  work_request_id varchar2 DEFAULT NULL,
  status varchar2 DEFAULT NULL,
  resource_id varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_r_database_recovery_list_work_requests_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The compartment OCID.
`work_request_id`	(optional) Unique Oracle-assigned identifier of the work request.
`status`	(optional) A filter to return only resources their lifecycleState matches the given OperationStatus. Allowed values are: 'ACCEPTED', 'IN_PROGRESS', 'FAILED', 'SUCCEEDED', 'CANCELING', 'CANCELED'
`resource_id`	(optional) The ID of the resource affected by the work request.
`opc_request_id`	(optional) Unique identifier for the request.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`limit`	(optional) The maximum number of items to return per page.
`sort_order`	(optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: - ASC - DESC Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending. Allowed values are: 'timeAccepted'
`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://recovery.{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_PROTECTED_DATABASE Function

Updates the Protected Database

Syntax

FUNCTION update_protected_database (
  protected_database_id varchar2,
  update_protected_database_details dbms_cloud_oci_recovery_update_protected_database_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_r_database_recovery_update_protected_database_response_t;

Parameters

Parameter	Description
`protected_database_id`	(required) The protected database OCID.
`update_protected_database_details`	(required) Describes the parameters required to update a protected database.
`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.
`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://recovery.{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_PROTECTION_POLICY Function

Updates the specified protection policy.

Syntax

FUNCTION update_protection_policy (
  protection_policy_id varchar2,
  update_protection_policy_details dbms_cloud_oci_recovery_update_protection_policy_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_r_database_recovery_update_protection_policy_response_t;

Parameters

Parameter	Description
`protection_policy_id`	(required) The protection policy OCID.
`update_protection_policy_details`	(required) The information to be updated.
`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.
`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://recovery.{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_RECOVERY_SERVICE_SUBNET Function

Updates the specified recovery service subnet.

Syntax

FUNCTION update_recovery_service_subnet (
  recovery_service_subnet_id varchar2,
  update_recovery_service_subnet_details dbms_cloud_oci_recovery_update_recovery_service_subnet_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_r_database_recovery_update_recovery_service_subnet_response_t;

Parameters

Parameter	Description
`recovery_service_subnet_id`	(required) The recovery service subnet OCID.
`update_recovery_service_subnet_details`	(required) Describes the parameters required to update a recovery service subnet.
`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.
`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://recovery.{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.

Oracle Cloud Infrastructure Documentation Try Free Tier

CHANGE_PROTECTED_DATABASE_COMPARTMENT Function 🔗

CHANGE_PROTECTION_POLICY_COMPARTMENT Function 🔗

CHANGE_RECOVERY_SERVICE_SUBNET_COMPARTMENT Function 🔗

CREATE_PROTECTED_DATABASE Function 🔗

CREATE_PROTECTION_POLICY Function 🔗

CREATE_RECOVERY_SERVICE_SUBNET Function 🔗

DELETE_PROTECTED_DATABASE Function 🔗

DELETE_PROTECTION_POLICY Function 🔗

DELETE_RECOVERY_SERVICE_SUBNET Function 🔗

FETCH_PROTECTED_DATABASE_CONFIGURATION Function 🔗

GET_PROTECTED_DATABASE Function 🔗

GET_PROTECTION_POLICY Function 🔗

GET_RECOVERY_SERVICE_SUBNET Function 🔗

GET_WORK_REQUEST Function 🔗

LIST_PROTECTED_DATABASES Function 🔗

LIST_PROTECTION_POLICIES Function 🔗

LIST_RECOVERY_SERVICE_SUBNETS Function 🔗

LIST_WORK_REQUEST_ERRORS Function 🔗

LIST_WORK_REQUEST_LOGS Function 🔗

LIST_WORK_REQUESTS Function 🔗

UPDATE_PROTECTED_DATABASE Function 🔗

UPDATE_PROTECTION_POLICY Function 🔗

UPDATE_RECOVERY_SERVICE_SUBNET Function 🔗

Oracle Cloud Infrastructure Documentation
Try Free Tier

CHANGE_PROTECTED_DATABASE_COMPARTMENT Function

CHANGE_PROTECTION_POLICY_COMPARTMENT Function

CHANGE_RECOVERY_SERVICE_SUBNET_COMPARTMENT Function

CREATE_PROTECTED_DATABASE Function

CREATE_PROTECTION_POLICY Function

CREATE_RECOVERY_SERVICE_SUBNET Function

DELETE_PROTECTED_DATABASE Function

DELETE_PROTECTION_POLICY Function

DELETE_RECOVERY_SERVICE_SUBNET Function

FETCH_PROTECTED_DATABASE_CONFIGURATION Function

GET_PROTECTED_DATABASE Function

GET_PROTECTION_POLICY Function

GET_RECOVERY_SERVICE_SUBNET Function

GET_WORK_REQUEST Function

LIST_PROTECTED_DATABASES Function

LIST_PROTECTION_POLICIES Function

LIST_RECOVERY_SERVICE_SUBNETS Function

LIST_WORK_REQUEST_ERRORS Function

LIST_WORK_REQUEST_LOGS Function

LIST_WORK_REQUESTS Function

UPDATE_PROTECTED_DATABASE Function

UPDATE_PROTECTION_POLICY Function

UPDATE_RECOVERY_SERVICE_SUBNET Function