oracle.oci.oci_database_autonomous_database_clones_facts – Fetches details about one or multiple AutonomousDatabaseClones resources in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 4.14.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install oracle.oci.

To use it in a playbook, specify: oracle.oci.oci_database_autonomous_database_clones_facts.

New in version 2.9.0: of oracle.oci

Synopsis

  • Fetches details about one or multiple AutonomousDatabaseClones resources in Oracle Cloud Infrastructure

  • Lists the Autonomous Database clones for the specified Autonomous Database.

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter Choices/Defaults Comments
api_user
string
The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_ID environment variable, if any, is used. This option is required if the user is not specified through a configuration file (See config_file_location). To get the user's OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_fingerprint
string
Fingerprint for the key pair being used. If not set, then the value of the OCI_USER_FINGERPRINT environment variable, if any, is used. This option is required if the key fingerprint is not specified through a configuration file (See config_file_location). To get the key pair's fingerprint value please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_key_file
string
Full path and filename of the private key (in PEM format). If not set, then the value of the OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is not specified through a configuration file (See config_file_location). If the key is encrypted with a pass-phrase, the api_user_key_pass_phrase option must also be provided.
api_user_key_pass_phrase
string
Passphrase used by the key referenced in api_user_key_file, if it is encrypted. If not set, then the value of the OCI_USER_KEY_PASS_PHRASE variable, if any, is used. This option is required if the key passphrase is not specified through a configuration file (See config_file_location).
auth_purpose
string
    Choices:
  • service_principal
The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None.
auth_type
string
    Choices:
  • api_key ←
  • instance_principal
  • instance_obo_user
  • resource_principal
The type of authentication to use for making API requests. By default auth_type="api_key" based authentication is performed and the API key (see api_user_key_file) in your config file will be used. If this 'auth_type' module option is not specified, the value of the OCI_ANSIBLE_AUTH_TYPE, if any, is used. Use auth_type="instance_principal" to use instance principal based authentication when running ansible playbooks within an OCI compute instance.
autonomous_database_id
string / required
The database OCID.
cert_bundle
string
The full path to a CA certificate bundle to be used for SSL verification. This will override the default CA certificate bundle. If not set, then the value of the OCI_ANSIBLE_CERT_BUNDLE variable, if any, is used.
clone_type
string
    Choices:
  • REFRESHABLE_CLONE
A filter to return only resources that match the given clone type exactly.
compartment_id
string / required
The compartment OCID.
config_file_location
string
Path to configuration file. If not set then the value of the OCI_CONFIG_FILE environment variable, if any, is used. Otherwise, defaults to ~/.oci/config.
config_profile_name
string
The profile to load from the config file referenced by config_file_location. If not set, then the value of the OCI_CONFIG_PROFILE environment variable, if any, is used. Otherwise, defaults to the "DEFAULT" profile in config_file_location.
display_name
string
A filter to return only resources that match the entire display name given. The match is not case sensitive.

aliases: name
lifecycle_state
string
    Choices:
  • PROVISIONING
  • AVAILABLE
  • STOPPING
  • STOPPED
  • STARTING
  • TERMINATING
  • TERMINATED
  • UNAVAILABLE
  • RESTORE_IN_PROGRESS
  • RESTORE_FAILED
  • BACKUP_IN_PROGRESS
  • SCALE_IN_PROGRESS
  • AVAILABLE_NEEDS_ATTENTION
  • UPDATING
  • MAINTENANCE_IN_PROGRESS
  • RESTARTING
  • RECREATING
  • ROLE_CHANGE_IN_PROGRESS
  • UPGRADING
  • INACCESSIBLE
  • STANDBY
A filter to return only resources that match the given lifecycle state exactly.
region
string
The Oracle Cloud Infrastructure region to use for all OCI API requests. If not set, then the value of the OCI_REGION variable, if any, is used. This option is required if the region is not specified through a configuration file (See config_file_location). Please refer to https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm for more information on OCI regions.
sort_by
string
    Choices:
  • NONE
  • TIMECREATED
  • DISPLAYNAME
The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.
**Note:** If you do not include the availability domain filter, the resources are grouped by availability domain, then sorted.
sort_order
string
    Choices:
  • ASC
  • DESC
The sort order to use, either ascending (`ASC`) or descending (`DESC`).
tenancy
string
OCID of your tenancy. If not set, then the value of the OCI_TENANCY variable, if any, is used. This option is required if the tenancy OCID is not specified through a configuration file (See config_file_location). To get the tenancy OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm

Examples

- name: List autonomous_database_clones
  oci_database_autonomous_database_clones_facts:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    autonomous_database_id: "ocid1.autonomousdatabase.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    sort_order: ASC
    display_name: display_name_example
    lifecycle_state: PROVISIONING
    sort_by: NONE
    clone_type: REFRESHABLE_CLONE

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
autonomous_database_clones
complex
on success
List of AutonomousDatabaseClones resources

Sample:
[{'actual_used_data_storage_size_in_tbs': 1.2, 'allocated_storage_size_in_tbs': 1.2, 'apex_details': {'apex_version': 'apex_version_example', 'ords_version': 'ords_version_example'}, 'are_primary_whitelisted_ips_used': True, 'autonomous_container_database_id': 'ocid1.autonomouscontainerdatabase.oc1..xxxxxxEXAMPLExxxxxx', 'autonomous_maintenance_schedule_type': 'EARLY', 'available_upgrade_versions': [], 'backup_config': {'manual_backup_bucket_name': 'manual_backup_bucket_name_example', 'manual_backup_type': 'NONE'}, 'backup_retention_period_in_days': 56, 'character_set': 'character_set_example', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'compute_count': 3.4, 'compute_model': 'ECPU', 'connection_strings': {'all_connection_strings': {}, 'dedicated': 'dedicated_example', 'high': 'high_example', 'low': 'low_example', 'medium': 'medium_example', 'profiles': [{'consumer_group': 'HIGH', 'display_name': 'display_name_example', 'host_format': 'FQDN', 'protocol': 'TCP', 'session_mode': 'DIRECT', 'syntax_format': 'LONG', 'tls_authentication': 'SERVER', 'value': 'value_example'}]}, 'connection_urls': {'apex_url': 'apex_url_example', 'database_transforms_url': 'database_transforms_url_example', 'graph_studio_url': 'graph_studio_url_example', 'machine_learning_notebook_url': 'machine_learning_notebook_url_example', 'machine_learning_user_management_url': 'machine_learning_user_management_url_example', 'mongo_db_url': 'mongo_db_url_example', 'ords_url': 'ords_url_example', 'sql_dev_web_url': 'sql_dev_web_url_example'}, 'cpu_core_count': 56, 'customer_contacts': [{'email': 'email_example'}], 'data_safe_status': 'REGISTERING', 'data_storage_size_in_gbs': 56, 'data_storage_size_in_tbs': 56, 'database_edition': 'STANDARD_EDITION', 'database_management_status': 'ENABLING', 'dataguard_region_type': 'PRIMARY_DG_REGION', 'db_name': 'db_name_example', 'db_tools_details': [{'compute_count': 3.4, 'is_enabled': True, 'max_idle_time_in_minutes': 56, 'name': 'APEX'}], 'db_version': 'db_version_example', 'db_workload': 'OLTP', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'failed_data_recovery_in_seconds': 56, 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'infrastructure_type': 'CLOUD', 'is_access_control_enabled': True, 'is_auto_scaling_enabled': True, 'is_auto_scaling_for_storage_enabled': True, 'is_data_guard_enabled': True, 'is_dedicated': True, 'is_free_tier': True, 'is_local_data_guard_enabled': True, 'is_mtls_connection_required': True, 'is_preview': True, 'is_reconnect_clone_enabled': True, 'is_refreshable_clone': True, 'is_remote_data_guard_enabled': True, 'key_history_entry': [{'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'kms_key_version_id': 'ocid1.kmskeyversion.oc1..xxxxxxEXAMPLExxxxxx', 'time_activated': '2013-10-20T19:20:30+01:00', 'vault_id': 'ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx'}], 'key_store_id': 'ocid1.keystore.oc1..xxxxxxEXAMPLExxxxxx', 'key_store_wallet_name': 'key_store_wallet_name_example', 'kms_key_id': 'ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx', 'kms_key_lifecycle_details': 'kms_key_lifecycle_details_example', 'kms_key_version_id': 'ocid1.kmskeyversion.oc1..xxxxxxEXAMPLExxxxxx', 'license_model': 'LICENSE_INCLUDED', 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'PROVISIONING', 'local_standby_db': {'lag_time_in_seconds': 56, 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'PROVISIONING', 'time_data_guard_role_changed': '2013-10-20T19:20:30+01:00'}, 'max_cpu_core_count': 56, 'memory_per_oracle_compute_unit_in_gbs': 56, 'ncharacter_set': 'ncharacter_set_example', 'nsg_ids': [], 'ocpu_count': 3.4, 'open_mode': 'READ_ONLY', 'operations_insights_status': 'ENABLING', 'peer_db_ids': [], 'permission_level': 'RESTRICTED', 'private_endpoint': 'private_endpoint_example', 'private_endpoint_ip': 'private_endpoint_ip_example', 'private_endpoint_label': 'private_endpoint_label_example', 'provisionable_cpus': [], 'refreshable_mode': 'AUTOMATIC', 'refreshable_status': 'REFRESHING', 'role': 'PRIMARY', 'scheduled_operations': [{'day_of_week': {'name': 'MONDAY'}, 'scheduled_start_time': 'scheduled_start_time_example', 'scheduled_stop_time': 'scheduled_stop_time_example'}], 'service_console_url': 'service_console_url_example', 'source_id': 'ocid1.source.oc1..xxxxxxEXAMPLExxxxxx', 'standby_db': {'lag_time_in_seconds': 56, 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'PROVISIONING', 'time_data_guard_role_changed': '2013-10-20T19:20:30+01:00'}, 'standby_whitelisted_ips': [], 'subnet_id': 'ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx', 'supported_regions_to_clone_to': [], 'system_tags': {}, 'time_created': '2013-10-20T19:20:30+01:00', 'time_data_guard_role_changed': '2013-10-20T19:20:30+01:00', 'time_deletion_of_free_autonomous_database': '2013-10-20T19:20:30+01:00', 'time_local_data_guard_enabled': '2013-10-20T19:20:30+01:00', 'time_maintenance_begin': '2013-10-20T19:20:30+01:00', 'time_maintenance_end': '2013-10-20T19:20:30+01:00', 'time_of_last_failover': '2013-10-20T19:20:30+01:00', 'time_of_last_refresh': '2013-10-20T19:20:30+01:00', 'time_of_last_refresh_point': '2013-10-20T19:20:30+01:00', 'time_of_last_switchover': '2013-10-20T19:20:30+01:00', 'time_of_next_refresh': '2013-10-20T19:20:30+01:00', 'time_reclamation_of_free_autonomous_database': '2013-10-20T19:20:30+01:00', 'time_until_reconnect_clone_enabled': '2013-10-20T19:20:30+01:00', 'total_backup_storage_size_in_gbs': 1.2, 'used_data_storage_size_in_tbs': 56, 'vault_id': 'ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx', 'whitelisted_ips': []}]
 
actual_used_data_storage_size_in_tbs
float
on success
The current amount of storage in use for user and system data, in terabytes (TB).

Sample:
1.2
 
allocated_storage_size_in_tbs
float
on success
The amount of storage currently allocated for the database tables and billed for, rounded up. When auto-scaling is not enabled, this value is equal to the `dataStorageSizeInTBs` value. You can compare this value to the `actualUsedDataStorageSizeInTBs` value to determine if a manual shrink operation is appropriate for your allocated storage.
**Note:** Auto-scaling does not automatically decrease allocated storage when data is deleted from the database.

Sample:
1.2
 
apex_details
complex
on success
Information about Oracle APEX Application Development.

   
apex_version
string
on success
The Oracle APEX Application Development version.

Sample:
apex_version_example
   
ords_version
string
on success
The Oracle REST Data Services (ORDS) version.

Sample:
ords_version_example
 
are_primary_whitelisted_ips_used
boolean
on success
This field will be null if the Autonomous Database is not Data Guard enabled or Access Control is disabled. It's value would be `TRUE` if Autonomous Database is Data Guard enabled and Access Control is enabled and if the Autonomous Database uses primary IP access control list (ACL) for standby. It's value would be `FALSE` if Autonomous Database is Data Guard enabled and Access Control is enabled and if the Autonomous Database uses different IP access control list (ACL) for standby compared to primary.

Sample:
True
 
autonomous_container_database_id
string
on success
The Autonomous Container Database OCID.

Sample:
ocid1.autonomouscontainerdatabase.oc1..xxxxxxEXAMPLExxxxxx
 
autonomous_maintenance_schedule_type
string
on success
The maintenance schedule type of the Autonomous Database on shared Exadata infrastructure. The EARLY maintenance schedule of this Autonomous Database follows a schedule that applies patches prior to the REGULAR schedule.The REGULAR maintenance schedule of this Autonomous Database follows the normal cycle.

Sample:
EARLY
 
available_upgrade_versions
list / elements=string
on success
List of Oracle Database versions available for a database upgrade. If there are no version upgrades available, this list is empty.

 
backup_config
complex
on success

   
manual_backup_bucket_name
string
on success
Name of Object Storage bucket to use for storing manual backups.

Sample:
manual_backup_bucket_name_example
   
manual_backup_type
string
on success
The manual backup destination type.

Sample:
NONE
 
backup_retention_period_in_days
integer
on success
Retention period, in days, for backups.

Sample:
56
 
character_set
string
on success
The character set for the autonomous database. The default is AL32UTF8. Allowed values are:
AL32UTF8, AR8ADOS710, AR8ADOS720, AR8APTEC715, AR8ARABICMACS, AR8ASMO8X, AR8ISO8859P6, AR8MSWIN1256, AR8MUSSAD768, AR8NAFITHA711, AR8NAFITHA721, AR8SAKHR706, AR8SAKHR707, AZ8ISO8859P9E, BG8MSWIN, BG8PC437S, BLT8CP921, BLT8ISO8859P13, BLT8MSWIN1257, BLT8PC775, BN8BSCII, CDN8PC863, CEL8ISO8859P14, CL8ISO8859P5, CL8ISOIR111, CL8KOI8R, CL8KOI8U, CL8MACCYRILLICS, CL8MSWIN1251, EE8ISO8859P2, EE8MACCES, EE8MACCROATIANS, EE8MSWIN1250, EE8PC852, EL8DEC, EL8ISO8859P7, EL8MACGREEKS, EL8MSWIN1253, EL8PC437S, EL8PC851, EL8PC869, ET8MSWIN923, HU8ABMOD, HU8CWI2, IN8ISCII, IS8PC861, IW8ISO8859P8, IW8MACHEBREWS, IW8MSWIN1255, IW8PC1507, JA16EUC, JA16EUCTILDE, JA16SJIS, JA16SJISTILDE, JA16VMS, KO16KSC5601, KO16KSCCS, KO16MSWIN949, LA8ISO6937, LA8PASSPORT, LT8MSWIN921, LT8PC772, LT8PC774, LV8PC1117, LV8PC8LR, LV8RST104090, N8PC865, NE8ISO8859P10, NEE8ISO8859P4, RU8BESTA, RU8PC855, RU8PC866, SE8ISO8859P3, TH8MACTHAIS, TH8TISASCII, TR8DEC, TR8MACTURKISHS, TR8MSWIN1254, TR8PC857, US7ASCII, US8PC437, UTF8, VN8MSWIN1258, VN8VN3, WE8DEC, WE8DG, WE8ISO8859P1, WE8ISO8859P15, WE8ISO8859P9, WE8MACROMAN8S, WE8MSWIN1252, WE8NCR4970, WE8NEXTSTEP, WE8PC850, WE8PC858, WE8PC860, WE8ROMAN8, ZHS16CGB231280, ZHS16GBK, ZHT16BIG5, ZHT16CCDC, ZHT16DBT, ZHT16HKSCS, ZHT16MSWIN950, ZHT32EUC, ZHT32SOPS, ZHT32TRIS

Sample:
character_set_example
 
compartment_id
string
on success
The OCID of the compartment.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
compute_count
float
on success
The compute amount available to the database. Minimum and maximum values depend on the compute model and whether the database is on Shared or Dedicated infrastructure. For an Autonomous Database on Shared infrastructure, the 'ECPU' compute model requires values in multiples of two. Required when using the `computeModel` parameter. When using `cpuCoreCount` parameter, it is an error to specify computeCount to a non-null value.

Sample:
3.4
 
compute_model
string
on success
The compute model of the Autonomous Database. This is required if using the `computeCount` parameter. If using `cpuCoreCount` then it is an error to specify `computeModel` to a non-null value.

Sample:
ECPU
 
connection_strings
complex
on success
The connection string used to connect to the Autonomous Database. The username for the Service Console is ADMIN. Use the password you entered when creating the Autonomous Database for the password value.

   
all_connection_strings
dictionary
on success
Returns all connection strings that can be used to connect to the Autonomous Database. For more information, please see Predefined Database Service Names for Autonomous Transaction Processing

   
dedicated
string
on success
The database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements.

Sample:
dedicated_example
   
high
string
on success
The High database service provides the highest level of resources to each SQL statement resulting in the highest performance, but supports the fewest number of concurrent SQL statements.

Sample:
high_example
   
low
string
on success
The Low database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements.

Sample:
low_example
   
medium
string
on success
The Medium database service provides a lower level of resources to each SQL statement potentially resulting a lower level of performance, but supports more concurrent SQL statements.

Sample:
medium_example
   
profiles
complex
on success
A list of connection string profiles to allow clients to group, filter and select connection string values based on structured metadata.

     
consumer_group
string
on success
Consumer group used by the connection.

Sample:
HIGH
     
display_name
string
on success
A user-friendly name for the connection.

Sample:
display_name_example
     
host_format
string
on success
Host format used in connection string.

Sample:
FQDN
     
protocol
string
on success
Protocol used by the connection.

Sample:
TCP
     
session_mode
string
on success
Specifies whether the listener performs a direct hand-off of the session, or redirects the session. In RAC deployments where SCAN is used, sessions are redirected to a Node VIP. Use `DIRECT` for direct hand-offs. Use `REDIRECT` to redirect the session.

Sample:
DIRECT
     
syntax_format
string
on success
Specifies whether the connection string is using the long (`LONG`), Easy Connect (`EZCONNECT`), or Easy Connect Plus (`EZCONNECTPLUS`) format. Autonomous Databases on shared Exadata infrastructure always use the long format.

Sample:
LONG
     
tls_authentication
string
on success
Specifies whether the TLS handshake is using one-way (`SERVER`) or mutual (`MUTUAL`) authentication.

Sample:
SERVER
     
value
string
on success
Connection string value.

Sample:
value_example
 
connection_urls
complex
on success

   
apex_url
string
on success
Oracle Application Express (APEX) URL.

Sample:
apex_url_example
   
database_transforms_url
string
on success
The URL of the Database Transforms for the Autonomous Database.

Sample:
database_transforms_url_example
   
graph_studio_url
string
on success
The URL of the Graph Studio for the Autonomous Database.

Sample:
graph_studio_url_example
   
machine_learning_notebook_url
string
on success
The URL of the Oracle Machine Learning (OML) Notebook for the Autonomous Database.

Sample:
machine_learning_notebook_url_example
   
machine_learning_user_management_url
string
on success
Oracle Machine Learning user management URL.

Sample:
machine_learning_user_management_url_example
   
mongo_db_url
string
on success
The URL of the MongoDB API for the Autonomous Database.

Sample:
mongo_db_url_example
   
ords_url
string
on success
The Oracle REST Data Services (ORDS) URL of the Web Access for the Autonomous Database.

Sample:
ords_url_example
   
sql_dev_web_url
string
on success
Oracle SQL Developer Web URL.

Sample:
sql_dev_web_url_example
 
cpu_core_count
integer
on success
The number of OCPU cores to be made available to the database. When the ECPU is selected, the value for cpuCoreCount is 0. For Autonomous Databases on dedicated Exadata infrastructure, the maximum number of cores is determined by the infrastructure shape. See Characteristics of Infrastructure Shapes for shape details.
**Note:** This parameter cannot be used with the `ocpuCount` parameter.

Sample:
56
 
customer_contacts
complex
on success
Customer Contacts.

   
email
string
on success
The email address used by Oracle to send notifications regarding databases and infrastructure.

Sample:
email_example
 
data_safe_status
string
on success
Status of the Data Safe registration for this Autonomous Database.

Sample:
REGISTERING
 
data_storage_size_in_gbs
integer
on success
The quantity of data in the database, in gigabytes.

Sample:
56
 
data_storage_size_in_tbs
integer
on success
The quantity of data in the database, in terabytes.

Sample:
56
 
database_edition
string
on success
The Oracle Database Edition that applies to the Autonomous databases.

Sample:
STANDARD_EDITION
 
database_management_status
string
on success
Status of Database Management for this Autonomous Database.

Sample:
ENABLING
 
dataguard_region_type
string
on success
The Autonomous Data Guard region type of the Autonomous Database. For Autonomous Databases on shared Exadata infrastructure, Data Guard associations have designated primary and standby regions, and these region types do not change when the database changes roles. The standby regions in Data Guard associations can be the same region designated as the primary region, or they can be remote regions. Certain database administrative operations may be available only in the primary region of the Data Guard association, and cannot be performed when the database using the "primary" role is operating in a remote Data Guard standby region.

Sample:
PRIMARY_DG_REGION
 
db_name
string
on success
The database name.

Sample:
db_name_example
 
db_tools_details
complex
on success
List of database tools details.

   
compute_count
float
on success
Compute used by database tools.

Sample:
3.4
   
is_enabled
boolean
on success
Indicates whether tool is enabled.

Sample:
True
   
max_idle_time_in_minutes
integer
on success
The max idle time, in minutes, after which the VM used by database tools will be terminated.

Sample:
56
   
name
string
on success
Name of database tool.

Sample:
APEX
 
db_version
string
on success
A valid Oracle Database version for Autonomous Database.

Sample:
db_version_example
 
db_workload
string
on success
The Autonomous Database workload type. The following values are valid:
- OLTP - indicates an Autonomous Transaction Processing database - DW - indicates an Autonomous Data Warehouse database - AJD - indicates an Autonomous JSON Database - APEX - indicates an Autonomous Database with the Oracle APEX Application Development workload type.

Sample:
OLTP
 
defined_tags
dictionary
on success
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Sample:
{'Operations': {'CostCenter': 'US'}}
 
display_name
string
on success
The user-friendly name for the Autonomous Database. The name does not have to be unique.

Sample:
display_name_example
 
failed_data_recovery_in_seconds
integer
on success
Indicates the number of seconds of data loss for a Data Guard failover.

Sample:
56
 
freeform_tags
dictionary
on success
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.
Example: `{"Department": "Finance"}`

Sample:
{'Department': 'Finance'}
 
id
string
on success
The OCID of the Autonomous Database.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
infrastructure_type
string
on success
The infrastructure type this resource belongs to.

Sample:
CLOUD
 
is_access_control_enabled
boolean
on success
Indicates if the database-level access control is enabled. If disabled, database access is defined by the network security rules. If enabled, database access is restricted to the IP addresses defined by the rules specified with the `whitelistedIps` property. While specifying `whitelistedIps` rules is optional, if database-level access control is enabled and no rules are specified, the database will become inaccessible. The rules can be added later using the `UpdateAutonomousDatabase` API operation or edit option in console. When creating a database clone, the desired access control setting should be specified. By default, database-level access control will be disabled for the clone.
This property is applicable only to Autonomous Databases on the Exadata Cloud@Customer platform.

Sample:
True
 
is_auto_scaling_enabled
boolean
on success
Indicates if auto scaling is enabled for the Autonomous Database CPU core count.

Sample:
True
 
is_auto_scaling_for_storage_enabled
boolean
on success
Indicates if auto scaling is enabled for the Autonomous Database storage. The default value is `FALSE`.

Sample:
True
 
is_data_guard_enabled
boolean
on success
**Deprecated.** Indicates whether the Autonomous Database has local (in-region) Data Guard enabled. Not applicable to cross-region Autonomous Data Guard associations, or to Autonomous Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure.

Sample:
True
 
is_dedicated
boolean
on success
True if the database uses dedicated Exadata infrastructure.

Sample:
True
 
is_free_tier
boolean
on success
Indicates if this is an Always Free resource. The default value is false. Note that Always Free Autonomous Databases have 1 CPU and 20GB of memory. For Always Free databases, memory and CPU cannot be scaled.

Sample:
True
 
is_local_data_guard_enabled
boolean
on success
Indicates whether the Autonomous Database has local (in-region) Data Guard enabled. Not applicable to cross-region Autonomous Data Guard associations, or to Autonomous Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure.

Sample:
True
 
is_mtls_connection_required
boolean
on success
Indicates whether the Autonomous Database requires mTLS connections.

Sample:
True
 
is_preview
boolean
on success
Indicates if the Autonomous Database version is a preview version.

Sample:
True
 
is_reconnect_clone_enabled
boolean
on success
Indicates if the refreshable clone can be reconnected to its source database.

Sample:
True
 
is_refreshable_clone
boolean
on success
Indicates whether the Autonomous Database is a refreshable clone.

Sample:
True
 
is_remote_data_guard_enabled
boolean
on success
Indicates whether the Autonomous Database has Cross Region Data Guard enabled. Not applicable to Autonomous Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure.

Sample:
True
 
key_history_entry
complex
on success
Key History Entry.

   
id
string
on success
The id of the Autonomous Database Vault service key management history entry.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
   
kms_key_version_id
string
on success
The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation.

Sample:
ocid1.kmskeyversion.oc1..xxxxxxEXAMPLExxxxxx
   
time_activated
string
on success
The date and time the kms key activated.

Sample:
2013-10-20T19:20:30+01:00
   
vault_id
string
on success
The OCID of the Oracle Cloud Infrastructure vault.

Sample:
ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx
 
key_store_id
string
on success
The OCID of the key store.

Sample:
ocid1.keystore.oc1..xxxxxxEXAMPLExxxxxx
 
key_store_wallet_name
string
on success
The wallet name for Oracle Key Vault.

Sample:
key_store_wallet_name_example
 
kms_key_id
string
on success
The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.

Sample:
ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx
 
kms_key_lifecycle_details
string
on success
KMS key lifecycle details.

Sample:
kms_key_lifecycle_details_example
 
kms_key_version_id
string
on success
The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation.

Sample:
ocid1.kmskeyversion.oc1..xxxxxxEXAMPLExxxxxx
 
license_model
string
on success
The Oracle license model that applies to the Oracle Autonomous Database. Bring your own license (BYOL) allows you to apply your current on- premises Oracle software licenses to equivalent, highly automated Oracle PaaS and IaaS services in the cloud. License Included allows you to subscribe to new Oracle Database software licenses and the Database service. Note that when provisioning an Autonomous Database on dedicated Exadata infrastructure, this attribute must be null because the attribute is already set at the Autonomous Exadata Infrastructure level. When using shared Exadata infrastructure, if a value is not specified, the system will supply the value of `BRING_YOUR_OWN_LICENSE`.

Sample:
LICENSE_INCLUDED
 
lifecycle_details
string
on success
Information about the current lifecycle state.

Sample:
lifecycle_details_example
 
lifecycle_state
string
on success
The current state of the Autonomous Database.

Sample:
PROVISIONING
 
local_standby_db
complex
on success

   
lag_time_in_seconds
integer
on success
The amount of time, in seconds, that the data of the standby database lags the data of the primary database. Can be used to determine the potential data loss in the event of a failover.

Sample:
56
   
lifecycle_details
string
on success
Additional information about the current lifecycle state.

Sample:
lifecycle_details_example
   
lifecycle_state
string
on success
The current state of the Autonomous Database.

Sample:
PROVISIONING
   
time_data_guard_role_changed
string
on success
The date and time the Autonomous Data Guard role was switched for the standby Autonomous Database.

Sample:
2013-10-20T19:20:30+01:00
 
max_cpu_core_count
integer
on success
The number of Max OCPU cores to be made available to the autonomous database with auto scaling of cpu enabled.

Sample:
56
 
memory_per_oracle_compute_unit_in_gbs
integer
on success
The amount of memory (in GBs) enabled per each OCPU core in Autonomous VM Cluster.

Sample:
56
 
ncharacter_set
string
on success
The national character set for the autonomous database. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8.

Sample:
ncharacter_set_example
 
nsg_ids
list / elements=string
on success
The list of OCIDs for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see Security Rules. **NsgIds restrictions:** - A network security group (NSG) is optional for Autonomous Databases with private access. The nsgIds list can be empty.

 
ocpu_count
float
on success
The number of OCPU cores to be made available to the database.
The following points apply: - For Autonomous Databases on dedicated Exadata infrastructure, to provision less than 1 core, enter a fractional value in an increment of 0.1. For example, you can provision 0.3 or 0.4 cores, but not 0.35 cores. (Note that fractional OCPU values are not supported for Autonomous Databasese on shared Exadata infrastructure.) - To provision 1 or more cores, you must enter an integer between 1 and the maximum number of cores available for the infrastructure shape. For example, you can provision 2 cores or 3 cores, but not 2.5 cores. This applies to Autonomous Databases on both shared and dedicated Exadata infrastructure.
For Autonomous Databases on dedicated Exadata infrastructure, the maximum number of cores is determined by the infrastructure shape. See Characteristics of Infrastructure Shapes for shape details.
**Note:** This parameter cannot be used with the `cpuCoreCount` parameter.

Sample:
3.4
 
open_mode
string
on success
The `DATABASE OPEN` mode. You can open the database in `READ_ONLY` or `READ_WRITE` mode.

Sample:
READ_ONLY
 
operations_insights_status
string
on success
Status of Operations Insights for this Autonomous Database.

Sample:
ENABLING
 
peer_db_ids
list / elements=string
on success
The list of OCIDs of standby databases located in Autonomous Data Guard remote regions that are associated with the source database. Note that for shared Exadata infrastructure, standby databases located in the same region as the source primary database do not have OCIDs.

 
permission_level
string
on success
The Autonomous Database permission level. Restricted mode allows access only to admin users.

Sample:
RESTRICTED
 
private_endpoint
string
on success
The private endpoint for the resource.

Sample:
private_endpoint_example
 
private_endpoint_ip
string
on success
The private endpoint Ip address for the resource.

Sample:
private_endpoint_ip_example
 
private_endpoint_label
string
on success
The private endpoint label for the resource. Setting this to an empty string, after the private endpoint database gets created, will change the same private endpoint database to the public endpoint database.

Sample:
private_endpoint_label_example
 
provisionable_cpus
list / elements=string
on success
An array of CPU values that an Autonomous Database can be scaled to.

 
refreshable_mode
string
on success
The refresh mode of the clone. AUTOMATIC indicates that the clone is automatically being refreshed with data from the source Autonomous Database.

Sample:
AUTOMATIC
 
refreshable_status
string
on success
The refresh status of the clone. REFRESHING indicates that the clone is currently being refreshed with data from the source Autonomous Database.

Sample:
REFRESHING
 
role
string
on success
The Data Guard role of the Autonomous Container Database or Autonomous Database, if Autonomous Data Guard is enabled.

Sample:
PRIMARY
 
scheduled_operations
complex
on success
list of scheduled operations

   
day_of_week
complex
on success

     
name
string
on success
Name of the day of the week.

Sample:
MONDAY
   
scheduled_start_time
string
on success
auto start time. value must be of ISO-8601 format "HH:mm"

Sample:
scheduled_start_time_example
   
scheduled_stop_time
string
on success
auto stop time. value must be of ISO-8601 format "HH:mm"

Sample:
scheduled_stop_time_example
 
service_console_url
string
on success
The URL of the Service Console for the Autonomous Database.

Sample:
service_console_url_example
 
source_id
string
on success
The OCID of the source Autonomous Database that was cloned to create the current Autonomous Database.

Sample:
ocid1.source.oc1..xxxxxxEXAMPLExxxxxx
 
standby_db
complex
on success
**Deprecated** Autonomous Data Guard standby database details.

   
lag_time_in_seconds
integer
on success
The amount of time, in seconds, that the data of the standby database lags the data of the primary database. Can be used to determine the potential data loss in the event of a failover.

Sample:
56
   
lifecycle_details
string
on success
Additional information about the current lifecycle state.

Sample:
lifecycle_details_example
   
lifecycle_state
string
on success
The current state of the Autonomous Database.

Sample:
PROVISIONING
   
time_data_guard_role_changed
string
on success
The date and time the Autonomous Data Guard role was switched for the standby Autonomous Database.

Sample:
2013-10-20T19:20:30+01:00
 
standby_whitelisted_ips
list / elements=string
on success
The client IP access control list (ACL). This feature is available for autonomous databases on shared Exadata infrastructure and on Exadata Cloud@Customer. Only clients connecting from an IP address included in the ACL may access the Autonomous Database instance.
For shared Exadata infrastructure, this is an array of CIDR (Classless Inter-Domain Routing) notations for a subnet or VCN OCID. Use a semicolon (;) as a deliminator between the VCN-specific subnets or IPs. Example: `["1.1.1.1","1.1.1.0/24","ocid1.vcn.oc1.sea.<unique_id>","ocid1.vcn.oc1.sea.<unique_id1>;1.1.1.1","ocid1.vcn.oc1.se a.<unique_id2>;1.1.0.0/16"]` For Exadata Cloud@Customer, this is an array of IP addresses or CIDR (Classless Inter-Domain Routing) notations. Example: `["1.1.1.1","1.1.1.0/24","1.1.2.25"]`
For an update operation, if you want to delete all the IPs in the ACL, use an array with a single empty string entry.

 
subnet_id
string
on success
The OCID of the subnet the resource is associated with.
**Subnet Restrictions:** - For bare metal DB systems and for single node virtual machine DB systems, do not use a subnet that overlaps with 192.168.16.16/28. - For Exadata and virtual machine 2-node RAC systems, do not use a subnet that overlaps with 192.168.128.0/20. - For Autonomous Database, setting this will disable public secure access to the database.
These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and the backup subnet.

Sample:
ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx
 
supported_regions_to_clone_to
list / elements=string
on success
The list of regions that support the creation of an Autonomous Database clone or an Autonomous Data Guard standby database.

 
system_tags
dictionary
on success
System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

 
time_created
string
on success
The date and time the Autonomous Database was created.

Sample:
2013-10-20T19:20:30+01:00
 
time_data_guard_role_changed
string
on success
The date and time the Autonomous Data Guard role was switched for the Autonomous Database. For databases that have standbys in both the primary Data Guard region and a remote Data Guard standby region, this is the latest timestamp of either the database using the "primary" role in the primary Data Guard region, or database located in the remote Data Guard standby region.

Sample:
2013-10-20T19:20:30+01:00
 
time_deletion_of_free_autonomous_database
string
on success
The date and time the Always Free database will be automatically deleted because of inactivity. If the database is in the STOPPED state and without activity until this time, it will be deleted.

Sample:
2013-10-20T19:20:30+01:00
 
time_local_data_guard_enabled
string
on success
The date and time that Autonomous Data Guard was enabled for an Autonomous Database where the standby was provisioned in the same region as the primary database.

Sample:
2013-10-20T19:20:30+01:00
 
time_maintenance_begin
string
on success
The date and time when maintenance will begin.

Sample:
2013-10-20T19:20:30+01:00
 
time_maintenance_end
string
on success
The date and time when maintenance will end.

Sample:
2013-10-20T19:20:30+01:00
 
time_of_last_failover
string
on success
The timestamp of the last failover operation.

Sample:
2013-10-20T19:20:30+01:00
 
time_of_last_refresh
string
on success
The date and time when last refresh happened.

Sample:
2013-10-20T19:20:30+01:00
 
time_of_last_refresh_point
string
on success
The refresh point timestamp (UTC). The refresh point is the time to which the database was most recently refreshed. Data created after the refresh point is not included in the refresh.

Sample:
2013-10-20T19:20:30+01:00
 
time_of_last_switchover
string
on success
The timestamp of the last switchover operation for the Autonomous Database.

Sample:
2013-10-20T19:20:30+01:00
 
time_of_next_refresh
string
on success
The date and time of next refresh.

Sample:
2013-10-20T19:20:30+01:00
 
time_reclamation_of_free_autonomous_database
string
on success
The date and time the Always Free database will be stopped because of inactivity. If this time is reached without any database activity, the database will automatically be put into the STOPPED state.

Sample:
2013-10-20T19:20:30+01:00
 
time_until_reconnect_clone_enabled
string
on success
The time and date as an RFC3339 formatted string, e.g., 2022-01-01T12:00:00.000Z, to set the limit for a refreshable clone to be reconnected to its source database.

Sample:
2013-10-20T19:20:30+01:00
 
total_backup_storage_size_in_gbs
float
on success
The backup storage to the database.

Sample:
1.2
 
used_data_storage_size_in_tbs
integer
on success
The amount of storage that has been used, in terabytes.

Sample:
56
 
vault_id
string
on success
The OCID of the Oracle Cloud Infrastructure vault.

Sample:
ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx
 
whitelisted_ips
list / elements=string
on success
The client IP access control list (ACL). This feature is available for autonomous databases on shared Exadata infrastructure and on Exadata Cloud@Customer. Only clients connecting from an IP address included in the ACL may access the Autonomous Database instance.
For shared Exadata infrastructure, this is an array of CIDR (Classless Inter-Domain Routing) notations for a subnet or VCN OCID. Use a semicolon (;) as a deliminator between the VCN-specific subnets or IPs. Example: `["1.1.1.1","1.1.1.0/24","ocid1.vcn.oc1.sea.<unique_id>","ocid1.vcn.oc1.sea.<unique_id1>;1.1.1.1","ocid1.vcn.oc1.se a.<unique_id2>;1.1.0.0/16"]` For Exadata Cloud@Customer, this is an array of IP addresses or CIDR (Classless Inter-Domain Routing) notations. Example: `["1.1.1.1","1.1.1.0/24","1.1.2.25"]`
For an update operation, if you want to delete all the IPs in the ACL, use an array with a single empty string entry.



Authors

  • Oracle (@oracle)