Oracle Db System API is one of 378 APIs that Oracle publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include dbSystem. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.
This API exposes
21 operations
across 16 paths,
and defines 62 schemas.
It is described by OpenAPI 3.2.0, at version 20190415.
Requests are made against a single base URL, http://mysql.{region}.ocp.oraclecloud.com/20190415.
The identity and technical contract details declared by the specification.
UpdateHeatWaveClusterDetails
object
Details about the HeatWave cluster properties to be updated.
3 properties
DataStorageDetails
object
Data Storage configuration properties.
2 properties
CustomerContact
object
Customer contact information that will be used by Oracle to provide notifications needed by DB System administrators.
1 property
1 required
StopDbSystemDetails
object
DB System shutdown parameters.
1 property
1 required
MaintenanceEvent
object
The details of a maintenance event.
14 properties
8 required
CreateDbSystemDetails
object
Details required to create a DB System.
39 properties
5 required
SecureConnectionDetails
object
Secure connection configuration details.
2 properties
1 required
DatabaseConsoleDetails
object
Database console configuration details.
2 properties
1 required
RestDetails
object
REST configuration details.
2 properties
1 required
DbSystemStatusResult
object
The status collected from the DB System.
8 properties
CreateReadEndpointDetails
Details required to create a Read Endpoint.
ControlledUpdate
The details of the last successfully processed controlled update action.
UpdateBackupPolicyDetails
object
Backup Policy as optionally used for DB System update.
8 properties
ChannelSummary
object
Summary of a Channel.
13 properties
9 required
DataStorage
Data Storage information.
BackupPolicy
object
The Backup policy for the DB System.
8 properties
3 required
ChannelStatusResult
object
Status information for the channel attached to the DB System.
5 properties
1 required
UpdateDeletionPolicyDetails
object
Policy for how the DB System and related resources should be handled at the time of its deletion.
3 properties
CreateMaintenanceDetails
object
The Maintenance Policy for the DB System or Read Replica that this model is included in.
5 properties
1 required
CreateRestDetails
object
Details required to configure REST while creating a DB System.
2 properties
1 required
CreateTelemetryConfigurationDetails
Details required to configure how MySQL telemetry should be exposed.
ReadEndpointDetails
object
The read endpoint of a DB System.
5 properties
ControlledUpdateDbSystemDetails
object
Details of the controlled update action, including the target subset of MySQL instances to update based on their role.
2 properties
EncryptDataDetails
object
Encrypt data details.
2 properties
1 required
UpdateRestDetails
object
Details required to configure REST while updating a DB System.
2 properties
1 required
AddHeatWaveClusterDetails
object
Details required to add a HeatWave cluster.
3 properties
2 required
GenerateDbSystemStatusDetails
object
Parameters for selecting which attributes to include in the DB System status.
3 properties
Ipv6AddressIpv6SubnetCidrPairDetails
object
Details to assign an IPv6 subnet prefix or IPv6 address to a resource.
2 properties
CreateBackupPolicyDetails
object
Backup policy as optionally used for DB System Creation.
8 properties
DeletionPolicyDetails
object
The Deletion policy for the DB System.
3 properties
3 required
PitrPolicy
object
The PITR policy for the DB System.
1 property
1 required
UpdateDbSystemDetails
object
Details required to update a DB System.
37 properties
HeatWaveClusterMemoryEstimate
object
HeatWave cluster memory estimate that can be used to determine a suitable HeatWave cluster size. For each MySQL user table the estimated memory footprint when…
5 properties
5 required
UpdateTelemetryConfigurationDetails
Details required to configure how MySQL telemetry should be exposed.
ChannelTarget
object
Details about the Channel target.
1 property
1 required
UpdateDatabaseConsoleDetails
object
Details required to configure the database console while updating a DB System.
2 properties
1 required
DestinationConfiguration
object
Configuration variable of a given destination.
2 properties
2 required
ChannelSource
object
Parameters detailing how to provision the source for the given Channel.
1 property
1 required
CreateDeletionPolicyDetails
object
Policy for how the DB System and related resources should be handled at the time of its deletion.
3 properties
CopyPolicy
object
A policy of a DB system to schedule cross-region DB system backup copy.
2 properties
1 required
RestartDbSystemDetails
object
DB System restart parameters.
1 property
1 required
DbSystemSource
object
Parameters detailing how to provision the initial data of the DB System.
1 property
1 required
LoggingDestinationConfiguration
object
Configuration parameters for a given destination.
3 properties
3 required
DbSystemStatus
object
Runtime status summary of a DbSystem, aggregating information about availability and operational indicators.
4 properties
3 required
HeatWaveClusterSummary
object
A summary of a HeatWave cluster.
6 properties
5 required
CreateDatabaseConsoleDetails
object
Details required to configure the database console while creating a DB System.
2 properties
1 required
CreateDbSystemSourceDetails
object
Parameters detailing how to provision the initial data of the system.
1 property
1 required
MaintenanceDisabledWindow
object
Time window during which downtime-inducing maintenance shall not be performed. Downtime-free maintenance may be performed to apply required security patches.
2 properties
2 required
PointInTimeRecoveryDetails
object
Point-in-time Recovery details like earliest and latest recovery time point for the DB System.
2 properties
2 required
HeatWaveCluster
object
A HeatWave cluster is a database accelerator for a DB System.
9 properties
7 required
DbSystem
object
A DB System is the core logical unit of MySQL Database Service.
50 properties
14 required
HeatWaveNode
object
A HeatWave node is a compute host that is part of a HeatWave cluster.
4 properties
2 required
HeatWaveClusterTableMemoryEstimate
object
Estimated memory footprint for a MySQL user table when loaded to the HeatWave cluster memory.
6 properties
6 required
DbSystemEndpoint
object
A particular functional endpoint for access to a DB System, and the properties that apply to it.
8 properties
3 required
DbSystemPlacement
object
The availability domain and fault domain a DB System is placed in.
2 properties
DbSystemSummary
object
A summary of a DB System.
28 properties
8 required
UpdateReadEndpointDetails
Read Endpoint details.
HeatWaveClusterSchemaMemoryEstimate
object
Schema with estimated memory footprints for each MySQL user table of the schema when loaded to HeatWave cluster memory.
2 properties
2 required
Error
object
Sorry.
2 properties
2 required
TelemetryConfigurationDetails
object
Telemetry configuration details of a DB System or a read replica.
1 property
MaintenanceDetails
object
The Maintenance Policy for the DB System or Read Replica that this model is included in.
7 properties
UpdateMaintenanceDetails
object
The Maintenance Policy for the DB System or Read Replica that this model is included in.
5 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Oracle publishes across the network.
