- Resource: AutonomousDatabase
- AutonomousDatabaseProperties
- DatabaseEdition
- LicenseType
- MaintenanceScheduleType
- AutonomousDatabaseApex
- State
- AutonomousDatabaseConnectionStrings
- AllConnectionStrings
- DatabaseConnectionStringProfile
- ConsumerGroup
- HostFormat
- Protocol
- SessionMode
- SyntaxFormat
- TLSAuthentication
- AutonomousDatabaseConnectionUrls
- AutonomousDatabaseStandbySummary
- LocalDisasterRecoveryType
- DataSafeState
- DatabaseManagementState
- OpenMode
- OperationsInsightsState
- PermissionLevel
- RefreshableMode
- RefreshableState
- Role
- ScheduledOperationDetails
- TimeOfDay
- Methods
Resource: AutonomousDatabase
Details of the Autonomous Database resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabase/
JSON representation |
---|
{
"name": string,
"database": string,
"displayName": string,
"entitlementId": string,
"adminPassword": string,
"properties": {
object ( |
Fields | |
---|---|
name |
Identifier. The name of the Autonomous Database resource in the following format: projects/{project}/locations/{region}/autonomousDatabases/{autonomousDatabase} |
database |
Optional. The name of the Autonomous Database. The database name must be unique in the project. The name must begin with a letter and can contain a maximum of 30 alphanumeric characters. |
display |
Optional. The display name for the Autonomous Database. The name does not have to be unique within your project. |
entitlement |
Output only. The ID of the subscription entitlement associated with the Autonomous Database. |
admin |
Optional. The password for the default ADMIN user. |
properties |
Optional. The properties of the Autonomous Database. |
labels |
Optional. The labels or tags associated with the Autonomous Database. An object containing a list of |
network |
Required. The name of the VPC network used by the Autonomous Database in the following format: projects/{project}/global/networks/{network} |
cidr |
Required. The subnet CIDR range for the Autonmous Database. |
create |
Output only. The date and time that the Autonomous Database was created. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
AutonomousDatabaseProperties
The properties of an Autonomous Database.
JSON representation |
---|
{ "ocid": string, "computeCount": number, "cpuCoreCount": integer, "dataStorageSizeTb": integer, "dataStorageSizeGb": integer, "dbWorkload": enum ( |
Fields | |
---|---|
ocid |
Output only. OCID of the Autonomous Database. https://docs.oracle.com/en-us/iaas/Content/General/Concepts/identifiers.htm#Oracle |
compute |
Optional. The number of compute servers for the Autonomous Database. |
cpu |
Optional. The number of CPU cores to be made available to the database. |
data |
Optional. The size of the data stored in the database, in terabytes. |
data |
Optional. The size of the data stored in the database, in gigabytes. |
db |
Required. The workload type of the Autonomous Database. |
db |
Optional. The edition of the Autonomous Databases. |
character |
Optional. The character set for the Autonomous Database. The default is AL32UTF8. |
n |
Optional. The national character set for the Autonomous Database. The default is AL16UTF16. |
private |
Optional. The private endpoint IP address for the Autonomous Database. |
private |
Optional. The private endpoint label for the Autonomous Database. |
db |
Optional. The Oracle Database version for the Autonomous Database. |
is |
Optional. This field indicates if auto scaling is enabled for the Autonomous Database CPU core count. |
is |
Optional. This field indicates if auto scaling is enabled for the Autonomous Database storage. |
license |
Required. The license type used for the Autonomous Database. |
customer |
Optional. The list of customer contacts. |
secret |
Optional. The ID of the Oracle Cloud Infrastructure vault secret. |
vault |
Optional. The ID of the Oracle Cloud Infrastructure vault. |
maintenance |
Optional. The maintenance schedule of the Autonomous Database. |
mtls |
Optional. This field specifies if the Autonomous Database requires mTLS connections. |
backup |
Optional. The retention period for the Autonomous Database. This field is specified in days, can range from 1 day to 60 days, and has a default value of 60 days. |
actual |
Output only. The amount of storage currently being used for user and system data, in terabytes. |
allocated |
Output only. The amount of storage currently allocated for the database tables and billed for, rounded up in terabytes. |
apex |
Output only. The details for the Oracle APEX Application Development. |
lifecycle |
Output only. The details of the current lifestyle state of the Autonomous Database. |
state |
Output only. The current lifecycle state of the Autonomous Database. |
autonomous |
Output only. The Autonomous Container Database OCID. |
available |
Output only. The list of available Oracle Database upgrade versions for an Autonomous Database. |
connection |
Output only. The connection strings used to connect to an Autonomous Database. |
connection |
Output only. The Oracle Connection URLs for an Autonomous Database. |
failed |
Output only. This field indicates the number of seconds of data loss during a Data Guard failover. A duration in seconds with up to nine fractional digits, ending with ' |
memory |
Output only. The memory assigned to in-memory tables in an Autonomous Database. |
is |
Output only. This field indicates whether the Autonomous Database has local (in-region) Data Guard enabled. |
local |
Output only. This field indicates the maximum data loss limit for an Autonomous Database, in seconds. |
local |
Output only. The details of the Autonomous Data Guard standby database. |
memory |
Output only. The amount of memory enabled per ECPU, in gigabytes. |
local |
Output only. This field indicates the local disaster recovery (DR) type of an Autonomous Database. |
data |
Output only. The current state of the Data Safe registration for the Autonomous Database. |
database |
Output only. The current state of database management for the Autonomous Database. |
open |
Output only. This field indicates the current mode of the Autonomous Database. |
operations |
Output only. This field indicates the state of Operations Insights for the Autonomous Database. |
peer |
Output only. The list of OCIDs of standby databases located in Autonomous Data Guard remote regions that are associated with the source database. |
permission |
Output only. The permission level of the Autonomous Database. |
private |
Output only. The private endpoint for the Autonomous Database. |
refreshable |
Output only. The refresh mode of the cloned Autonomous Database. |
refreshable |
Output only. The refresh State of the clone. |
role |
Output only. The Data Guard role of the Autonomous Database. |
scheduled |
Output only. The list and details of the scheduled operations of the Autonomous Database. |
sql |
Output only. The SQL Web Developer URL for the Autonomous Database. |
supported |
Output only. The list of available regions that can be used to create a clone for the Autonomous Database. |
used |
Output only. The storage space used by Autonomous Database, in gigabytes. |
oci |
Output only. The Oracle Cloud Infrastructure link for the Autonomous Database. |
total |
Output only. The storage space used by automatic backups of Autonomous Database, in gigabytes. |
next |
Output only. The long term backup schedule of the Autonomous Database. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
maintenance |
Output only. The date and time when maintenance will begin. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
maintenance |
Output only. The date and time when maintenance will end. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
are |
Output only. This field indicates the status of Data Guard and Access control for the Autonomous Database. The field's value is null if Data Guard is disabled or Access Control is disabled. The field's value is TRUE if both Data Guard and Access Control are enabled, and the Autonomous Database is using primary IP access control list (ACL) for standby. The field's value is FALSE if both Data Guard and Access Control are enabled, and the Autonomous Database is using a different IP access control list (ACL) for standby compared to primary. |
DatabaseEdition
The editions available for the Autonomous Database.
Enums | |
---|---|
DATABASE_EDITION_UNSPECIFIED |
Default unspecified value. |
STANDARD_EDITION |
Standard Database Edition |
ENTERPRISE_EDITION |
Enterprise Database Edition |
LicenseType
The license types available for the Autonomous Database.
Enums | |
---|---|
LICENSE_TYPE_UNSPECIFIED |
Unspecified |
LICENSE_INCLUDED |
License included part of offer |
BRING_YOUR_OWN_LICENSE |
Bring your own license |
MaintenanceScheduleType
The available maintenance schedules for the Autonomous Database.
Enums | |
---|---|
MAINTENANCE_SCHEDULE_TYPE_UNSPECIFIED |
Default unspecified value. |
EARLY |
An EARLY maintenance schedule patches the database before the regular scheduled maintenance. |
REGULAR |
A REGULAR maintenance schedule follows the normal maintenance cycle. |
AutonomousDatabaseApex
Oracle APEX Application Development. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseApex
JSON representation |
---|
{ "apexVersion": string, "ordsVersion": string } |
Fields | |
---|---|
apex |
Output only. The Oracle APEX Application Development version. |
ords |
Output only. The Oracle REST Data Services (ORDS) version. |
State
The various lifecycle states of the Autonomous Database.
Enums | |
---|---|
STATE_UNSPECIFIED |
Default unspecified value. |
PROVISIONING |
Indicates that the Autonomous Database is in provisioning state. |
AVAILABLE |
Indicates that the Autonomous Database is in available state. |
STOPPING |
Indicates that the Autonomous Database is in stopping state. |
STOPPED |
Indicates that the Autonomous Database is in stopped state. |
STARTING |
Indicates that the Autonomous Database is in starting state. |
TERMINATING |
Indicates that the Autonomous Database is in terminating state. |
TERMINATED |
Indicates that the Autonomous Database is in terminated state. |
UNAVAILABLE |
Indicates that the Autonomous Database is in unavailable state. |
RESTORE_IN_PROGRESS |
Indicates that the Autonomous Database restore is in progress. |
RESTORE_FAILED |
Indicates that the Autonomous Database failed to restore. |
BACKUP_IN_PROGRESS |
Indicates that the Autonomous Database backup is in progress. |
SCALE_IN_PROGRESS |
Indicates that the Autonomous Database scale is in progress. |
AVAILABLE_NEEDS_ATTENTION |
Indicates that the Autonomous Database is available but needs attention state. |
UPDATING |
Indicates that the Autonomous Database is in updating state. |
MAINTENANCE_IN_PROGRESS |
Indicates that the Autonomous Database's maintenance is in progress state. |
RESTARTING |
Indicates that the Autonomous Database is in restarting state. |
RECREATING |
Indicates that the Autonomous Database is in recreating state. |
ROLE_CHANGE_IN_PROGRESS |
Indicates that the Autonomous Database's role change is in progress state. |
UPGRADING |
Indicates that the Autonomous Database is in upgrading state. |
INACCESSIBLE |
Indicates that the Autonomous Database is in inaccessible state. |
STANDBY |
Indicates that the Autonomous Database is in standby state. |
AutonomousDatabaseConnectionStrings
The connection string used to connect to the Autonomous Database. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseConnectionStrings
JSON representation |
---|
{ "allConnectionStrings": { object ( |
Fields | |
---|---|
all |
Output only. Returns all connection strings that can be used to connect to the Autonomous Database. |
dedicated |
Output only. The database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements. |
high |
Output only. The database service provides the highest level of resources to each SQL statement. |
low |
Output only. The database service provides the least level of resources to each SQL statement. |
medium |
Output only. The database service provides a lower level of resources to each SQL statement. |
profiles[] |
Output only. A list of connection string profiles to allow clients to group, filter, and select values based on the structured metadata. |
AllConnectionStrings
A list of all connection strings that can be used to connect to the Autonomous Database.
JSON representation |
---|
{ "high": string, "low": string, "medium": string } |
Fields | |
---|---|
high |
Output only. The database service provides the highest level of resources to each SQL statement. |
low |
Output only. The database service provides the least level of resources to each SQL statement. |
medium |
Output only. The database service provides a lower level of resources to each SQL statement. |
DatabaseConnectionStringProfile
The connection string profile to allow clients to group. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/DatabaseConnectionStringProfile
JSON representation |
---|
{ "consumerGroup": enum ( |
Fields | |
---|---|
consumer |
Output only. The current consumer group being used by the connection. |
display |
Output only. The display name for the database connection. |
host |
Output only. The host name format being currently used in connection string. |
is |
Output only. This field indicates if the connection string is regional and is only applicable for cross-region Data Guard. |
protocol |
Output only. The protocol being used by the connection. |
session |
Output only. The current session mode of the connection. |
syntax |
Output only. The syntax of the connection string. |
tls |
Output only. This field indicates the TLS authentication type of the connection. |
value |
Output only. The value of the connection string. |
ConsumerGroup
The various consumer groups available in the connection string profile.
Enums | |
---|---|
CONSUMER_GROUP_UNSPECIFIED |
Default unspecified value. |
HIGH |
High consumer group. |
MEDIUM |
Medium consumer group. |
LOW |
Low consumer group. |
TP |
TP consumer group. |
TPURGENT |
TPURGENT consumer group. |
HostFormat
The host name format being used in the connection string.
Enums | |
---|---|
HOST_FORMAT_UNSPECIFIED |
Default unspecified value. |
FQDN |
FQDN |
IP |
IP |
Protocol
The protocol being used by the connection.
Enums | |
---|---|
PROTOCOL_UNSPECIFIED |
Default unspecified value. |
TCP |
Tcp |
TCPS |
Tcps |
SessionMode
The session mode of the connection.
Enums | |
---|---|
SESSION_MODE_UNSPECIFIED |
Default unspecified value. |
DIRECT |
Direct |
INDIRECT |
Indirect |
SyntaxFormat
Specifies syntax of the connection string.
Enums | |
---|---|
SYNTAX_FORMAT_UNSPECIFIED |
Default unspecified value. |
LONG |
Long |
EZCONNECT |
Ezconnect |
EZCONNECTPLUS |
Ezconnectplus |
TLSAuthentication
This field indicates the TLS authentication type of the connection.
Enums | |
---|---|
TLS_AUTHENTICATION_UNSPECIFIED |
Default unspecified value. |
SERVER |
Server |
MUTUAL |
Mutual |
AutonomousDatabaseConnectionUrls
The URLs for accessing Oracle Application Express (APEX) and SQL Developer Web with a browser from a Compute instance. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseConnectionUrls
JSON representation |
---|
{ "apexUri": string, "databaseTransformsUri": string, "graphStudioUri": string, "machineLearningNotebookUri": string, "machineLearningUserManagementUri": string, "mongoDbUri": string, "ordsUri": string, "sqlDevWebUri": string } |
Fields | |
---|---|
apex |
Output only. Oracle Application Express (APEX) URL. |
database |
Output only. The URL of the Database Transforms for the Autonomous Database. |
graph |
Output only. The URL of the Graph Studio for the Autonomous Database. |
machine |
Output only. The URL of the Oracle Machine Learning (OML) Notebook for the Autonomous Database. |
machine |
Output only. The URL of Machine Learning user management the Autonomous Database. |
mongo |
Output only. The URL of the MongoDB API for the Autonomous Database. |
ords |
Output only. The Oracle REST Data Services (ORDS) URL of the Web Access for the Autonomous Database. |
sql |
Output only. The URL of the Oracle SQL Developer Web for the Autonomous Database. |
AutonomousDatabaseStandbySummary
Autonomous Data Guard standby database details. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseStandbySummary
JSON representation |
---|
{
"lagTimeDuration": string,
"lifecycleDetails": string,
"state": enum ( |
Fields | |
---|---|
lag |
Output only. The amount of time, in seconds, that the data of the standby database lags in comparison to the data of the primary database. A duration in seconds with up to nine fractional digits, ending with ' |
lifecycle |
Output only. The additional details about the current lifecycle state of the Autonomous Database. |
state |
Output only. The current lifecycle state of the Autonomous Database. |
data |
Output only. The date and time the Autonomous Data Guard role was switched for the standby Autonomous Database. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
disaster |
Output only. The date and time the Disaster Recovery role was switched for the standby Autonomous Database. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
LocalDisasterRecoveryType
The types of local disaster recovery available for an Autonomous Database.
Enums | |
---|---|
LOCAL_DISASTER_RECOVERY_TYPE_UNSPECIFIED |
Default unspecified value. |
ADG |
Autonomous Data Guard recovery. |
BACKUP_BASED |
Backup based recovery. |
DataSafeState
Varies states of the Data Safe registration for the Autonomous Database.
Enums | |
---|---|
DATA_SAFE_STATE_UNSPECIFIED |
Default unspecified value. |
REGISTERING |
Registering data safe state. |
REGISTERED |
Registered data safe state. |
DEREGISTERING |
Deregistering data safe state. |
NOT_REGISTERED |
Not registered data safe state. |
FAILED |
Failed data safe state. |
DatabaseManagementState
The different states of database management for an Autonomous Database.
Enums | |
---|---|
DATABASE_MANAGEMENT_STATE_UNSPECIFIED |
Default unspecified value. |
ENABLING |
Enabling Database Management state |
ENABLED |
Enabled Database Management state |
DISABLING |
Disabling Database Management state |
NOT_ENABLED |
Not Enabled Database Management state |
FAILED_ENABLING |
Failed enabling Database Management state |
FAILED_DISABLING |
Failed disabling Database Management state |
OpenMode
This field indicates the modes of an Autonomous Database.
Enums | |
---|---|
OPEN_MODE_UNSPECIFIED |
Default unspecified value. |
READ_ONLY |
Read Only Mode |
READ_WRITE |
Read Write Mode |
OperationsInsightsState
The state of the Operations Insights for this Autonomous Database.
Enums | |
---|---|
OPERATIONS_INSIGHTS_STATE_UNSPECIFIED |
Default unspecified value. |
ENABLING |
Enabling status for operation insights. |
ENABLED |
Enabled status for operation insights. |
DISABLING |
Disabling status for operation insights. |
NOT_ENABLED |
Not Enabled status for operation insights. |
FAILED_ENABLING |
Failed enabling status for operation insights. |
FAILED_DISABLING |
Failed disabling status for operation insights. |
PermissionLevel
The types of permission levels for an Autonomous Database.
Enums | |
---|---|
PERMISSION_LEVEL_UNSPECIFIED |
Default unspecified value. |
RESTRICTED |
Restricted mode allows access only by admin users. |
UNRESTRICTED |
Normal access. |
RefreshableMode
The refresh mode of the cloned Autonomous Database.
Enums | |
---|---|
REFRESHABLE_MODE_UNSPECIFIED |
The default unspecified value. |
AUTOMATIC |
AUTOMATIC indicates that the cloned database is automatically refreshed with data from the source Autonomous Database. |
MANUAL |
MANUAL indicates that the cloned database is manually refreshed with data from the source Autonomous Database. |
RefreshableState
The refresh state of the cloned Autonomous Database.
Enums | |
---|---|
REFRESHABLE_STATE_UNSPECIFIED |
Default unspecified value. |
REFRESHING |
Refreshing |
NOT_REFRESHING |
Not refreshed |
Role
The Data Guard role of the Autonomous Database.
Enums | |
---|---|
ROLE_UNSPECIFIED |
Default unspecified value. |
PRIMARY |
Primary role |
STANDBY |
Standby role |
DISABLED_STANDBY |
Disabled standby role |
BACKUP_COPY |
Backup copy role |
SNAPSHOT_STANDBY |
Snapshot standby role |
ScheduledOperationDetails
Details of scheduled operation. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/ScheduledOperationDetails
JSON representation |
---|
{ "dayOfWeek": enum ( |
Fields | |
---|---|
day |
Output only. Day of week. |
start |
Output only. Auto start time. |
stop |
Output only. Auto stop time. |
TimeOfDay
Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date
and google.protobuf.Timestamp
.
JSON representation |
---|
{ "hours": integer, "minutes": integer, "seconds": integer, "nanos": integer } |
Fields | |
---|---|
hours |
Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. |
minutes |
Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. |
seconds |
Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. |
nanos |
Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. |
Methods |
|
---|---|
|
Creates a new Autonomous Database in a given project and location. |
|
Deletes a single Autonomous Database. |
|
Generates a wallet for an Autonomous Database. |
|
Gets the details of a single Autonomous Database. |
|
Lists the Autonomous Databases in a given project and location. |
|
Restores a single Autonomous Database. |