Recovery Common Types
DBMS_CLOUD_OCI_RECOVERY_VARCHAR2_TBL Type
Nested table type of varchar2(32767).
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_recovery_varchar2_tbl FORCE IS TABLE OF (varchar2(32767)) NOT PERSISTABLE;DBMS_CLOUD_OCI_RECOVERY_CHANGE_PROTECTED_DATABASE_COMPARTMENT_DETAILS_T Type
The configuration details required to move a protected database from the existing compartment to a specified compartment.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_recovery_change_protected_database_compartment_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
compartment_id varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_recovery_change_protected_database_compartment_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_recovery_change_protected_database_compartment_details_t (
compartment_id varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The OCID of the compartment into which the protected database should be moved. |
DBMS_CLOUD_OCI_RECOVERY_CHANGE_PROTECTION_POLICY_COMPARTMENT_DETAILS_T Type
The configuration details required to move a protection policy from the existing compartment to a specified compartment.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_recovery_change_protection_policy_compartment_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
compartment_id varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_recovery_change_protection_policy_compartment_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_recovery_change_protection_policy_compartment_details_t (
compartment_id varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The OCID of the compartment into which the Protection Policy should be moved. |
DBMS_CLOUD_OCI_RECOVERY_CHANGE_RECOVERY_SERVICE_SUBNET_COMPARTMENT_DETAILS_T Type
The configuration details required to move a Recovery Service subnet from the existing compartment to a specified compartment.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_recovery_change_recovery_service_subnet_compartment_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
compartment_id varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_recovery_change_recovery_service_subnet_compartment_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_recovery_change_recovery_service_subnet_compartment_details_t (
compartment_id varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The OCID of the compartment into which the Recovery Service subnet should be moved. |
DBMS_CLOUD_OCI_RECOVERY_RECOVERY_SERVICE_SUBNET_INPUT_T Type
Parameters to retrieve information about a specific recovery service subnet.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_recovery_recovery_service_subnet_input_t FORCE AUTHID CURRENT_USER IS OBJECT (
recovery_service_subnet_id varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_recovery_recovery_service_subnet_input_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_recovery_recovery_service_subnet_input_t (
recovery_service_subnet_id varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The recovery service subnet OCID. |
DBMS_CLOUD_OCI_RECOVERY_RECOVERY_SERVICE_SUBNET_INPUT_TBL Type
Nested table type of dbms_cloud_oci_recovery_recovery_service_subnet_input_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_recovery_recovery_service_subnet_input_tbl FORCE IS TABLE OF (dbms_cloud_oci_recovery_recovery_service_subnet_input_t) NOT PERSISTABLE;DBMS_CLOUD_OCI_RECOVERY_CREATE_PROTECTED_DATABASE_DETAILS_T Type
Describes the parameters required to create a protected database.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_recovery_create_protected_database_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
display_name varchar2(32767),
db_unique_name varchar2(32767),
database_size varchar2(32767),
password varchar2(32767),
protection_policy_id varchar2(32767),
recovery_service_subnets dbms_cloud_oci_recovery_recovery_service_subnet_input_tbl,
database_id varchar2(32767),
compartment_id varchar2(32767),
database_size_in_g_bs number,
change_rate number,
compression_ratio number,
is_redo_logs_shipped number,
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_recovery_create_protected_database_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_recovery_create_protected_database_details_t (
display_name varchar2,
db_unique_name varchar2,
database_size varchar2,
password varchar2,
protection_policy_id varchar2,
recovery_service_subnets dbms_cloud_oci_recovery_recovery_service_subnet_input_tbl,
database_id varchar2,
compartment_id varchar2,
database_size_in_g_bs number,
change_rate number,
compression_ratio number,
is_redo_logs_shipped number,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The protected database name. You can change the displayName. Avoid entering confidential information. |
|
|
(required) The dbUniqueName of the protected database in Recovery Service. You cannot change the unique name. |
|
|
(optional) The size of the protected database. XS - Less than 5GB, S - 5GB to 50GB, M - 50GB to 500GB, L - 500GB to 1TB, XL - 1TB to 5TB, XXL - Greater than 5TB. Allowed values are: 'XS', 'S', 'M', 'L', 'XL', 'XXL', 'AUTO' |
|
|
(required) Password credential which can be used to connect to Protected Database. It must contain at least 2 uppercase, 2 lowercase, 2 numeric and 2 special characters. The special characters must be underscore (_), number sign (#) or hyphen (-). The password must not contain the username \"admin\", regardless of casing. |
|
|
(required) The OCID of the protection policy associated with the protected database. |
|
|
(required) List of recovery service subnet resources associated with the protected database. |
|
|
(optional) The OCID of the protected database. |
|
|
(required) The OCID of the compartment that contains the protected database. |
|
|
(optional) The size of the database, in gigabytes. |
|
|
(optional) The percentage of data changes that exist in the database between successive incremental backups. |
|
|
(optional) The compression ratio of the protected database. The compression ratio represents the ratio of compressed block size to expanded block size. |
|
|
(optional) The value TRUE indicates that the protected database is configured to use Real-time data protection, and redo-data is sent from the protected database to Recovery Service. Real-time data protection substantially reduces the window of potential data loss that exists between successive archived redo log backups. |
|
|
(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}` |
|
|
(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`. For more information, see Resource Tags |
DBMS_CLOUD_OCI_RECOVERY_CREATE_PROTECTION_POLICY_DETAILS_T Type
Describes the parameters required to create a custom protection policy.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_recovery_create_protection_policy_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
display_name varchar2(32767),
backup_retention_period_in_days number,
compartment_id varchar2(32767),
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_recovery_create_protection_policy_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_recovery_create_protection_policy_details_t (
display_name varchar2,
backup_retention_period_in_days number,
compartment_id varchar2,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) A user provided name for the protection policy. The 'displayName' does not have to be unique, and it can be modified. Avoid entering confidential information. |
|
|
(required) The maximum number of days to retain backups for a protected database. |
|
|
(required) Compartment Identifier |
|
|
(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}` |
|
|
(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`. For more information, see Resource Tags |
DBMS_CLOUD_OCI_RECOVERY_CREATE_RECOVERY_SERVICE_SUBNET_DETAILS_T Type
Describes the parameters required to create a recovery service subnet.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_recovery_create_recovery_service_subnet_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
display_name varchar2(32767),
subnet_id varchar2(32767),
vcn_id varchar2(32767),
compartment_id varchar2(32767),
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_recovery_create_recovery_service_subnet_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_recovery_create_recovery_service_subnet_details_t (
display_name varchar2,
subnet_id varchar2,
vcn_id varchar2,
compartment_id varchar2,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) A user-provided name for the recovery service subnet. The 'displayName' does not have to be unique, and it can be modified. Avoid entering confidential information. |
|
|
(required) The OCID of the subnet associated with the recovery service subnet. You can create a single backup network per virtual cloud network (VCN). |
|
|
(required) The OCID of the virtual cloud network (VCN) that contains the recovery service subnet. You can create a single recovery service subnet per VCN. |
|
|
(required) The compartment OCID. |
|
|
(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}` |
|
|
(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`. For more information, see Resource Tags |
DBMS_CLOUD_OCI_RECOVERY_ERROR_T Type
Error Information.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_recovery_error_t FORCE AUTHID CURRENT_USER IS OBJECT (
code varchar2(32767),
message varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_recovery_error_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_recovery_error_t (
code varchar2,
message varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) A short error code that defines the error, meant for programmatic parsing. |
|
|
(required) A human-readable error string. |
DBMS_CLOUD_OCI_RECOVERY_FETCH_PROTECTED_DATABASE_CONFIGURATION_DETAILS_T Type
Provides which configuration details to get.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_recovery_fetch_protected_database_configuration_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
configuration_type varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_recovery_fetch_protected_database_configuration_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_recovery_fetch_protected_database_configuration_details_t (
configuration_type varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(optional) Currently has four config options ALL, TNSNAMES, HOSTS and CABUNDLE. All will return a zipped folder containing the contents of both tnsnames and the certificateChainPem. Allowed values are: 'CABUNDLE', 'TNSNAMES', 'HOSTS', 'ALL' |
DBMS_CLOUD_OCI_RECOVERY_METRICS_T Type
Backup performance and storage utilization metrics for the protected database.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_recovery_metrics_t FORCE AUTHID CURRENT_USER IS OBJECT (
backup_space_used_in_g_bs number,
backup_space_estimate_in_g_bs number,
unprotected_window_in_seconds number,
db_size_in_g_bs number,
is_redo_logs_enabled number,
retention_period_in_days number,
current_retention_period_in_seconds number,
CONSTRUCTOR FUNCTION dbms_cloud_oci_recovery_metrics_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_recovery_metrics_t (
backup_space_used_in_g_bs number,
backup_space_estimate_in_g_bs number,
unprotected_window_in_seconds number,
db_size_in_g_bs number,
is_redo_logs_enabled number,
retention_period_in_days number,
current_retention_period_in_seconds number
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(optional) Backup storage space, in gigabytes, utilized by the protected database. Oracle charges for the total storage used. |
|
|
(optional) The estimated backup storage space, in gigabytes, required to meet the recovery window goal, including foot print and backups for the protected database. |
|
|
(optional) This is the time window when there is data loss exposure. The point after which recovery is impossible unless additional redo is available. This is the time we received the last backup or last redo-log shipped. |
|
|
(optional) The estimated space, in gigabytes, consumed by the protected database. The database size is based on the size of the data files in the catalog, and does not include archive logs. |
|
|
(optional) The value TRUE indicates that the protected database is configured to use Real-time data protection, and redo-data is sent from the protected database to Recovery Service. Real-time data protection substantially reduces the window of potential data loss that exists between successive archived redo log backups. |
|
|
(optional) The maximum number of days to retain backups for a protected database. |
|
|
(optional) Number of seconds backups are currently retained for this database. |
DBMS_CLOUD_OCI_RECOVERY_METRICS_SUMMARY_T Type
Backup performance and storage utilization metrics for the Protected Database.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_recovery_metrics_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
backup_space_used_in_g_bs number,
backup_space_estimate_in_g_bs number,
unprotected_window_in_seconds number,
db_size_in_g_bs number,
is_redo_logs_enabled number,
retention_period_in_days number,
current_retention_period_in_seconds number,
CONSTRUCTOR FUNCTION dbms_cloud_oci_recovery_metrics_summary_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_recovery_metrics_summary_t (
backup_space_used_in_g_bs number,
backup_space_estimate_in_g_bs number,
unprotected_window_in_seconds number,
db_size_in_g_bs number,
is_redo_logs_enabled number,
retention_period_in_days number,
current_retention_period_in_seconds number
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(optional) Backup storage space, in gigabytes, utilized by the protected database. Oracle charges for the total storage used. |
|
|
(optional) The estimated backup storage space, in gigabytes, required to meet the recovery window goal, including foot print and backups for the protected database. |
|
|
(optional) This is the time window when there is data loss exposure. The point after which recovery is impossible unless additional redo is available. This is the time we received the last backup or last redo-log shipped. |
|
|
(optional) The estimated space, in gigabytes, consumed by the protected database. The database size is based on the size of the data files in the catalog, and does not include archive logs. |
|
|
(optional) The value TRUE indicates that the protected database is configured to use Real-time data protection, and redo-data is sent from the protected database to Recovery Service. Real-time data protection substantially reduces the window of potential data loss that exists between successive archived redo log backups. |
|
|
(optional) The maximum number of days to retain backups for a protected database. |
|
|
(optional) Number of seconds backups are currently retained for this database. |
DBMS_CLOUD_OCI_RECOVERY_RECOVERY_SERVICE_SUBNET_DETAILS_T Type
Details of the Recovery Service Subnet.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_recovery_recovery_service_subnet_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
recovery_service_subnet_id varchar2(32767),
lifecycle_state varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_recovery_recovery_service_subnet_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_recovery_recovery_service_subnet_details_t (
recovery_service_subnet_id varchar2,
lifecycle_state varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) Recovery Service Subnet Identifier. |
|
|
(optional) The current state of the Recovery Service Subnet. Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'DELETING', 'DELETED', 'FAILED' |
DBMS_CLOUD_OCI_RECOVERY_RECOVERY_SERVICE_SUBNET_DETAILS_TBL Type
Nested table type of dbms_cloud_oci_recovery_recovery_service_subnet_details_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_recovery_recovery_service_subnet_details_tbl FORCE IS TABLE OF (dbms_cloud_oci_recovery_recovery_service_subnet_details_t) NOT PERSISTABLE;DBMS_CLOUD_OCI_RECOVERY_PROTECTED_DATABASE_T Type
A protected database is an Oracle Cloud Database whose backups are managed by Oracle Database Autonomous Recovery Service. Each protected database requires a recovery service subnet and a protection policy to use Recovery Service as the backup destination for centralized backup and recovery
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_recovery_protected_database_t FORCE AUTHID CURRENT_USER IS OBJECT (
id varchar2(32767),
display_name varchar2(32767),
compartment_id varchar2(32767),
db_unique_name varchar2(32767),
vpc_user_name varchar2(32767),
database_size varchar2(32767),
protection_policy_id varchar2(32767),
recovery_service_subnets dbms_cloud_oci_recovery_recovery_service_subnet_details_tbl,
database_id varchar2(32767),
database_size_in_g_bs number,
change_rate number,
compression_ratio number,
is_redo_logs_shipped number,
time_created timestamp with time zone,
time_updated timestamp with time zone,
lifecycle_state varchar2(32767),
health varchar2(32767),
is_read_only_resource number,
lifecycle_details varchar2(32767),
health_details varchar2(32767),
metrics dbms_cloud_oci_recovery_metrics_t,
freeform_tags json_element_t,
defined_tags json_element_t,
system_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_recovery_protected_database_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_recovery_protected_database_t (
id varchar2,
display_name varchar2,
compartment_id varchar2,
db_unique_name varchar2,
vpc_user_name varchar2,
database_size varchar2,
protection_policy_id varchar2,
recovery_service_subnets dbms_cloud_oci_recovery_recovery_service_subnet_details_tbl,
database_id varchar2,
database_size_in_g_bs number,
change_rate number,
compression_ratio number,
is_redo_logs_shipped number,
time_created timestamp with time zone,
time_updated timestamp with time zone,
lifecycle_state varchar2,
health varchar2,
is_read_only_resource number,
lifecycle_details varchar2,
health_details varchar2,
metrics dbms_cloud_oci_recovery_metrics_t,
freeform_tags json_element_t,
defined_tags json_element_t,
system_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The OCID of the protected database. |
|
|
(optional) The protected database name. You can change the displayName. Avoid entering confidential information. |
|
|
(required) The OCID of the compartment that contains the protected database. |
|
|
(required) The dbUniqueName for the protected database in Recovery Service. You cannot change the unique name. |
|
|
(required) The virtual private catalog (VPC) user credentials that authenticates the protected database to access Recovery Service. |
|
|
(required) The size of the protected database. XS - Less than 5GB, S - 5GB to 50GB, M - 50GB to 500GB, L - 500GB to 1TB, XL - 1TB to 5TB, XXL - Greater than 5TB. Allowed values are: 'XS', 'S', 'M', 'L', 'XL', 'XXL', 'AUTO' |
|
|
(required) The OCID of the protection policy associated with the protected database. |
|
|
(required) List of recovery service subnet resources associated with the protected database. |
|
|
(optional) The OCID of the protected database. |
|
|
(optional) The size of the database in GBs, in gigabytes. |
|
|
(optional) The percentage of data changes that exist in the database between successive incremental backups. |
|
|
(optional) The compression ratio of the protected database. The compression ratio represents the ratio of compressed block size to expanded block size. |
|
|
(optional) The value TRUE indicates that the protected database is configured to use Real-time data protection, and redo-data is sent from the protected database to Recovery Service. Real-time data protection substantially reduces the window of potential data loss that exists between successive archived redo log backups. For this to be effective, additional configuration is needed on client side. |
|
|
(optional) An RFC3339 formatted datetime string that indicates the created time for a protected database. For example: '2020-05-22T21:10:29.600Z' |
|
|
(optional) An RFC3339 formatted datetime string that indicates the last updated time for a protected database. For example: '2020-05-22T21:10:29.600Z' |
|
|
(optional) The current state of the Protected Database. Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'DELETING', 'DELETED', 'FAILED' |
|
|
(optional) Indicates the protection status of the database. Allowed values are: - HEALTHY - WARNING - ALERT A 'HEALTHY' status indicates that Recovery Service can ensure database recovery to any point in time within the entire recovery window. The potential data loss exposure since the last backup is: - Less than 10 seconds, if Real-time data protection is enabled - Less than 70 minutes if Real-time data protection is disabled A 'WARNING' status indicates that Recovery Service can ensure database recovery within the current recovery window - 1 day. The potential data loss exposure since the last backup is: - Greater than 10 seconds, if Real-time data protection is enabled - Greater than 60 minutes, if if Real-time data protection is disabled An 'ALERT' status indicates that Recovery Service cannot recover the database within the current recovery window. Allowed values are: 'PROTECTED', 'WARNING', 'ALERT' |
|
|
(optional) Indicates whether the protected database is created by Recovery Service or created manually. Set to <b>TRUE</b> for a service-defined protected database. When you enable the OCI-managed automatic backups option for a database and set Recovery Service as the backup destination, then Recovery Service creates the associated protected database resource. Set to <b>FALSE</b> for a user-defined protected database. |
|
|
(optional) Detailed description about the current lifecycle state of the protected database. For example, it can be used to provide actionable information for a resource in a Failed state. |
|
|
(optional) A message describing the current health of the protected database. |
|
|
(optional) |
|
|
(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}` |
|
|
(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`. For more information, see Resource Tags |
|
|
(optional) Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`. For more information, see Resource Tags |
DBMS_CLOUD_OCI_RECOVERY_PROTECTED_DATABASE_SUMMARY_T Type
A protected database is an Oracle Cloud Database whose backups are managed by Oracle Database Autonomous Recovery Service. Each protected database requires a recovery service subnet and a protection policy to use Recovery Service as the backup destination for centralized backup and recovery. To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see Getting Started with Policies. For information about access control and compartments, see Overview of the Identity Service.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_recovery_protected_database_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
id varchar2(32767),
display_name varchar2(32767),
compartment_id varchar2(32767),
db_unique_name varchar2(32767),
vpc_user_name varchar2(32767),
database_size varchar2(32767),
protection_policy_id varchar2(32767),
recovery_service_subnets dbms_cloud_oci_recovery_recovery_service_subnet_details_tbl,
database_id varchar2(32767),
time_created timestamp with time zone,
time_updated timestamp with time zone,
lifecycle_state varchar2(32767),
health varchar2(32767),
lifecycle_details varchar2(32767),
health_details varchar2(32767),
is_read_only_resource number,
metrics dbms_cloud_oci_recovery_metrics_summary_t,
freeform_tags json_element_t,
defined_tags json_element_t,
system_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_recovery_protected_database_summary_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_recovery_protected_database_summary_t (
id varchar2,
display_name varchar2,
compartment_id varchar2,
db_unique_name varchar2,
vpc_user_name varchar2,
database_size varchar2,
protection_policy_id varchar2,
recovery_service_subnets dbms_cloud_oci_recovery_recovery_service_subnet_details_tbl,
database_id varchar2,
time_created timestamp with time zone,
time_updated timestamp with time zone,
lifecycle_state varchar2,
health varchar2,
lifecycle_details varchar2,
health_details varchar2,
is_read_only_resource number,
metrics dbms_cloud_oci_recovery_metrics_summary_t,
freeform_tags json_element_t,
defined_tags json_element_t,
system_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The OCID of the protected database. |
|
|
(optional) The protected database name. You can change the displayName. Avoid entering confidential information. |
|
|
(required) The OCID of the compartment that contains the protected database. |
|
|
(required) The dbUniqueName for the protected database in Recovery Service. You cannot change the unique name. |
|
|
(required) The virtual private catalog (VPC) user credentials that authenticates the protected database to access Recovery Service. |
|
|
(required) The size of the protected database. XS - Less than 5GB, S - 5GB to 50GB, M - 50GB to 500GB, L - 500GB to 1TB, XL - 1TB to 5TB, XXL - Greater than 5TB. Allowed values are: 'XS', 'S', 'M', 'L', 'XL', 'XXL', 'AUTO' |
|
|
(required) The OCID of the protection policy associated with the protected database. |
|
|
(optional) List of recovery service subnet resources associated with the protected database. |
|
|
(optional) The OCID of the protected database. |
|
|
(optional) An RFC3339 formatted datetime string that indicates the created time for a protected database. For example: '2020-05-22T21:10:29.600Z' |
|
|
(optional) An RFC3339 formatted datetime string that indicates the last updated time for a protected database. For example: '2020-05-22T21:10:29.600Z' |
|
|
(optional) The current state of the Protected Database. Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'DELETING', 'DELETED', 'FAILED' |
|
|
(optional) The health of the Protected Database. Allowed values are: 'PROTECTED', 'WARNING', 'ALERT' |
|
|
(optional) Detailed description about the current lifecycle state of the protected database. For example, it can be used to provide actionable information for a resource in a Failed state. |
|
|
(optional) A message describing the current health of the protected database. |
|
|
(optional) Indicates whether the protected database is created by Recovery Service or created manually. Set to <b>TRUE</b> for a service-defined protected database. When you enable the OCI-managed automatic backups option for a database and set Recovery Service as the backup destination, then Recovery Service creates the associated protected database resource. Set to <b>FALSE</b> for a user-defined protected database. |
|
|
(optional) |
|
|
(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}` |
|
|
(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`. For more information, see Resource Tags |
|
|
(optional) Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`. For more information, see Resource Tags |
DBMS_CLOUD_OCI_RECOVERY_PROTECTED_DATABASE_SUMMARY_TBL Type
Nested table type of dbms_cloud_oci_recovery_protected_database_summary_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_recovery_protected_database_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_recovery_protected_database_summary_t) NOT PERSISTABLE;DBMS_CLOUD_OCI_RECOVERY_PROTECTED_DATABASE_COLLECTION_T Type
Results of a protected database search operation. The results contain protected database summary and metadata information.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_recovery_protected_database_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
items dbms_cloud_oci_recovery_protected_database_summary_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_recovery_protected_database_collection_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_recovery_protected_database_collection_t (
items dbms_cloud_oci_recovery_protected_database_summary_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) List of protected databases. |
DBMS_CLOUD_OCI_RECOVERY_PROTECTION_POLICY_T Type
The details of a protection policy.A policy defines the exact number of days to retain protected database backups created by Recovery Service. Each protected database must be associated with one protection policy. You can use Oracle-defined protection policies or create custom policies to suit your internal backup storage regulation demands.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_recovery_protection_policy_t FORCE AUTHID CURRENT_USER IS OBJECT (
id varchar2(32767),
display_name varchar2(32767),
compartment_id varchar2(32767),
backup_retention_period_in_days number,
is_predefined_policy number,
time_created timestamp with time zone,
time_updated timestamp with time zone,
lifecycle_state varchar2(32767),
lifecycle_details varchar2(32767),
freeform_tags json_element_t,
defined_tags json_element_t,
system_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_recovery_protection_policy_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_recovery_protection_policy_t (
id varchar2,
display_name varchar2,
compartment_id varchar2,
backup_retention_period_in_days number,
is_predefined_policy number,
time_created timestamp with time zone,
time_updated timestamp with time zone,
lifecycle_state varchar2,
lifecycle_details varchar2,
freeform_tags json_element_t,
defined_tags json_element_t,
system_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The protection policy OCID. |
|
|
(optional) A user provided name for the protection policy. |
|
|
(required) The OCID of the compartment that contains the protection policy. |
|
|
(required) The maximum number of days to retain backups for a protected database. Specify a period ranging from a minimum 14 days to a maximum 95 days. For example, specify the value 55 if you want to retain backups for 55 days. |
|
|
(required) Set to TRUE if the policy is Oracle-defined, and FALSE for a user-defined custom policy. You can modify only the custom policies. |
|
|
(optional) An RFC3339 formatted datetime string that indicates the created time for the protection policy. For example: '2020-05-22T21:10:29.600Z'. |
|
|
(optional) An RFC3339 formatted datetime string that indicates the updated time for the protection policy. For example: '2020-05-22T21:10:29.600Z'. |
|
|
(optional) The current state of the protection policy. Allowed values are: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'DELETING', 'DELETED', 'FAILED' |
|
|
(optional) Detailed description about the current lifecycle state of the protection policy. For example, it can be used to provide actionable information for a resource in a Failed state. |
|
|
(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}` |
|
|
(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`. For more information, see Resource Tags |
|
|
(optional) Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`. For more information, see Resource Tags |
DBMS_CLOUD_OCI_RECOVERY_PROTECTION_POLICY_SUMMARY_T Type
Recovery Service enables policy driven backup storage management. To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see Getting Started with Policies. For information about access control and compartments, see Overview of the Identity Service.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_recovery_protection_policy_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
id varchar2(32767),
display_name varchar2(32767),
compartment_id varchar2(32767),
backup_retention_period_in_days number,
is_predefined_policy number,
time_created timestamp with time zone,
time_updated timestamp with time zone,
lifecycle_state varchar2(32767),
lifecycle_details varchar2(32767),
freeform_tags json_element_t,
defined_tags json_element_t,
system_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_recovery_protection_policy_summary_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_recovery_protection_policy_summary_t (
id varchar2,
display_name varchar2,
compartment_id varchar2,
backup_retention_period_in_days number,
is_predefined_policy number,
time_created timestamp with time zone,
time_updated timestamp with time zone,
lifecycle_state varchar2,
lifecycle_details varchar2,
freeform_tags json_element_t,
defined_tags json_element_t,
system_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The protection policy OCID. |
|
|
(optional) A user provided name for the protection policy. |
|
|
(required) The OCID of the compartment that contains the protection policy. |
|
|
(required) The maximum number of days to retain backups for a protected database. |
|
|
(required) Set to TRUE if the policy is Oracle-defined, and FALSE for a user-defined custom policy. You can modify only the custom policies. |
|
|
(optional) The time the Protection Policy was created. An RFC3339 formatted datetime string |
|
|
(optional) The time the Protection Policy was updated. An RFC3339 formatted datetime string |
|
|
(optional) The current state of the Protection Policy. Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'DELETING', 'DELETED', 'FAILED' |
|
|
(optional) Detailed description about the current lifecycle state of the protection policy. For example, it can be used to provide actionable information for a resource in a Failed state. |
|
|
(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}` |
|
|
(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`. For more information, see Resource Tags |
|
|
(optional) Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`. For more information, see Resource Tags |
DBMS_CLOUD_OCI_RECOVERY_PROTECTION_POLICY_SUMMARY_TBL Type
Nested table type of dbms_cloud_oci_recovery_protection_policy_summary_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_recovery_protection_policy_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_recovery_protection_policy_summary_t) NOT PERSISTABLE;DBMS_CLOUD_OCI_RECOVERY_PROTECTION_POLICY_COLLECTION_T Type
Results of a Protection Policy search. Contains both Protection Policy Summary items and other information, such as metadata.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_recovery_protection_policy_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
items dbms_cloud_oci_recovery_protection_policy_summary_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_recovery_protection_policy_collection_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_recovery_protection_policy_collection_t (
items dbms_cloud_oci_recovery_protection_policy_summary_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) List of ProtectionPolicies. |
DBMS_CLOUD_OCI_RECOVERY_RECOVERY_SERVICE_SUBNET_T Type
The details of a recovery service subnet. Recovery service subnets allows Recovery Service to access protected databases in each VCN. Each recovery service subnet uses a single private endpoint on a subnet of your choice within a VCN. The private endpoint need not be on the same subnet as the Oracle Cloud Database, although, it must be on a subnet that can communicate with the Oracle Cloud Database.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_recovery_recovery_service_subnet_t FORCE AUTHID CURRENT_USER IS OBJECT (
id varchar2(32767),
display_name varchar2(32767),
compartment_id varchar2(32767),
vcn_id varchar2(32767),
subnet_id varchar2(32767),
time_created timestamp with time zone,
time_updated timestamp with time zone,
lifecycle_state varchar2(32767),
lifecycle_details varchar2(32767),
freeform_tags json_element_t,
defined_tags json_element_t,
system_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_recovery_recovery_service_subnet_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_recovery_recovery_service_subnet_t (
id varchar2,
display_name varchar2,
compartment_id varchar2,
vcn_id varchar2,
subnet_id varchar2,
time_created timestamp with time zone,
time_updated timestamp with time zone,
lifecycle_state varchar2,
lifecycle_details varchar2,
freeform_tags json_element_t,
defined_tags json_element_t,
system_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The recovery service subnet OCID. |
|
|
(optional) A user-provided name for the recovery service subnet. |
|
|
(required) The compartment OCID. |
|
|
(required) VCN Identifier. |
|
|
(required) The OCID of the subnet used as the recovery service subnet. |
|
|
(optional) An RFC3339 formatted datetime string that indicates the last created time for a recovery service subnet. For example: '2020-05-22T21:10:29.600Z'. |
|
|
(optional) An RFC3339 formatted datetime string that indicates the last updated time for a recovery service subnet. For example: '2020-05-22T21:10:29.600Z'. |
|
|
(optional) The current state of the recovery service subnet. Allowed values are: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'DELETING', 'DELETED', 'FAILED' |
|
|
(optional) Detailed description about the current lifecycle state of the recovery service subnet. For example, it can be used to provide actionable information for a resource in a Failed state |
|
|
(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}` |
|
|
(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`. For more information, see Resource Tags |
|
|
(optional) Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`. For more information, see Resource Tags |
DBMS_CLOUD_OCI_RECOVERY_RECOVERY_SERVICE_SUBNET_SUMMARY_T Type
Each Recovery Service subnet uses a single private endpoint on a subnet of your choice within a VCN. The private endpoint need not be on the same subnet as the Oracle Cloud Database, although, it must be on a subnet that can communicate with the Oracle Cloud Database. To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see Getting Started with Policies. For information about access control and compartments, see Overview of the Identity Service.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_recovery_recovery_service_subnet_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
id varchar2(32767),
display_name varchar2(32767),
compartment_id varchar2(32767),
vcn_id varchar2(32767),
subnet_id varchar2(32767),
time_created timestamp with time zone,
time_updated timestamp with time zone,
lifecycle_state varchar2(32767),
lifecycle_details varchar2(32767),
freeform_tags json_element_t,
defined_tags json_element_t,
system_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_recovery_recovery_service_subnet_summary_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_recovery_recovery_service_subnet_summary_t (
id varchar2,
display_name varchar2,
compartment_id varchar2,
vcn_id varchar2,
subnet_id varchar2,
time_created timestamp with time zone,
time_updated timestamp with time zone,
lifecycle_state varchar2,
lifecycle_details varchar2,
freeform_tags json_element_t,
defined_tags json_element_t,
system_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The recovery service subnet OCID. |
|
|
(optional) A user-provided name for the recovery service subnet. |
|
|
(required) The compartment OCID. |
|
|
(required) The OCID of the virtual cloud network (VCN) associated with the recovery service subnet. You can create a single recovery service subnet per VCN. |
|
|
(required) The OCID of the subnet associated with the recovery service subnet. You can create a single backup network per virtual cloud network (VCN). |
|
|
(optional) An RFC3339 formatted datetime string that indicates the last created time for a recovery service subnet. For example: '2020-05-22T21:10:29.600Z'. |
|
|
(optional) An RFC3339 formatted datetime string that indicates the last updated time for a recovery service subnet. For example: '2020-05-22T21:10:29.600Z'. |
|
|
(optional) The current state of the recovery service subnet. Allowed values are: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'DELETING', 'DELETED', 'FAILED' |
|
|
(optional) Detailed description about the current lifecycle state of the recovery service subnet. For example, it can be used to provide actionable information for a resource in a Failed state |
|
|
(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}` |
|
|
(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`. For more information, see Resource Tags |
|
|
(optional) Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`. For more information, see Resource Tags |
DBMS_CLOUD_OCI_RECOVERY_RECOVERY_SERVICE_SUBNET_SUMMARY_TBL Type
Nested table type of dbms_cloud_oci_recovery_recovery_service_subnet_summary_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_recovery_recovery_service_subnet_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_recovery_recovery_service_subnet_summary_t) NOT PERSISTABLE;DBMS_CLOUD_OCI_RECOVERY_RECOVERY_SERVICE_SUBNET_COLLECTION_T Type
Results of a recovery service subnet search operation. The results contain recovery service subnet summary and metadata information.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_recovery_recovery_service_subnet_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
items dbms_cloud_oci_recovery_recovery_service_subnet_summary_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_recovery_recovery_service_subnet_collection_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_recovery_recovery_service_subnet_collection_t (
items dbms_cloud_oci_recovery_recovery_service_subnet_summary_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) List of recovery service subnet resources. |
DBMS_CLOUD_OCI_RECOVERY_UPDATE_PROTECTED_DATABASE_DETAILS_T Type
Describes the parameters required to update a protected database.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_recovery_update_protected_database_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
display_name varchar2(32767),
database_size varchar2(32767),
database_size_in_g_bs number,
password varchar2(32767),
protection_policy_id varchar2(32767),
recovery_service_subnets dbms_cloud_oci_recovery_recovery_service_subnet_input_tbl,
is_redo_logs_shipped number,
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_recovery_update_protected_database_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_recovery_update_protected_database_details_t (
display_name varchar2,
database_size varchar2,
database_size_in_g_bs number,
password varchar2,
protection_policy_id varchar2,
recovery_service_subnets dbms_cloud_oci_recovery_recovery_service_subnet_input_tbl,
is_redo_logs_shipped number,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(optional) The protected database name. You can change the displayName. Avoid entering confidential information. |
|
|
(optional) The size of the database is allowed to be decreased. XS - Less than 5GB, S - 5GB to 50GB, M - 50GB to 500GB, L - 500GB to 1TB, XL - 1TB to 5TB, XXL - Greater than 5TB. Allowed values are: 'XS', 'S', 'M', 'L', 'XL', 'XXL', 'AUTO' |
|
|
(optional) The size of the database, in gigabytes. |
|
|
(optional) Password credential which can be used to connect to Protected Database. It must contain at least 2 uppercase, 2 lowercase, 2 numeric and 2 special characters. The special characters must be underscore (_), number sign (#) or hyphen (-). The password must not contain the username \"admin\", regardless of casing. Password must not be same as current passsword. |
|
|
(optional) The OCID of the protection policy associated with the protected database. |
|
|
(optional) List of recovery service subnet resources associated with the protected database. |
|
|
(optional) The value TRUE indicates that the protected database is configured to use Real-time data protection, and redo-data is sent from the protected database to Recovery Service. Real-time data protection substantially reduces the window of potential data loss that exists between successive archived redo log backups. For this to be effective, additional configuration is needed on client side. |
|
|
(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}` |
|
|
(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`. For more information, see Resource Tags |
DBMS_CLOUD_OCI_RECOVERY_UPDATE_PROTECTION_POLICY_DETAILS_T Type
The information to be updated.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_recovery_update_protection_policy_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
display_name varchar2(32767),
backup_retention_period_in_days number,
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_recovery_update_protection_policy_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_recovery_update_protection_policy_details_t (
display_name varchar2,
backup_retention_period_in_days number,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(optional) A user provided name for the protection policy. The 'displayName' does not have to be unique, and it can be modified. Avoid entering confidential information. |
|
|
(optional) The maximum number of days to retain backups for a protected database. |
|
|
(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}` |
|
|
(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`. For more information, see Resource Tags |
DBMS_CLOUD_OCI_RECOVERY_UPDATE_RECOVERY_SERVICE_SUBNET_DETAILS_T Type
Describes the parameters required to update a recovery service subnet.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_recovery_update_recovery_service_subnet_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
display_name varchar2(32767),
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_recovery_update_recovery_service_subnet_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_recovery_update_recovery_service_subnet_details_t (
display_name varchar2,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(optional) A user-provided name for the recovery service subnet. The 'displayName' does not have to be unique, and it can be modified. Avoid entering confidential information. |
|
|
(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}` |
|
|
(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`. For more information, see Resource Tags |
DBMS_CLOUD_OCI_RECOVERY_WORK_REQUEST_RESOURCE_T Type
A resource created or operated on by a work request.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_recovery_work_request_resource_t FORCE AUTHID CURRENT_USER IS OBJECT (
entity_type varchar2(32767),
action_type varchar2(32767),
identifier varchar2(32767),
entity_uri varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_recovery_work_request_resource_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_recovery_work_request_resource_t (
entity_type varchar2,
action_type varchar2,
identifier varchar2,
entity_uri varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The resource type the work request affects. |
|
|
(required) The way in which this resource is affected by the work tracked in the work request. A resource being created, updated, or deleted will remain in the IN_PROGRESS state until work is complete for that resource at which point it will transition to CREATED, UPDATED, or DELETED, respectively. Allowed values are: 'CREATED', 'UPDATED', 'DELETED', 'IN_PROGRESS', 'RELATED', 'FAILED' |
|
|
(required) The identifier of the resource the work request affects. |
|
|
(optional) The URI path that the user can do a GET on to access the resource metadata |
DBMS_CLOUD_OCI_RECOVERY_WORK_REQUEST_RESOURCE_TBL Type
Nested table type of dbms_cloud_oci_recovery_work_request_resource_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_recovery_work_request_resource_tbl FORCE IS TABLE OF (dbms_cloud_oci_recovery_work_request_resource_t) NOT PERSISTABLE;DBMS_CLOUD_OCI_RECOVERY_WORK_REQUEST_T Type
A description of workrequest status
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_recovery_work_request_t FORCE AUTHID CURRENT_USER IS OBJECT (
operation_type varchar2(32767),
status varchar2(32767),
id varchar2(32767),
compartment_id varchar2(32767),
resources dbms_cloud_oci_recovery_work_request_resource_tbl,
percent_complete number,
time_accepted timestamp with time zone,
time_started timestamp with time zone,
time_finished timestamp with time zone,
CONSTRUCTOR FUNCTION dbms_cloud_oci_recovery_work_request_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_recovery_work_request_t (
operation_type varchar2,
status varchar2,
id varchar2,
compartment_id varchar2,
resources dbms_cloud_oci_recovery_work_request_resource_tbl,
percent_complete number,
time_accepted timestamp with time zone,
time_started timestamp with time zone,
time_finished timestamp with time zone
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) Type of the work request Allowed values are: 'CREATE_PROTECTED_DATABASE', 'UPDATE_PROTECTED_DATABASE', 'DELETE_PROTECTED_DATABASE', 'MOVE_PROTECTED_DATABASE', 'CREATE_PROTECTION_POLICY', 'UPDATE_PROTECTION_POLICY', 'DELETE_PROTECTION_POLICY', 'MOVE_PROTECTION_POLICY', 'CREATE_RECOVERY_SERVICE_SUBNET', 'UPDATE_RECOVERY_SERVICE_SUBNET', 'DELETE_RECOVERY_SERVICE_SUBNET', 'MOVE_RECOVERY_SERVICE_SUBNET' |
|
|
(required) Status of current work request. Allowed values are: 'ACCEPTED', 'IN_PROGRESS', 'FAILED', 'SUCCEEDED', 'CANCELING', 'CANCELED' |
|
|
(required) The id of the work request. |
|
|
(required) The ocid of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request affects multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used |
|
|
(required) The resources affected by this work request. |
|
|
(required) Percentage of the request completed. |
|
|
(required) The date and time the request was created, as described in RFC 3339, section 14.29. |
|
|
(optional) The date and time the request was started, as described in RFC 3339, section 14.29. |
|
|
(optional) The date and time the work request reached a terminal state, either FAILED or SUCCEEDED, as described in RFC 3339. |
DBMS_CLOUD_OCI_RECOVERY_WORK_REQUEST_ERROR_T Type
An error encountered while executing a work request.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_recovery_work_request_error_t FORCE AUTHID CURRENT_USER IS OBJECT (
code varchar2(32767),
message varchar2(32767),
l_timestamp timestamp with time zone,
CONSTRUCTOR FUNCTION dbms_cloud_oci_recovery_work_request_error_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_recovery_work_request_error_t (
code varchar2,
message varchar2,
l_timestamp timestamp with time zone
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) A machine-usable code for the error that occured. Error codes are listed on (https://docs.cloud.oracle.com/Content/API/References/apierrors.htm) |
|
|
(required) A human readable description of the issue encountered. |
|
|
(required) The time the error occured. An RFC3339 formatted datetime string. |
DBMS_CLOUD_OCI_RECOVERY_WORK_REQUEST_ERROR_TBL Type
Nested table type of dbms_cloud_oci_recovery_work_request_error_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_recovery_work_request_error_tbl FORCE IS TABLE OF (dbms_cloud_oci_recovery_work_request_error_t) NOT PERSISTABLE;DBMS_CLOUD_OCI_RECOVERY_WORK_REQUEST_ERROR_COLLECTION_T Type
Results of a workRequestError search. Contains both WorkRequestError items and other information, such as metadata.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_recovery_work_request_error_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
items dbms_cloud_oci_recovery_work_request_error_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_recovery_work_request_error_collection_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_recovery_work_request_error_collection_t (
items dbms_cloud_oci_recovery_work_request_error_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) List of workRequestError objects. |
DBMS_CLOUD_OCI_RECOVERY_WORK_REQUEST_LOG_ENTRY_T Type
A log message from the execution of a work request.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_recovery_work_request_log_entry_t FORCE AUTHID CURRENT_USER IS OBJECT (
message varchar2(32767),
l_timestamp timestamp with time zone,
CONSTRUCTOR FUNCTION dbms_cloud_oci_recovery_work_request_log_entry_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_recovery_work_request_log_entry_t (
message varchar2,
l_timestamp timestamp with time zone
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) Human-readable log message. |
|
|
(required) The time the log message was written. An RFC3339 formatted datetime string |
DBMS_CLOUD_OCI_RECOVERY_WORK_REQUEST_LOG_ENTRY_TBL Type
Nested table type of dbms_cloud_oci_recovery_work_request_log_entry_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_recovery_work_request_log_entry_tbl FORCE IS TABLE OF (dbms_cloud_oci_recovery_work_request_log_entry_t) NOT PERSISTABLE;DBMS_CLOUD_OCI_RECOVERY_WORK_REQUEST_LOG_ENTRY_COLLECTION_T Type
Results of a workRequestLog search. Contains both workRequestLog items and other information, such as metadata.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_recovery_work_request_log_entry_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
items dbms_cloud_oci_recovery_work_request_log_entry_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_recovery_work_request_log_entry_collection_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_recovery_work_request_log_entry_collection_t (
items dbms_cloud_oci_recovery_work_request_log_entry_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) List of workRequestLogEntries. |
DBMS_CLOUD_OCI_RECOVERY_WORK_REQUEST_SUMMARY_T Type
A summary of the status of a work request.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_recovery_work_request_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
operation_type varchar2(32767),
status varchar2(32767),
id varchar2(32767),
compartment_id varchar2(32767),
resources dbms_cloud_oci_recovery_work_request_resource_tbl,
percent_complete number,
time_accepted timestamp with time zone,
time_started timestamp with time zone,
time_finished timestamp with time zone,
CONSTRUCTOR FUNCTION dbms_cloud_oci_recovery_work_request_summary_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_recovery_work_request_summary_t (
operation_type varchar2,
status varchar2,
id varchar2,
compartment_id varchar2,
resources dbms_cloud_oci_recovery_work_request_resource_tbl,
percent_complete number,
time_accepted timestamp with time zone,
time_started timestamp with time zone,
time_finished timestamp with time zone
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) Type of the work request Allowed values are: 'CREATE_PROTECTED_DATABASE', 'UPDATE_PROTECTED_DATABASE', 'DELETE_PROTECTED_DATABASE', 'MOVE_PROTECTED_DATABASE', 'CREATE_PROTECTION_POLICY', 'UPDATE_PROTECTION_POLICY', 'DELETE_PROTECTION_POLICY', 'MOVE_PROTECTION_POLICY', 'CREATE_RECOVERY_SERVICE_SUBNET', 'UPDATE_RECOVERY_SERVICE_SUBNET', 'DELETE_RECOVERY_SERVICE_SUBNET', 'MOVE_RECOVERY_SERVICE_SUBNET' |
|
|
(required) The status of the current work request. Allowed values are: 'ACCEPTED', 'IN_PROGRESS', 'FAILED', 'SUCCEEDED', 'CANCELING', 'CANCELED' |
|
|
(required) The ID of the work request. |
|
|
(required) The ocid of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request affects multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used. |
|
|
(required) The resources affected by this work request. |
|
|
(required) The completed percentage of the operation tracked by the work request. |
|
|
(required) The date and time the request was accepted, as described in RFC 3339, section 14.29. The precision for this time object is in milliseconds. |
|
|
(optional) The date and time the work request transitioned from ACCEPTED to IN_PROGRESS, as described in RFC 3339, section 14.29. The precision for this time object is in milliseconds. |
|
|
(optional) The date and time the work request reached a terminal state, either FAILED or SUCCEEDED, as described in RFC 3339, section 14.29. The precision for this time object is in milliseconds. |
DBMS_CLOUD_OCI_RECOVERY_WORK_REQUEST_SUMMARY_TBL Type
Nested table type of dbms_cloud_oci_recovery_work_request_summary_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_recovery_work_request_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_recovery_work_request_summary_t) NOT PERSISTABLE;DBMS_CLOUD_OCI_RECOVERY_WORK_REQUEST_SUMMARY_COLLECTION_T Type
Results of a workRequest search. Contains both WorkRequest items and other information, such as metadata.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_recovery_work_request_summary_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
items dbms_cloud_oci_recovery_work_request_summary_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_recovery_work_request_summary_collection_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_recovery_work_request_summary_collection_t (
items dbms_cloud_oci_recovery_work_request_summary_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) List of workRequestSummary objects. |