openapi: 3.2.0
info:
description: The API for the MySQL Database Service
license:
name: Oracle Corporation
title: MySQL Database Service Db System API
version: '20190415'
x-provenance:
method: harvested
first_party: true
publisher: Oracle
source: https://docs.oracle.com/en-us/iaas/api/specs/c21bc5da8ceddf436da4e56b2328b97fa65fa6675d07108e7a0447de3e832a0a.yaml
harvested: '2026-08-04'
note: Published by Oracle as the contract for the MySQL Database Service API OCI service and stored verbatim; API Evangelist added only this provenance block.
x-evidence:
- url: https://docs.oracle.com/en-us/iaas/api/specs/index.json
what: Oracle's own index of every OCI service specification
- url: https://docs.oracle.com/en-us/iaas/api/specs/c21bc5da8ceddf436da4e56b2328b97fa65fa6675d07108e7a0447de3e832a0a.yaml
what: the harvested document for MySQL Database Service API
servers:
- url: http://mysql.{region}.ocp.oraclecloud.com/20190415
tags:
- name: dbSystem
paths:
/dbSystems:
get:
description: 'Get a list of DB Systems in the specified compartment.
The default sort order is by timeUpdated, descending.
'
operationId: ListDbSystems
parameters:
- $ref: '#/components/parameters/OpcRequestIdHeader'
- $ref: '#/components/parameters/FilterByHeatWaveClusterAttachedQueryParam'
- $ref: '#/components/parameters/FilterByCompartmentIdQueryParam'
- $ref: '#/components/parameters/FilterByDbSystemIdQueryParam'
- $ref: '#/components/parameters/FilterByDisplayNameQueryParam'
- $ref: '#/components/parameters/FilterByDbSystemLifecycleStateQueryParam'
- $ref: '#/components/parameters/FilterByConfigurationIdQueryParam'
- $ref: '#/components/parameters/FilterByConfigurationUpToDateQueryParam'
- $ref: '#/components/parameters/FilterByDatabaseManagementStatusQueryParam'
- $ref: '#/components/parameters/SortByDbSystemFieldQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
responses:
200:
description: All DB Systems.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then a partial list might have been returned. Include this value as the `page` parameter for the
subsequent GET request to get the next batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
items:
$ref: '#/components/schemas/DbSystemSummary'
type: array
400:
$ref: '#/components/responses/400-BadRequest'
401:
$ref: '#/components/responses/401-Unauthorized'
404:
$ref: '#/components/responses/404-NotFound'
429:
$ref: '#/components/responses/429-TooManyRequests'
500:
$ref: '#/components/responses/500-ServerError'
default:
$ref: '#/components/responses/DefaultError'
summary: List DB Systems.
tags:
- dbSystem
x-obmcs-client-retries-enabled: true
post:
description: 'Creates and launches a DB System.
'
operationId: CreateDbSystem
parameters:
- $ref: '#/components/parameters/OpcRequestIdHeader'
- $ref: '#/components/parameters/OpcRetryTokenHeader'
responses:
201:
description: 'The request was successfully received and the empty DB System creation is in-progress.
'
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
location:
description: The URI for the entity being described in the response body.
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/DbSystem'
400:
$ref: '#/components/responses/400-BadRequest'
401:
$ref: '#/components/responses/401-Unauthorized'
404:
$ref: '#/components/responses/404-NotFound'
409:
$ref: '#/components/responses/409-Conflict'
429:
$ref: '#/components/responses/429-TooManyRequests'
500:
$ref: '#/components/responses/500-ServerError'
default:
$ref: '#/components/responses/DefaultError'
summary: Create and launch a DB System.
tags:
- dbSystem
x-example: "Example I Create a MySQL DB System:\n POST /20190415/dbSystems\n Host: mysql.us-ashburn-1.ocp.oraclecloud.com\n <authorization and other headers>\n {\n \"adminPassword\": \"<password>\",\n \"adminUsername\": \"adminUser\",\n \"compartmentId\": \"ocid1.compartment.oc1..<UniqueID>\",\n \"configurationId\": \"ocid1.mysqlconfiguration.oc1..<UniqueID>\",\n \"dataStorageSizeInGBs\": 63,\n \"description\": \"MySQL Database Service\",\n \"displayName\": \"DBSystem001\",\n \"shapeName\": \"VM.Standard.E2.1\",\n \"subnetId\": \"ocid1.subnet.oc1.iad.<UniqueID>\",\n \"mysqlVersion\": \"8.0.20\"\n }\n\nExample II Create a MySQL DB System with Backups enabled:\n POST /20190415/dbSystems\n Host: mysql.us-ashburn-1.ocp.oraclecloud.com\n <authorization and other headers>\n {\n \"adminPassword\": \"<password>\",\n \"adminUsername\": \"adminUser\",\n \"compartmentId\": \"ocid1.compartment.oc1..<UniqueID>\",\n \"configurationId\": \"ocid1.mysqlconfiguration.oc1..<UniqueID>\",\n \"dataStorageSizeInGBs\": 63,\n \"description\": \"MySQL Database Service\",\n \"displayName\": \"DBSystem002\",\n \"shapeName\": \"VM.Standard.E2.1\",\n \"subnetId\": \"ocid1.subnet.oc1.iad.<UniqueID>\",\n \"mysqlVersion\": \"8.0.20\",\n \"pointInTimeRecoveryDetails\": {\n \"timeEarliestRecoveryPoint\": \"2021-12-31T06:30:30.000Z\",\n \"timeLatestRecoveryPoint\": \"2022-01-31T03:01:30.000Z\"\n },\n \"backupPolicy\": {\n \"isEnabled\": true,\n \"windowStartTime\": \"01:00-00:00\",\n \"copyPolicies\": [\n {\n \"copyToRegion\": \"us-ashburn-1\",\n \"backupCopyRetentionInDays\": 1\n }\n ],\n \"retentionInDays\": 30,\n \"pitrPolicy\": {\n \"isEnabled\": true | false\n }\n }\n }\n"
x-obmcs-client-retries-enabled: true
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateDbSystemDetails'
description: Request to create a DB System.
required: true
/dbSystems/{dbSystemId}:
delete:
description: 'Delete a DB System, including terminating, detaching,
removing, finalizing and otherwise deleting all related resources.
'
operationId: DeleteDbSystem
parameters:
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/OpcRequestIdHeader'
- $ref: '#/components/parameters/DbSystemIdPathParam'
responses:
202:
description: The request to delete the resource was successful.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400-BadRequest'
401:
$ref: '#/components/responses/401-Unauthorized'
404:
$ref: '#/components/responses/404-NotFound'
412:
$ref: '#/components/responses/412-PreconditionFailed'
429:
$ref: '#/components/responses/429-TooManyRequests'
500:
$ref: '#/components/responses/500-ServerError'
default:
$ref: '#/components/responses/DefaultError'
summary: Delete a DB System.
tags:
- dbSystem
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/DbSystem'
get:
description: Get information about the specified DB System.
operationId: GetDbSystem
parameters:
- $ref: '#/components/parameters/OpcRequestIdHeader'
- $ref: '#/components/parameters/IfNoneMatchHeader'
- $ref: '#/components/parameters/DbSystemIdPathParam'
responses:
200:
description: The DB System.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/DbSystem'
304:
$ref: '#/components/responses/304-NotModified'
400:
$ref: '#/components/responses/400-BadRequest'
401:
$ref: '#/components/responses/401-Unauthorized'
404:
$ref: '#/components/responses/404-NotFound'
429:
$ref: '#/components/responses/429-TooManyRequests'
500:
$ref: '#/components/responses/500-ServerError'
default:
$ref: '#/components/responses/DefaultError'
summary: Get a DB System.
tags:
- dbSystem
x-obmcs-client-retries-enabled: true
put:
description: 'Update the configuration of a DB System.
Updating different fields in the DB System will have different results
on the uptime of the DB System. For example, changing the displayName of
a DB System will take effect immediately, but changing the shape of a
DB System is an asynchronous operation that involves provisioning new
Compute resources, pausing the DB System and migrating storage
before making the DB System available again.
'
operationId: UpdateDbSystem
parameters:
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/OpcRequestIdHeader'
- $ref: '#/components/parameters/DbSystemIdPathParam'
responses:
202:
description: 'Accepted for update. This may or may not be an asynchronous
process, but a Work Request will be created regardless.
'
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400-BadRequest'
401:
$ref: '#/components/responses/401-Unauthorized'
404:
$ref: '#/components/responses/404-NotFound'
409:
$ref: '#/components/responses/409-Conflict'
412:
$ref: '#/components/responses/412-PreconditionFailed'
429:
$ref: '#/components/responses/429-TooManyRequests'
500:
$ref: '#/components/responses/500-ServerError'
default:
$ref: '#/components/responses/DefaultError'
summary: Update a DB System.
tags:
- dbSystem
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/DbSystem'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateDbSystemDetails'
description: Request to update a DB System.
required: true
/dbSystems/{dbSystemId}/actions/controlledUpdate:
post:
description: 'Update the chosen subset of MySQL instances based on their role.
'
operationId: ControlledUpdateDbSystem
parameters:
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/OpcRequestIdHeader'
- $ref: '#/components/parameters/OpcRetryTokenHeader'
- $ref: '#/components/parameters/DbSystemIdPathParam'
responses:
202:
description: 'The controlled update action has been accepted for processing.
'
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400-BadRequest'
401:
$ref: '#/components/responses/401-Unauthorized'
404:
$ref: '#/components/responses/404-NotFound'
409:
$ref: '#/components/responses/409-Conflict'
412:
$ref: '#/components/responses/412-PreconditionFailed'
429:
$ref: '#/components/responses/429-TooManyRequests'
500:
$ref: '#/components/responses/500-ServerError'
default:
$ref: '#/components/responses/DefaultError'
summary: Update the selected MySQL instance types.
tags:
- dbSystem
x-obmcs-client-retries-enabled: true
x-obmcs-terraform:
actionType: MANAGEMENT_RESOURCE
x-related-resource: '#/definitions/DbSystem'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ControlledUpdateDbSystemDetails'
description: Required parameters for the controlled update action.
required: true
/dbSystems/{dbSystemId}/actions/generateDbSystemStatus:
post:
description: "Initiates an asynchronous request to collect the current status of the specified DB System, \nincluding the status of any attached Channels (if requested).\n"
operationId: GenerateDbSystemStatus
parameters:
- $ref: '#/components/parameters/OpcRequestIdHeader'
- $ref: '#/components/parameters/OpcRetryTokenHeader'
- $ref: '#/components/parameters/DbSystemIdPathParam'
responses:
201:
description: "The status generation request was accepted and is being processed asynchronously. \nWhen processing completes, the DB System status can be retrieved using the \nGET /dbSystems/{dbSystemId}/dbSystemStatus endpoint.\n"
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/DbSystemStatus'
400:
$ref: '#/components/responses/400-BadRequest'
401:
$ref: '#/components/responses/401-Unauthorized'
404:
$ref: '#/components/responses/404-NotFound'
409:
$ref: '#/components/responses/409-Conflict'
429:
$ref: '#/components/responses/429-TooManyRequests'
500:
$ref: '#/components/responses/500-ServerError'
default:
$ref: '#/components/responses/DefaultError'
summary: Generate DB System status.
tags:
- dbSystem
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/DbSystemStatus'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GenerateDbSystemStatusDetails'
description: The parameters for selecting the attributes to collect the status of.
required: true
/dbSystems/{dbSystemId}/actions/restart:
post:
description: Restarts the specified DB System.
operationId: RestartDbSystem
parameters:
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/OpcRequestIdHeader'
- $ref: '#/components/parameters/OpcRetryTokenHeader'
- $ref: '#/components/parameters/DbSystemIdPathParam'
responses:
202:
description: 'The DB System restart action has been accepted for processing.
'
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400-BadRequest'
401:
$ref: '#/components/responses/401-Unauthorized'
404:
$ref: '#/components/responses/404-NotFound'
409:
$ref: '#/components/responses/409-Conflict'
412:
$ref: '#/components/responses/412-PreconditionFailed'
429:
$ref: '#/components/responses/429-TooManyRequests'
500:
$ref: '#/components/responses/500-ServerError'
default:
$ref: '#/components/responses/DefaultError'
summary: Restarts a DB System.
tags:
- dbSystem
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/DbSystem'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RestartDbSystemDetails'
description: Optional parameters for the stop portion of the restart action.
required: true
/dbSystems/{dbSystemId}/actions/start:
post:
description: Start the specified DB System.
operationId: StartDbSystem
parameters:
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/OpcRequestIdHeader'
- $ref: '#/components/parameters/OpcRetryTokenHeader'
- $ref: '#/components/parameters/DbSystemIdPathParam'
responses:
202:
description: The DB System start action has been accepted for processing.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400-BadRequest'
401:
$ref: '#/components/responses/401-Unauthorized'
404:
$ref: '#/components/responses/404-NotFound'
409:
$ref: '#/components/responses/409-Conflict'
412:
$ref: '#/components/responses/412-PreconditionFailed'
429:
$ref: '#/components/responses/429-TooManyRequests'
500:
$ref: '#/components/responses/500-ServerError'
default:
$ref: '#/components/responses/DefaultError'
summary: Starts a DB System.
tags:
- dbSystem
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/DbSystem'
/dbSystems/{dbSystemId}/actions/stop:
post:
description: 'Stops the specified DB System.
A stopped DB System is not billed.
'
operationId: StopDbSystem
parameters:
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/OpcRequestIdHeader'
- $ref: '#/components/parameters/OpcRetryTokenHeader'
- $ref: '#/components/parameters/DbSystemIdPathParam'
responses:
202:
description: 'The DB System Stop action has been accepted for processing.
'
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400-BadRequest'
401:
$ref: '#/components/responses/401-Unauthorized'
404:
$ref: '#/components/responses/404-NotFound'
409:
$ref: '#/components/responses/409-Conflict'
412:
$ref: '#/components/responses/412-PreconditionFailed'
429:
$ref: '#/components/responses/429-TooManyRequests'
500:
$ref: '#/components/responses/500-ServerError'
default:
$ref: '#/components/responses/DefaultError'
summary: Stops a DB System.
tags:
- dbSystem
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/DbSystem'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/StopDbSystemDetails'
description: Optional parameters for the stop action.
required: true
/dbSystems/{dbSystemId}/dbSystemStatus:
get:
description: "Returns the most up-to-date status of the specified DB System, \nincluding the status of any requested Channels.\n"
operationId: GetDbSystemStatus
parameters:
- $ref: '#/components/parameters/OpcRequestIdHeader'
- $ref: '#/components/parameters/DbSystemIdPathParam'
responses:
200:
description: 'The most recent status of the DB System along with the status of the requested Channels.
'
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/DbSystemStatus'
400:
$ref: '#/components/responses/400-BadRequest'
401:
$ref: '#/components/responses/401-Unauthorized'
404:
$ref: '#/components/responses/404-NotFound'
409:
$ref: '#/components/responses/409-Conflict'
429:
$ref: '#/components/responses/429-TooManyRequests'
500:
$ref: '#/components/responses/500-ServerError'
default:
$ref: '#/components/responses/DefaultError'
summary: Get DB System status.
tags:
- dbSystem
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/DbSystemStatus'
/dbSystems/{dbSystemId}/heatWaveCluster:
delete:
description: 'Deletes the HeatWave cluster including terminating, detaching, removing, finalizing and
otherwise deleting all related resources.
'
operationId: DeleteHeatWaveCluster
parameters:
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/OpcRequestIdHeader'
- $ref: '#/components/parameters/DbSystemIdPathParam'
responses:
202:
description: 'The request was successfully received and the HeatWave cluster deletion is in progress.
'
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400-BadRequest'
401:
$ref: '#/components/responses/401-Unauthorized'
404:
$ref: '#/components/responses/404-NotFound'
412:
$ref: '#/components/responses/412-PreconditionFailed'
429:
$ref: '#/components/responses/429-TooManyRequests'
500:
$ref: '#/components/responses/500-ServerError'
default:
$ref: '#/components/responses/DefaultError'
summary: Delete HeatWave cluster.
tags:
- dbSystem
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/HeatWaveCluster'
get:
description: Gets information about the HeatWave cluster.
operationId: GetHeatWaveCluster
parameters:
- $ref: '#/components/parameters/OpcRequestIdHeader'
- $ref: '#/components/parameters/IfNoneMatchHeader'
- $ref: '#/components/parameters/DbSystemIdPathParam'
responses:
200:
description: The HeatWave cluster.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/HeatWaveCluster'
304:
$ref: '#/components/responses/304-NotModified'
400:
$ref: '#/components/responses/400-BadRequest'
401:
$ref: '#/components/responses/401-Unauthorized'
404:
$ref: '#/components/responses/404-NotFound'
429:
$ref: '#/components/responses/429-TooManyRequests'
500:
$ref: '#/components/responses/500-ServerError'
default:
$ref: '#/components/responses/DefaultError'
summary: Get HeatWave cluster details.
tags:
- dbSystem
x-obmcs-client-retries-enabled: true
put:
description: 'Updates the HeatWave cluster.
'
operationId: UpdateHeatWaveCluster
parameters:
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/OpcRequestIdHeader'
- $ref: '#/components/parameters/DbSystemIdPathParam'
responses:
202:
description: 'The request was successfully received and the HeatWave cluster update is in progress.
'
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400-BadRequest'
401:
$ref: '#/components/responses/401-Unauthorized'
404:
$ref: '#/components/responses/404-NotFound'
409:
$ref: '#/components/responses/409-Conflict'
412:
$ref: '#/components/responses/412-PreconditionFailed'
429:
$ref: '#/components/responses/429-TooManyRequests'
500:
$ref: '#/components/responses/500-ServerError'
default:
$ref: '#/components/responses/DefaultError'
summary: Update HeatWave cluster.
tags:
- dbSystem
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/HeatWaveCluster'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateHeatWaveClusterDetails'
description: Request to update a HeatWave cluster.
required: true
/dbSystems/{dbSystemId}/heatWaveCluster/actions/add:
post:
description: 'Adds a HeatWave cluster to the DB System.
'
operationId: AddHeatWaveCluster
parameters:
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/OpcRequestIdHeader'
- $ref: '#/components/parameters/OpcRetryTokenHeader'
- $ref: '#/components/parameters/DbSystemIdPathParam'
responses:
201:
description: 'The request was successfully received and the HeatWave cluster creation is in progress.
'
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/HeatWaveCluster'
400:
$ref: '#/components/responses/400-BadRequest'
401:
$ref: '#/components/responses/401-Unauthorized'
404:
$ref: '#/components/responses/404-NotFound'
409:
$ref: '#/components/responses/409-Conflict'
412:
$ref: '#/components/responses/412-PreconditionFailed'
429:
$ref: '#/components/responses/429-TooManyRequests'
500:
$ref: '#/components/responses/500-ServerError'
default:
$ref: '#/components/responses/DefaultError'
summary: Add HeatWave cluster.
tags:
- dbSystem
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/HeatWaveCluster'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AddHeatWaveClusterDetails'
description: Request to add a HeatWave cluster.
required: true
/dbSystems/{dbSystemId}/heatWaveCluster/actions/restart:
post:
description: Restarts the HeatWave cluster.
operationId: RestartHeatWaveCluster
parameters:
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/OpcRequestIdHeader'
- $ref: '#/components/parameters/OpcRetryTokenHeader'
- $ref: '#/components/parameters/DbSystemIdPathParam'
responses:
202:
description: The Restart HeatWave cluster action has been accepted for processing.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400-BadRequest'
401:
$ref: '#/components/responses/401-Unauthorized'
404:
$ref: '#/components/responses/404-NotFound'
409:
$ref: '#/components/responses/409-Conflict'
412:
$ref: '#/components/responses/412-PreconditionFailed'
429:
$ref: '#/components/responses/429-TooManyRequests'
500:
$ref: '#/components/responses/500-ServerError'
default:
$ref: '#/components/responses/DefaultError'
summary: Restart HeatWave cluster.
tags:
- dbSystem
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/HeatWaveCluster'
/dbSystems/{dbSystemId}/heatWaveCluster/actions/start:
post:
description: Starts the HeatWave cluster.
operationId: StartHeatWaveCluster
parameters:
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/OpcRequestIdHeader'
- $ref: '#/components/parameters/OpcRetryTokenHeader'
- $ref: '#/components/parameters/DbSystemIdPathParam'
responses:
202:
description: The Start HeatWave cluster action has been accepted for processing.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400-BadRequest'
401:
$ref: '#/components/responses/401-Unauthorized'
404:
$ref: '#/components/responses/404-NotFound'
409:
$ref: '#/components/responses/409-Conflict'
412:
$ref: '#/components/responses/412-PreconditionFailed'
429:
$ref: '#/components/responses/429-TooManyRequests'
500:
$ref: '#/components/responses/500-ServerError'
default:
$ref: '#/components/responses/DefaultError'
summary: Start HeatWave cluster.
tags:
- dbSystem
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/HeatWaveCluster'
/dbSystems/{dbSystemId}/heatWaveCluster/actions/stop:
post:
description: Stops the HeatWave cluster.
operationId: StopHeatWaveCluster
parameters:
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/OpcRequestIdHeader'
- $ref: '#/components/parameters/OpcRetryTokenHeader'
- $ref: '#/components/parameters/DbSystemIdPathParam'
responses:
202:
description: The Stop HeatWave cluster action has been accepted for processing.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400-BadRequest'
401:
$ref: '#/components/responses/401-Unauthorized'
404:
$ref: '#/components/responses/404-NotFound'
409:
$ref: '#/components/responses/409-Conflict'
412:
$ref: '#/components/responses/412-PreconditionFailed'
429:
$ref: '#/components/responses/429-TooManyRequests'
500:
$ref: '#/components/responses/500-ServerError'
default:
$ref: '#/components/responses/DefaultError'
summary: Stop HeatWave cluster.
tags:
- dbSystem
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/HeatWaveCluster'
/dbSystems/{dbSystemId}/heatWaveClusterMemoryEstimate:
get:
description: 'Gets the most recent HeatWave cluster memory estimate that can be used to determine a suitable
HeatWave cluster size.
'
operationId: GetHeatWaveClusterMemoryEstimate
parameters:
- $ref: '#/components/parameters/OpcRequestIdHeader'
- $ref: '#/components/parameters/DbSystemIdPathParam'
responses:
200:
description: 'Returns the most recent HeatWave cluster memory estimate of the specified DB System that can be
used to determine a suitable HeatWave cluster size. For each user table the estimated memory footprint
when the table is loaded to the HeatWave cluster memory is returned.
'
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/HeatWaveClusterMemoryEstimate'
400:
$ref: '#/components/responses/400-BadRequest'
401:
$ref: '#/components/responses/401-Unauthorized'
404:
$ref: '#/components/responses/404-NotFound'
409:
$ref: '#/components/responses/409-Conflict'
429:
$ref: '#/components/responses/429-TooManyRequests'
500:
$ref: '#/components/responses/500-ServerError'
default:
$ref: '#/components/responses/DefaultError'
summary: Get HeatWave cluster memory estimate.
tags:
- dbSystem
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/HeatWaveClusterMemoryEstimate'
/dbSystems/{dbSystemId}/heatWaveClusterMemoryEstimate/actions/generate:
post:
description: 'Sends a request to estimate the memory footprints of user tables when loaded to HeatWave cluster memory.
'
operationId: GenerateHeatWaveClusterMemoryEstimate
parameters:
- $ref: '#/components/parameters/OpcRequestIdHeader'
- $ref: '#/components/parameters/OpcRetryTokenHeader'
- $ref: '#/components/parameters/DbSystemIdPathParam'
responses:
201:
description: 'The request has been accepted for processing. Once this request has completed,
the result can be queried via the `GET /dbSystems/{dbSystemId}/heatWaveClusterMemoryEstimate` API call.
'
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/HeatWaveClusterMemoryEstimate'
400:
$ref: '#/components/responses/400-BadRequest'
401:
$ref: '#/components/responses/401-Unauthorized'
404:
$ref: '#/components/responses/404-NotFound'
409:
$ref: '#/components/responses/409-Conflict'
429:
$ref: '#/components/responses/429-TooManyRequests'
500:
$ref: '#/components/responses/500-ServerError'
default:
$ref: '#/components/responses/DefaultError'
summary: Generate HeatWave cluster memory estimate.
tags:
- dbSystem
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/HeatWaveClusterMemoryEstimate'
/dbSystems/{dbSystemId}/maintenanceEvents:
get:
description: List all the maintenance events.
operationId: ListMaintenanceEvents
parameters:
- $ref: '#/components/parameters/OpcRequestIdHeader'
- $ref: '#/components/parameters/DbSystemIdPathParam'
- $ref: '#/components/parameters/FilterByMaintenanceEventMysqlVersionBeforeMaintenanceQueryParam'
- $ref: '#/components/parameters/FilterByMaintenanceEventMysqlVersionAfterMaintenanceQueryParam'
- $ref: '#/components/parameters/FilterByMaintenanceTypeQueryParam'
- $ref: '#/components/parameters/FilterByMaintenanceActionQueryParam'
- $ref: '#/components/parameters/FilterByMaintenanceEventMaintenanceStatusQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortByMaintenanceEventFieldQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
responses:
200:
description: 'The list of maintenance events for a given DB System.
'
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then a partial list might have been returned. Include this value as the `page` parameter for the
subsequent GET request to get the next batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
items:
$ref: '#/components/schemas/MaintenanceEvent'
type: array
400:
$ref: '#/components/responses/400-BadRequest'
401:
$ref: '#/components/responses/401-Unauthorized'
404:
$ref: '#/components/responses/404-NotFound'
429:
$ref: '#/components/responses/429-TooManyRequests'
500:
$ref: '#/components/responses/500-ServerError'
default:
$ref: '#/components/responses/DefaultError'
summary: List maintenance events.
tags:
- dbSystem
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/MaintenanceEvent'
components:
schemas:
SecureConnectionDetails:
description: 'Secure connection configuration details.
'
properties:
certificateGenerationType:
default: SYSTEM
description: 'Select whether to use MySQL Database Service-managed certificate (SYSTEM) or your own certificate (BYOC).
'
enum:
- SYSTEM
- BYOC
type: string
x-obmcs-top-level-enum: '#/definitions/CertificateGenerationType'
certificateId:
description: The OCID of the certificate to use.
maxLength: 255
type: string
required:
- certificateGenerationType
Error:
description: Sorry.
properties:
code:
description: 'A short error code that defines the error, meant for programmatic parsing. See
[API Errors](/Content/API/References/apierrors.htm).
'
type: string
message:
description: A human-readable error string.
type: string
required:
- code
- message
ChannelSource:
description: Parameters detailing how to provision the source for the given Channel.
discriminator:
propertyName: sourceType
properties:
sourceType:
description: The specific source identifier.
enum:
- MYSQL
type: string
required:
- sourceType
PointInTimeRecoveryDetails:
description: 'Point-in-time Recovery details like earliest and latest recovery time point for the DB System.
'
properties:
timeEarliestRecoveryPoint:
description: 'Earliest recovery time point for the DB System, as described by [RFC 3339](https://tools.ietf.org/rfc/rfc3339).
'
format: date-time
type: string
timeLatestRecoveryPoint:
description: 'Latest recovery time point for the DB System, as described by [RFC 3339](https://tools.ietf.org/rfc/rfc3339).
'
format: date-time
type: string
required:
- timeEarliestRecoveryPoint
- timeLatestRecoveryPoint
CreateTelemetryConfigurationDetails:
allOf:
- $ref: '#/components/schemas/TelemetryConfigurationDetails'
description: 'Details required to configure how MySQL telemetry should be exposed.
'
CreateRestDetails:
description: 'Details required to configure REST while creating a DB System.
'
properties:
configuration:
default: DISABLED
description: Select how REST is configured across the DB System instances.
enum:
- DISABLED
- DBSYSTEM_ONLY
type: string
x-obmcs-top-level-enum: '#/definitions/RestConfigurationType'
port:
default: 443
description: The port for REST to listen on. Supported port numbers are 443 and from 1024 to 65535.
maximum: 65535
minimum: 443
type: integer
required:
- configuration
HeatWaveClusterSummary:
description: 'A summary of a HeatWave cluster.
'
properties:
clusterSize:
description: 'The number of analytics-processing compute instances, of the
specified shape, in the HeatWave cluster.
'
maximum: 512
minimum: 1
type: integer
isLakehouseEnabled:
description: Lakehouse enabled status for the HeatWave cluster.
type: boolean
lifecycleState:
description: The current state of the MySQL HeatWave cluster.
type: string
x-obmcs-enumref: '#/definitions/HeatWaveCluster/lifecycleState'
shapeName:
description: 'The shape determines resources to allocate to the HeatWave
nodes - CPU cores, memory.
'
maxLength: 255
minLength: 1
type: string
timeCreated:
description: 'The date and time the HeatWave cluster was created,
as described by [RFC 3339](https://tools.ietf.org/rfc/rfc3339).
'
format: date-time
type: string
timeUpdated:
description: 'The time the HeatWave cluster was last updated,
as described by [RFC 3339](https://tools.ietf.org/rfc/rfc3339).
'
format: date-time
type: string
required:
- shapeName
- clusterSize
- lifecycleState
- timeCreated
- timeUpdated
ControlledUpdateDbSystemDetails:
description: 'Details of the controlled update action, including the target subset of MySQL instances to update based on their role.
'
properties:
targetDbInstances:
description: "Defines the MySQL instances to be operated during a controlled update. \n - ALL_BUT_PRIMARY: Update all MySQL instances in a highly available DB System except the primary group member, \n without triggering a controlled failover.\n - PRIMARY_ONLY: Update the primary group member in a highly available DB System \n after a controlled failover (downtime is expected). This operation requires that the other \n MySQL instances have been previously updated using the ALL_BUT_PRIMARY option.\n"
enum:
- ALL_BUT_PRIMARY
- PRIMARY_ONLY
type: string
x-obmcs-top-level-enum: '#/definitions/ControlledUpdateTargetDbInstances'
targetMysqlVersion:
description: The MySQL version to be applied to the selected instances.
type: string
CreateBackupPolicyDetails:
description: 'Backup policy as optionally used for DB System Creation.
'
properties:
copyPolicies:
description: 'List of policies of a DB system to schedule cross-region DB system backup copy.
The policy includes the name of the destination region to which the DB system backup will be copied, and
an optional parameter which specifies the retention period of the copied DB system backup in days.
**Note:** Currently, only one policy can be specified in the list.
'
items:
$ref: '#/components/schemas/CopyPolicy'
type: array
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Usage of predefined tag keys. These predefined keys are scoped to namespaces.
Tags defined here will be copied verbatim as tags on the Backup resource created by this BackupPolicy.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair applied without any predefined name, type or scope. Exists for cross-compatibility only.
Tags defined here will be copied verbatim as tags on the Backup resource created by this BackupPolicy.
Example: `{"bar-key": "value"}`
'
type: object
isEnabled:
default: true
description: 'Specifies if automatic backups are enabled.
'
type: boolean
pitrPolicy:
$ref: '#/components/schemas/PitrPolicy'
retentionInDays:
default: 7
description: Number of days to retain an automatic backup.
maximum: 35
minimum: 1
type: integer
softDelete:
description: 'Retains the backup to be deleted due to the retention policy in DELETE SCHEDULED
state for 7 days before permanently deleting it.
'
enum:
- ENABLED
- DISABLED
type: string
x-obmcs-top-level-enum: '#/definitions/SoftDelete'
windowStartTime:
description: 'The start of a 30-minute window of time in which daily, automated backups occur.
This should be in the format of the "Time" portion of an RFC3339-formatted timestamp. Any second or sub-second time data will be truncated to zero.
At some point in the window, the system may incur a brief service disruption as the backup is performed.
'
type: string
x-default-description: 'If not defined, a window is selected from the following Region-based time-spans:
- eu-frankfurt-1: 20:00 - 04:00 UTC
- us-ashburn-1: 03:00 - 11:00 UTC
- uk-london-1: 06:00 - 14:00 UTC
- ap-tokyo-1: 13:00 - 21:00
- us-phoenix-1: 06:00 - 14:00
'
CreateMaintenanceDetails:
description: 'The Maintenance Policy for the DB System or Read Replica that this model is included in.
'
properties:
maintenanceDisabledWindows:
description: 'Time window during which downtime-inducing maintenance shall not be performed.
Downtime-free maintenance may be performed to apply required security patches.
At most one configured window is supported.
'
items:
$ref: '#/components/schemas/MaintenanceDisabledWindow'
maxItems: 1
minItems: 0
type: array
maintenanceScheduleType:
default: REGULAR
description: 'The maintenance schedule type of the DB system. Defaults to REGULAR.
EARLY: Maintenance schedule follows a cycle where upgrades are performed when versions become deprecated.
REGULAR: Maintenance schedule follows the normal cycle where upgrades are performed when versions become unavailable.
'
enum:
- EARLY
- REGULAR
type: string
x-obmcs-top-level-enum: '#/definitions/MaintenanceScheduleType'
versionPreference:
default: OLDEST
description: 'The preferred version to target when performing an automatic MySQL upgrade. Defaults to OLDEST.
OLDEST: Choose the oldest available MySQL version based on the current version of the DB System.
SECOND_NEWEST: Choose the MySQL version before the newest for auto-upgrade.
NEWEST: Choose the latest and greatest MySQL version available for auto-upgrade.
'
enum:
- OLDEST
- SECOND_NEWEST
- NEWEST
type: string
x-obmcs-top-level-enum: '#/definitions/VersionPreference'
versionTrackPreference:
default: FOLLOW
description: 'The preferred version track to target when performing an automatic MySQL upgrade. Defaults to FOLLOW.
LONG_TERM_SUPPORT: No MySQL database behavior changes.
INNOVATION: Provides access to the latest features and all bug fixes.
FOLLOW: Follows the track of the current MySQL version.
'
enum:
- LONG_TERM_SUPPORT
- INNOVATION
- FOLLOW
type: string
x-obmcs-top-level-enum: '#/definitions/VersionTrackPreference'
windowStartTime:
description: 'The start of the 2 hour maintenance window.
This string is of the format: "{day-of-week} {time-of-day}".
"{day-of-week}" is a case-insensitive string like "mon", "tue", &c.
"{time-of-day}" is the "Time" portion of an RFC3339-formatted timestamp. Any second or sub-second time data will be truncated to zero.
If you set the read replica maintenance window to "" or if not specified, the read replica is set same as the DB system maintenance window.
'
type: string
required:
- windowStartTime
UpdateDbSystemDetails:
description: 'Details required to update a DB System.
'
properties:
accessMode:
description: "The access mode indicating if the database access will be restricted only to administrators or not:\n - UNRESTRICTED: the access to the database is not restricted;\n - RESTRICTED: the access will be allowed only to users with specific privileges; \n RESTRICTED will correspond to setting the MySQL system variable \n [offline_mode](https://dev.mysql.com/doc/en/server-system-variables.html#sysvar_offline_mode) to ON.\n"
type: string
x-obmcs-enumref: '#/definitions/DbSystem/accessMode'
adminPassword:
description: 'The password for the administrative user. The password must be
between 8 and 32 characters long, and must contain at least 1
numeric character, 1 lowercase character, 1 uppercase character, and
1 special (nonalphanumeric) character.
'
format: password
maxLength: 32
minLength: 8
type: string
adminUsername:
description: The username for the administrative user for the MySQL Instance.
maxLength: 32
minLength: 1
type: string
availabilityDomain:
description: 'The availability domain on which to deploy the Read/Write endpoint. This defines the preferred primary instance.
In a failover scenario, the Read/Write endpoint is redirected to one of the other availability domains
and the MySQL instance in that domain is promoted to the primary instance.
This redirection does not affect the IP address of the DB System in any way.
For a standalone DB System, this defines the availability domain in which the DB System is placed.
'
maxLength: 255
minLength: 1
type: string
backupPolicy:
$ref: '#/components/schemas/UpdateBackupPolicyDetails'
configurationId:
description: The OCID of the Configuration to be used for Instances in this DB System.
maxLength: 255
minLength: 1
type: string
crashRecovery:
default: ENABLED
description: 'Whether to run the DB System with InnoDB Redo Logs and the Double Write Buffer enabled or disabled,
and whether to enable or disable syncing of the Binary Logs.
'
enum:
- ENABLED
- DISABLED
type: string
x-obmcs-top-level-enum: '#/definitions/CrashRecoveryStatus'
customerContacts:
description: "The list of customer email addresses that receive information from Oracle about the specified OCI DB System resource. \nOracle uses these email addresses to send notifications about planned and unplanned software maintenance updates, information about system hardware, and other information needed by administrators. \nUp to 10 email addresses can be added to the customer contacts for a DB System.\n"
items:
$ref: '#/components/schemas/CustomerContact'
maxItems: 10
type: array
dataStorage:
$ref: '#/components/schemas/DataStorageDetails'
dataStorageSizeInGBs:
description: 'Expands the DB System''s storage to the specified value. Only supports values larger than the current DB System''s
storage size.
DB Systems with an initial storage size of 400 GB or less can be expanded up to 32 TB.
DB Systems with an initial storage size between 401-800 GB can be expanded up to 64 TB.
DB Systems with an initial storage size between 801-1200 GB can be expanded up to 96 TB.
DB Systems with an initial storage size of 1201 GB or more can be expanded up to 128 TB.
It is not possible to decrease data storage size.
'
maximum: 131072
minimum: 100
type: integer
databaseConsole:
$ref: '#/components/schemas/UpdateDatabaseConsoleDetails'
databaseManagement:
default: ENABLED
description: 'Whether to enable monitoring via the Database Management service.
'
enum:
- ENABLED
- DISABLED
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseManagementStatus'
databaseMode:
description: "The database mode indicating the types of statements that will be allowed to run in the DB system.\nThis mode will apply only to statements run by user connections. Replicated write statements will continue \nto be allowed regardless of the DatabaseMode.\n - READ_WRITE: allow running read and write statements on the DB system;\n - READ_ONLY: only allow running read statements on the DB system.\n"
type: string
x-obmcs-enumref: '#/definitions/DbSystem/databaseMode'
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Usage of predefined tag keys. These predefined keys are scoped to namespaces.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
deletionPolicy:
$ref: '#/components/schemas/UpdateDeletionPolicyDetails'
description:
description: User-provided data about the DB System.
maxLength: 400
minLength: 1
type: string
displayName:
description: The user-friendly name for the DB System. It does not have to be unique.
maxLength: 255
minLength: 1
type: string
encryptData:
$ref: '#/components/schemas/EncryptDataDetails'
faultDomain:
description: 'The fault domain on which to deploy the Read/Write endpoint. This defines the preferred primary instance.
In a failover scenario, the Read/Write endpoint is redirected to one of the other fault domains
and the MySQL instance in that domain is promoted to the primary instance.
This redirection does not affect the IP address of the DB System in any way.
For a standalone DB System, this defines the fault domain in which the DB System is placed.
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
hostnameLabel:
description: 'The hostname for the primary endpoint of the DB System. Used for DNS.
The value is the hostname portion of the primary private IP''s fully qualified domain name (FQDN)
(for example, "dbsystem-1" in FQDN "dbsystem-1.subnet123.vcn1.oraclevcn.com").
Must be unique across all VNICs in the subnet and comply with RFC 952 and RFC 1123.
'
type: string
ipAddress:
description: 'The IP address the DB System should be configured to listen on the provided subnet.
It must be a free private IP address within the subnet''s CIDR. If you don''t specify a
value, Oracle automatically assigns a private IP address from the subnet. This should
be a "dotted-quad" style IPv4 address.
'
type: string
ipv6AddressIpv6SubnetCidrPairDetails:
$ref: '#/components/schemas/Ipv6AddressIpv6SubnetCidrPairDetails'
isHighlyAvailable:
default: true
description: 'Specifies if the DB System is highly available.
Set to true to enable high availability. Two secondary MySQL instances are created and placed in the unused
availability or fault domains, depending on your region and subnet type.
Set to false to disable high availability. The secondary MySQL instances are removed and the MySQL instance
in the preferred location is used.
'
type: boolean
isIpv6Enabled:
description: 'Whether to allocate an IPv6 address for the DB system in an IPv6 enabled subnet.
When provided you may optionally
provide an IPv6 prefix (ipv6AddressIpv6SubnetCidrPairDetails) of your choice to assign the IPv6
address from. If ipv6AddressIpv6SubnetCidrPairDetails is not provided then an IPv6 prefix is
chosen for you.
'
type: boolean
x-default-description: 'If you don''t specify a value, Oracle automatically use false for IPv4 or dual
stack (IPv4 + IPv6) subnets or true for single stack IPv6 subnets.
'
maintenance:
$ref: '#/components/schemas/UpdateMaintenanceDetails'
mysqlVersion:
description: The specific MySQL version identifier.
maxLength: 255
minLength: 1
type: string
nsgIds:
description: Network Security Group OCIDs used for the VNIC attachment.
items:
type: string
maxItems: 5
minItems: 0
type: array
uniqueItems: true
port:
description: The port for primary endpoint of the DB System to listen on.
maximum: 65535
minimum: 1024
type: integer
portX:
description: 'The TCP network port on which X Plugin listens for connections. This is the X Plugin equivalent of port.
'
maximum: 65535
minimum: 1024
type: integer
readEndpoint:
$ref: '#/components/schemas/UpdateReadEndpointDetails'
rest:
$ref: '#/components/schemas/UpdateRestDetails'
secureConnections:
$ref: '#/components/schemas/SecureConnectionDetails'
securityAttributes:
additionalProperties:
additionalProperties:
description: 'Security Attribute value and mode. Only the String type is supported for value. (Mode is reserved and “enforce” in this release)
'
type: object
description: 'Key-value pair representing a ZPR tag key and value, scoped to a namespace.
Example: `{"MaxEgressCount": {"value": "42", "mode": "audit"}}`
'
type: object
description: 'Security Attributes for this resource. Each key is predefined and scoped to a namespace.
For more information, see [ZPR Artifacts](https://docs.oracle.com/en-us/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm).
Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}`
'
type: object
shapeName:
description: 'The shape of the DB System. The shape determines resources
allocated to the DB System - CPU cores and memory for VM
shapes; CPU cores, memory and storage for non-VM (or bare metal)
shapes. To get a list of shapes, use the
[ListShapes](#/en/mysql/20190415/ShapeSummary/ListShapes)
operation.
Changes in Shape will result in a downtime as the MySQL DB System is
migrated to the new Compute instance.
'
maxLength: 255
minLength: 1
type: string
subnetId:
description: 'The OCID of the subnet the DB System is associated with.
'
maxLength: 255
minLength: 1
type: string
telemetryConfiguration:
$ref: '#/components/schemas/UpdateTelemetryConfigurationDetails'
HeatWaveCluster:
description: 'A HeatWave cluster is a database accelerator for a DB System.
'
properties:
clusterNodes:
description: A HeatWave node is a compute host that is part of a HeatWave cluster.
items:
$ref: '#/components/schemas/HeatWaveNode'
type: array
clusterSize:
description: 'The number of analytics-processing compute instances, of the
specified shape, in the HeatWave cluster.
'
maximum: 512
minimum: 1
type: integer
dbSystemId:
description: The OCID of the parent DB System this HeatWave cluster is attached to.
maxLength: 255
minLength: 1
type: string
isLakehouseEnabled:
description: Lakehouse enabled status for the HeatWave cluster.
type: boolean
lifecycleDetails:
description: Additional information about the current lifecycleState.
type: string
lifecycleState:
description: The current state of the HeatWave cluster.
enum:
- CREATING
- ACTIVE
- INACTIVE
- UPDATING
- DELETING
- DELETED
- FAILED
type: string
shapeName:
description: 'The shape determines resources to allocate to the HeatWave
nodes - CPU cores, memory.
'
maxLength: 255
minLength: 1
type: string
timeCreated:
description: 'The date and time the HeatWave cluster was created,
as described by [RFC 3339](https://tools.ietf.org/rfc/rfc3339).
'
format: date-time
type: string
timeUpdated:
description: 'The time the HeatWave cluster was last updated,
as described by [RFC 3339](https://tools.ietf.org/rfc/rfc3339).
'
format: date-time
type: string
required:
- dbSystemId
- shapeName
- clusterSize
- clusterNodes
- lifecycleState
- timeCreated
- timeUpdated
DbSystemEndpoint:
description: 'A particular functional endpoint for access to a DB System, and the properties that apply to it.
'
properties:
hostname:
description: The network address of the DB System.
type: string
ipAddress:
description: The IP address the DB System is configured to listen on.
type: string
ipAddressVersion:
description: The internet protocol (IP) version of the IP address.
enum:
- IPV4
- IPV6
type: string
modes:
description: The access modes from the client that this endpoint supports.
items:
enum:
- READ
- WRITE
type: string
type: array
uniqueItems: true
port:
description: The port the MySQL instance listens on.
maximum: 65535
minimum: 1024
type: integer
portX:
description: The network port where to connect to use this endpoint using the X protocol.
maximum: 65535
minimum: 1024
type: integer
status:
description: 'The state of the endpoints, as far as it can seen from the DB System.
There may be some inconsistency with the actual state of the MySQL service.
'
enum:
- ACTIVE
- INACTIVE
- UPDATING
type: string
statusDetails:
description: Additional information about the current endpoint status.
type: string
required:
- ipAddress
- port
- portX
DeletionPolicyDetails:
description: The Deletion policy for the DB System.
properties:
automaticBackupRetention:
default: RETAIN
description: 'Specifies if any automatic backups created for a DB System should be retained or deleted when the DB System is deleted.
'
enum:
- DELETE
- RETAIN
type: string
finalBackup:
default: SKIP_FINAL_BACKUP
description: "Specifies whether or not a backup is taken when the DB System is deleted.\n REQUIRE_FINAL_BACKUP: a backup is taken if the DB System is deleted.\n SKIP_FINAL_BACKUP: a backup is not taken if the DB System is deleted.\n"
enum:
- SKIP_FINAL_BACKUP
- REQUIRE_FINAL_BACKUP
type: string
isDeleteProtected:
default: false
description: 'Specifies whether the DB System can be deleted. Set to true to prevent deletion, false (default) to allow.
'
type: boolean
required:
- automaticBackupRetention
- finalBackup
- isDeleteProtected
ChannelTarget:
description: Details about the Channel target.
discriminator:
propertyName: targetType
properties:
targetType:
description: The specific target identifier.
enum:
- DBSYSTEM
type: string
required:
- targetType
CreateDbSystemDetails:
description: 'Details required to create a DB System.
'
properties:
accessMode:
default: UNRESTRICTED
description: "The access mode indicating if the database access will be restricted only to administrators or not:\n - UNRESTRICTED (default): the access to the database is not restricted;\n - RESTRICTED: the access will be allowed only to users with specific privileges;\n RESTRICTED will correspond to setting the MySQL system variable \n [offline_mode](https://dev.mysql.com/doc/en/server-system-variables.html#sysvar_offline_mode) to ON.\n"
type: string
x-obmcs-enumref: '#/definitions/DbSystem/accessMode'
adminPassword:
description: 'The password for the administrative user. The password must be
between 8 and 32 characters long, and must contain at least 1
numeric character, 1 lowercase character, 1 uppercase character, and
1 special (nonalphanumeric) character.
'
format: password
maxLength: 32
minLength: 8
type: string
adminUsername:
description: The username for the administrative user.
maxLength: 32
minLength: 1
type: string
availabilityDomain:
description: 'The availability domain on which to deploy the Read/Write endpoint. This defines the preferred primary instance.
In a failover scenario, the Read/Write endpoint is redirected to one of the other availability domains
and the MySQL instance in that domain is promoted to the primary instance.
This redirection does not affect the IP address of the DB System in any way.
For a standalone DB System, this defines the availability domain in which the DB System is placed.
'
maxLength: 255
minLength: 1
type: string
backupPolicy:
$ref: '#/components/schemas/CreateBackupPolicyDetails'
compartmentId:
description: The OCID of the compartment.
maxLength: 255
minLength: 1
type: string
configurationId:
description: The OCID of the Configuration to be used for this DB System.
maxLength: 255
minLength: 1
type: string
crashRecovery:
default: ENABLED
description: 'Whether to run the DB System with InnoDB Redo Logs and the Double Write Buffer enabled or disabled,
and whether to enable or disable syncing of the Binary Logs.
'
enum:
- ENABLED
- DISABLED
type: string
x-obmcs-top-level-enum: '#/definitions/CrashRecoveryStatus'
customerContacts:
description: "The list of customer email addresses that receive information from Oracle about the specified OCI DB System resource. \nOracle uses these email addresses to send notifications about planned and unplanned software maintenance updates, information about system hardware, and other information needed by administrators. \nUp to 10 email addresses can be added to the customer contacts for a DB System.\n"
items:
$ref: '#/components/schemas/CustomerContact'
maxItems: 10
type: array
dataStorage:
$ref: '#/components/schemas/DataStorageDetails'
dataStorageSizeInGBs:
description: 'Initial size of the data volume in GBs that will be created and attached.
Keep in mind that this only specifies the size of the database data volume,
the log volume for the database will be scaled appropriately with its shape.
'
maximum: 131072
minimum: 50
type: integer
databaseConsole:
$ref: '#/components/schemas/CreateDatabaseConsoleDetails'
databaseManagement:
default: ENABLED
description: 'Whether to enable monitoring via the Database Management service.
'
enum:
- ENABLED
- DISABLED
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseManagementStatus'
databaseMode:
default: READ_WRITE
description: "The database mode indicating the types of statements that will be allowed to run in the DB system.\nThis mode will apply only to statements run by user connections. Replicated write statements will continue \nto be allowed regardless of the DatabaseMode.\n - READ_WRITE (default): allow running read and write statements on the DB system;\n - READ_ONLY: only allow running read statements on the DB system.\n"
type: string
x-obmcs-enumref: '#/definitions/DbSystem/databaseMode'
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Usage of predefined tag keys. These predefined keys are scoped to namespaces.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
deletionPolicy:
$ref: '#/components/schemas/CreateDeletionPolicyDetails'
description:
description: User-provided data about the DB System.
maxLength: 400
minLength: 1
type: string
displayName:
description: The user-friendly name for the DB System. It does not have to be unique.
maxLength: 255
minLength: 1
type: string
encryptData:
$ref: '#/components/schemas/EncryptDataDetails'
faultDomain:
description: 'The fault domain on which to deploy the Read/Write endpoint. This defines the preferred primary instance.
In a failover scenario, the Read/Write endpoint is redirected to one of the other fault domains
and the MySQL instance in that domain is promoted to the primary instance.
This redirection does not affect the IP address of the DB System in any way.
For a standalone DB System, this defines the fault domain in which the DB System is placed.
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
hostnameLabel:
description: 'The hostname for the primary endpoint of the DB System. Used for DNS.
The value is the hostname portion of the primary private IP''s fully qualified domain name (FQDN)
(for example, "dbsystem-1" in FQDN "dbsystem-1.subnet123.vcn1.oraclevcn.com").
Must be unique across all VNICs in the subnet and comply with RFC 952 and RFC 1123.
'
type: string
ipAddress:
description: 'The IP address the DB System is configured to listen on.
A private IP address of your choice to assign to the primary endpoint of the DB System.
Must be an available IP address within the subnet''s CIDR. If you don''t specify a value,
Oracle automatically assigns a private IP address from the subnet. This should be a
"dotted-quad" style IPv4 address.
'
type: string
x-default-description: 'If you don''t specify a value, Oracle automatically assigns a private IPv4 address from the subnet.
'
ipv6AddressIpv6SubnetCidrPairDetails:
$ref: '#/components/schemas/Ipv6AddressIpv6SubnetCidrPairDetails'
isHighlyAvailable:
default: true
description: 'Specifies if the DB System is highly available.
When creating a DB System with High Availability, three instances
are created and placed according to your region- and
subnet-type. The secondaries are placed automatically in the other
two availability or fault domains. You can choose the preferred
location of your primary instance, only.
'
type: boolean
isIpv6Enabled:
description: 'Whether to allocate an IPv6 address at DB system creation from an
IPv6 enabled subnet. When provided you may optionally
provide an IPv6 prefix (ipv6AddressIpv6SubnetCidrPairDetails) of your
choice to assign the IPv6 address from. If ipv6AddressIpv6SubnetCidrPairDetails
is not provided then an IPv6 prefix is chosen for you.
'
type: boolean
x-default-description: 'If you don''t specify a value, Oracle automatically use false for IPv4 or dual
stack (IPv4 + IPv6) subnets or true for single stack IPv6 subnets.
'
maintenance:
$ref: '#/components/schemas/CreateMaintenanceDetails'
mysqlVersion:
description: The specific MySQL version identifier.
maxLength: 255
minLength: 1
type: string
nsgIds:
description: Network Security Group OCIDs used for the VNIC attachment.
items:
type: string
maxItems: 5
minItems: 0
type: array
uniqueItems: true
port:
default: 3306
description: The port for primary endpoint of the DB System to listen on.
maximum: 65535
minimum: 1024
type: integer
portX:
default: 3306
description: 'The TCP network port on which X Plugin listens for connections. This is the X Plugin equivalent of port.
'
maximum: 65535
minimum: 1024
type: integer
readEndpoint:
$ref: '#/components/schemas/CreateReadEndpointDetails'
rest:
$ref: '#/components/schemas/CreateRestDetails'
secureConnections:
$ref: '#/components/schemas/SecureConnectionDetails'
securityAttributes:
additionalProperties:
additionalProperties:
description: 'Security Attribute value and mode. Only the String type is supported for value. (Mode is reserved and “enforce” in this release)
'
type: object
description: 'Key-value pair representing a ZPR tag key and value, scoped to a namespace.
Example: `{"MaxEgressCount": {"value": "42", "mode": "audit"}}`
'
type: object
description: 'Security Attributes for this resource. Each key is predefined and scoped to a namespace.
For more information, see [ZPR Artifacts](https://docs.oracle.com/en-us/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm).
Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}`
'
type: object
shapeName:
description: 'The name of the shape. The shape determines the resources allocated
- CPU cores and memory for VM shapes; CPU cores, memory and storage
for non-VM (or bare metal) shapes. To get a list of shapes, use the
[ListShapes](#/en/mysql/20190415/ShapeSummary/ListShapes) operation.
'
maxLength: 255
minLength: 1
type: string
source:
$ref: '#/components/schemas/CreateDbSystemSourceDetails'
subnetId:
description: 'The OCID of the subnet the DB System is associated with.
'
maxLength: 255
minLength: 1
type: string
telemetryConfiguration:
$ref: '#/components/schemas/CreateTelemetryConfigurationDetails'
required:
- compartmentId
- shapeName
- adminUsername
- adminPassword
- subnetId
TelemetryConfigurationDetails:
description: 'Telemetry configuration details of a DB System or a read replica.
'
properties:
logs:
description: Telemetry configuration details for logging.
items:
$ref: '#/components/schemas/LoggingDestinationConfiguration'
maxItems: 10
minItems: 1
type: array
ChannelStatusResult:
description: 'Status information for the channel attached to the DB System.
'
properties:
channelId:
description: 'The OCID of the Channel for which the status is gathered.
'
maxLength: 255
minLength: 1
type: string
errors:
description: Channel errors identified, if there are any.
items:
type: string
maxItems: 2
minItems: 0
type: array
uniqueItems: true
isHealthy:
description: "Specifies if the channel is healthy or not. If healthy, replication target DB System is connected to the \nsource and no replication errors are seen.\n"
type: boolean
isReceivedGtidSetApplied:
description: 'Specifies if all transactions received by this channel are executed and their GTIDs are part of gtid_executed
set.
'
type: boolean
lagDuration:
description: "The channel lag, with respect to the immediate source of the channel. \nIf the channel is configured with replication delay, the channel lag includes the replication delay.\n"
format: x-obmcs-duration
type: string
required:
- channelId
DatabaseConsoleDetails:
description: 'Database console configuration details.
'
properties:
port:
default: 8443
description: The port on which the database console can be accessed. Supported port numbers are 443 and from 1024 to 65535.
maximum: 65535
minimum: 443
type: integer
status:
default: DISABLED
description: Whether the database console is enabled on the DB System.
enum:
- ENABLED
- DISABLED
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseConsoleStatus'
required:
- status
UpdateRestDetails:
description: 'Details required to configure REST while updating a DB System.
'
properties:
configuration:
default: DISABLED
description: Select how REST is configured across the DB System instances.
enum:
- DISABLED
- DBSYSTEM_ONLY
type: string
x-obmcs-top-level-enum: '#/definitions/RestConfigurationType'
port:
default: 443
description: The port for REST to listen on. Supported port numbers are 443 and from 1024 to 65535.
maximum: 65535
minimum: 443
type: integer
required:
- configuration
DestinationConfiguration:
description: Configuration variable of a given destination.
properties:
key:
description: Name of the destination configuration variable.
maxLength: 255
minLength: 1
type: string
value:
description: Value of the destination configuration variable.
maxLength: 255
minLength: 1
type: string
required:
- key
- value
type: object
Ipv6AddressIpv6SubnetCidrPairDetails:
description: Details to assign an IPv6 subnet prefix or IPv6 address to a resource.
properties:
ipv6Address:
description: 'An IPv6 address of your choice. Must be an available IPv6 address within the subnet''s prefix.
'
maxLength: 45
minLength: 1
type: string
x-default-description: 'If an IPv6 address is not provided:
- Oracle will automatically assign an IPv6 address from the subnet''s IPv6 prefix if and only if there is only one IPv6 prefix on the subnet.
- Oracle will automatically assign an IPv6 address from the subnet''s IPv6 Oracle GUA prefix if it exists on the subnet.
'
ipv6SubnetCidr:
description: The IPv6 prefix allocated to the subnet.
maxLength: 45
minLength: 1
type: string
x-default-description: 'null'
CreateDatabaseConsoleDetails:
description: 'Details required to configure the database console while creating a DB System.
'
properties:
port:
default: 8443
description: The port on which the database console can be accessed. Supported port numbers are 443 and from 1024 to 65535.
maximum: 65535
minimum: 443
type: integer
status:
default: DISABLED
description: Enable/disable the database console on the DB System.
enum:
- ENABLED
- DISABLED
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseConsoleStatus'
required:
- status
UpdateDatabaseConsoleDetails:
description: 'Details required to configure the database console while updating a DB System.
'
properties:
port:
default: 8443
description: The port on which the database console can be accessed. Supported port numbers are 443 and from 1024 to 65535.
maximum: 65535
minimum: 443
type: integer
status:
default: DISABLED
description: Enable/disable the database console on the DB System.
enum:
- ENABLED
- DISABLED
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseConsoleStatus'
required:
- status
DbSystemSource:
description: 'Parameters detailing how to provision the initial data of the DB System.
'
discriminator:
propertyName: sourceType
properties:
sourceType:
default: NONE
description: 'The specific source identifier.
'
enum:
- NONE
- BACKUP
- PITR
- IMPORTURL
- DBSYSTEM
type: string
required:
- sourceType
HeatWaveClusterTableMemoryEstimate:
description: 'Estimated memory footprint for a MySQL user table
when loaded to the HeatWave cluster memory.
'
properties:
analyticalFootprintInMbs:
description: 'The estimated memory footprint of the table in MBs when loaded to
HeatWave cluster memory (null if the table cannot be loaded to the
HeatWave cluster).
'
format: int64
type: integer
errorComment:
description: 'Error comment (empty string if no errors occured).
'
maxLength: 255
minLength: 0
type: string
estimatedRowCount:
description: 'The estimated number of rows in the table. This number was used to
derive the analytical memory footprint.
'
format: int64
type: integer
tableName:
description: The table name.
maxLength: 64
minLength: 1
type: string
toLoadColumnCount:
description: 'The number of columns to be loaded to HeatWave cluster memory.
These columns contribute to the analytical memory footprint.
'
type: integer
varlenColumnCount:
description: 'The number of variable-length columns to be loaded to HeatWave cluster memory.
These columns contribute to the analytical memory footprint.
'
type: integer
required:
- tableName
- toLoadColumnCount
- varlenColumnCount
- estimatedRowCount
- analyticalFootprintInMbs
- errorComment
UpdateBackupPolicyDetails:
description: 'Backup Policy as optionally used for DB System update.
'
properties:
copyPolicies:
description: 'List of policies of a DB system to schedule cross-region DB system backup copy.
The policy includes the name of the destination region to which the DB system backup will be copied, and
an optional parameter which specifies the retention period of the copied DB system backup in days.
**Note:** Currently, only one policy can be specified in the list.
'
items:
$ref: '#/components/schemas/CopyPolicy'
type: array
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Usage of predefined tag keys. These predefined keys are scoped to namespaces.
Tags defined here will be copied verbatim as tags on the Backup resource created by this BackupPolicy.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair applied without any predefined name, type or scope. Exists for cross-compatibility only.
Tags defined here will be copied verbatim as tags on the Backup resource created by this BackupPolicy.
Example: `{"bar-key": "value"}`
'
type: object
isEnabled:
default: true
description: 'Specifies if automatic backups are enabled.
'
type: boolean
pitrPolicy:
$ref: '#/components/schemas/PitrPolicy'
retentionInDays:
description: Number of days to retain an automatic backup.
maximum: 35
minimum: 1
type: integer
softDelete:
description: 'Retains the backup to be deleted due to the retention policy in DELETE SCHEDULED
state for 7 days before permanently deleting it.
'
enum:
- ENABLED
- DISABLED
type: string
x-obmcs-top-level-enum: '#/definitions/SoftDelete'
windowStartTime:
description: 'The start of a 30-minute window of time in which daily, automated backups occur.
This should be in the format of the "Time" portion of an RFC3339-formatted timestamp. Any second or sub-second time data will be truncated to zero.
At some point in the window, the system may incur a brief service disruption as the backup is performed.
'
type: string
x-default-description: 'If not defined, a window is selected from the following Region-based time-spans:
- eu-frankfurt-1: 20:00 - 04:00 UTC
- us-ashburn-1: 03:00 - 11:00 UTC
- uk-london-1: 06:00 - 14:00 UTC
- ap-tokyo-1: 13:00 - 21:00
- us-phoenix-1: 06:00 - 14:00
'
DbSystemPlacement:
description: The availability domain and fault domain a DB System is placed in.
properties:
availabilityDomain:
description: The availability domain in which the DB System is placed.
maxLength: 255
minLength: 1
type: string
faultDomain:
description: The fault domain in which the DB System is placed.
maxLength: 255
minLength: 1
type: string
RestartDbSystemDetails:
description: DB System restart parameters.
properties:
shutdownType:
default: FAST
description: 'The InnoDB shutdown mode to use, following the option
"[innodb_fast_shutdown](https://dev.mysql.com/doc/refman/en/innodb-parameters.html#sysvar_innodb_fast_shutdown)".
'
enum:
- IMMEDIATE
- FAST
- SLOW
type: string
x-obmcs-top-level-enum: '#/definitions/InnoDbShutdownMode'
required:
- shutdownType
CustomerContact:
description: 'Customer contact information that will be used by Oracle to provide notifications needed by DB System administrators.
'
properties:
email:
description: 'The email address used by Oracle to send notifications regarding the DB System.
'
maxLength: 256
minLength: 1
type: string
required:
- email
DataStorage:
allOf:
- $ref: '#/components/schemas/DataStorageDetails'
- required:
- allocatedStorageSizeInGBs
- isAutoExpandStorageEnabled
- dataStorageSizeInGBs
- dataStorageSizeLimitInGBs
- properties:
allocatedStorageSizeInGBs:
description: 'The actual allocated storage size for the DB System. This may be higher than dataStorageSizeInGBs
if an automatic storage expansion has occurred.
'
maximum: 131072
minimum: 50
type: integer
dataStorageSizeInGBs:
description: 'User specified size of the data volume. May be less than current allocatedStorageSizeInGBs.
'
maximum: 131072
minimum: 50
type: integer
dataStorageSizeLimitInGBs:
description: 'The absolute limit the DB System''s storage size may ever expand to, either manually or automatically.
This limit is based based on the initial dataStorageSizeInGBs when the DB System was first created.
Both dataStorageSizeInGBs and maxDataStorageSizeInGBs can not exceed this value.
DB Systems with an initial storage size of 400 GB or less can be expanded up to 32 TB.
DB Systems with an initial storage size between 401-800 GB can be expanded up to 64 TB.
DB Systems with an initial storage size between 801-1200 GB can be expanded up to 96 TB.
DB Systems with an initial storage size of 1201 GB or more can be expanded up to 128 TB.
'
enum:
- 32768
- 65536
- 98304
- 131072
type: integer
description: 'Data Storage information.
'
BackupPolicy:
description: The Backup policy for the DB System.
properties:
copyPolicies:
description: 'List of policies of a DB system to schedule cross-region DB system backup copy.
The policy includes the name of the destination region to which the DB system backup will be copied, and
an optional parameter which specifies the retention period of the copied DB system backup in days.
**Note:** Currently, only one policy can be specified in the list.
'
items:
$ref: '#/components/schemas/CopyPolicy'
type: array
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Usage of predefined tag keys. These predefined keys are scoped to namespaces.
Tags defined here will be copied verbatim as tags on the Backup resource created by this BackupPolicy.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair applied without any predefined name, type or scope. Exists for cross-compatibility only.
Tags defined here will be copied verbatim as tags on the Backup resource created by this BackupPolicy.
Example: `{"bar-key": "value"}`
'
type: object
isEnabled:
default: true
description: If automated backups are enabled or disabled.
type: boolean
pitrPolicy:
$ref: '#/components/schemas/PitrPolicy'
retentionInDays:
description: 'The number of days automated backups are retained.
'
maximum: 35
minimum: 1
type: integer
softDelete:
description: 'Retains the backup to be deleted due to the retention policy in DELETE SCHEDULED
state for 7 days before permanently deleting it.
'
enum:
- ENABLED
- DISABLED
type: string
x-obmcs-top-level-enum: '#/definitions/SoftDelete'
windowStartTime:
description: 'The start of a 30-minute window of time in which daily, automated backups occur.
This should be in the format of the "Time" portion of an RFC3339-formatted timestamp. Any second or sub-second time data will be truncated to zero.
At some point in the window, the system may incur a brief service disruption as the backup is performed.
If not defined, a window is selected from the following Region-based time-spans:
- eu-frankfurt-1: 20:00 - 04:00 UTC
- us-ashburn-1: 03:00 - 11:00 UTC
- uk-london-1: 06:00 - 14:00 UTC
- ap-tokyo-1: 13:00 - 21:00
- us-phoenix-1: 06:00 - 14:00
'
type: string
required:
- isEnabled
- windowStartTime
- retentionInDays
HeatWaveNode:
description: 'A HeatWave node is a compute host that is part of a HeatWave cluster.
'
properties:
lifecycleState:
description: The current state of the MySQL HeatWave node.
enum:
- CREATING
- ACTIVE
- INACTIVE
- UPDATING
- DELETING
- DELETED
- FAILED
type: string
nodeId:
description: The ID of the node within MySQL HeatWave cluster.
maxLength: 255
minLength: 1
type: string
timeCreated:
description: 'The date and time the MySQL HeatWave node was created,
as described by [RFC 3339](https://tools.ietf.org/rfc/rfc3339).
'
format: date-time
type: string
timeUpdated:
description: 'The date and time the MySQL HeatWave node was updated,
as described by [RFC 3339](https://tools.ietf.org/rfc/rfc3339).
'
format: date-time
type: string
required:
- nodeId
- lifecycleState
HeatWaveClusterSchemaMemoryEstimate:
description: 'Schema with estimated memory footprints for each MySQL user table
of the schema when loaded to HeatWave cluster memory.
'
properties:
perTableEstimates:
description: 'Estimated memory footprints for MySQL user tables of the schema
when loaded to HeatWave cluster memory.
'
items:
$ref: '#/components/schemas/HeatWaveClusterTableMemoryEstimate'
type: array
schemaName:
description: The name of the schema.
maxLength: 64
minLength: 1
type: string
required:
- schemaName
- perTableEstimates
CreateReadEndpointDetails:
allOf:
- $ref: '#/components/schemas/ReadEndpointDetails'
description: 'Details required to create a Read Endpoint.
'
UpdateMaintenanceDetails:
description: 'The Maintenance Policy for the DB System or Read Replica that this model is included in.
'
properties:
maintenanceDisabledWindows:
description: 'Time window during which downtime-inducing maintenance shall not be performed.
Downtime-free maintenance may be performed to apply required security patches.
At most one configured window is supported.
'
items:
$ref: '#/components/schemas/MaintenanceDisabledWindow'
maxItems: 1
minItems: 0
type: array
maintenanceScheduleType:
default: REGULAR
description: 'The maintenance schedule type of the DB system. Defaults to REGULAR.
EARLY: Maintenance schedule follows a cycle where upgrades are performed when versions become deprecated.
REGULAR: Maintenance schedule follows the normal cycle where upgrades are performed when versions become unavailable.
'
enum:
- EARLY
- REGULAR
type: string
x-obmcs-top-level-enum: '#/definitions/MaintenanceScheduleType'
versionPreference:
default: OLDEST
description: 'The preferred version to target when performing an automatic MySQL upgrade. Defaults to OLDEST.
OLDEST: Choose the oldest available MySQL version based on the current version of the DB System.
SECOND_NEWEST: Choose the MySQL version before the newest for auto-upgrade.
NEWEST: Choose the latest and greatest MySQL version available for auto-upgrade.
'
enum:
- OLDEST
- SECOND_NEWEST
- NEWEST
type: string
x-obmcs-top-level-enum: '#/definitions/VersionPreference'
versionTrackPreference:
default: FOLLOW
description: 'The preferred version track to target when performing an automatic MySQL upgrade. Defaults to FOLLOW.
LONG_TERM_SUPPORT: No MySQL database behavior changes.
INNOVATION: Provides access to the latest features and all bug fixes.
FOLLOW: Follows the track of the current MySQL version.
'
enum:
- LONG_TERM_SUPPORT
- INNOVATION
- FOLLOW
type: string
x-obmcs-top-level-enum: '#/definitions/VersionTrackPreference'
windowStartTime:
description: "The start of the 2 hour maintenance window.\n\nThis string is of the format: \"{day-of-week} {time-of-day}\".\n\n\"{day-of-week}\" is a case-insensitive string like \"mon\", \"tue\", &c.\n\n\"{time-of-day}\" is the \"Time\" portion of an RFC3339-formatted timestamp. Any second or sub-second time data will be truncated to zero.\n\nIf you set the read replica maintenance window to \"\", the read replica is set same as the DB system maintenance window. If not specific by the user, \nthere will be no changes to the maintenace window.\n"
type: string
CopyPolicy:
description: 'A policy of a DB system to schedule cross-region DB system backup copy.
'
properties:
backupCopyRetentionInDays:
description: Number of days to retain the copied DB system backup.
maximum: 35
minimum: 1
type: integer
copyToRegion:
description: The destination region name to which the DB system backup will be copied.
maxLength: 64
minLength: 1
type: string
required:
- copyToRegion
ControlledUpdate:
allOf:
- $ref: '#/components/schemas/ControlledUpdateDbSystemDetails'
description: The details of the last successfully processed controlled update action.
LoggingDestinationConfiguration:
description: Configuration parameters for a given destination.
properties:
destination:
description: Type of destination where MySQL telemetry is exposed to.
enum:
- LOG_ANALYTICS
- OPEN_TELEMETRY
type: string
destinationConfigurations:
description: List of configuration variables for a given destination type.
items:
$ref: '#/components/schemas/DestinationConfiguration'
maxItems: 10
type: array
logTypes:
description: List of MySQL telemetry types that can be exposed on a telemetry destination
items:
enum:
- ERROR_LOG
- GENERAL_LOG
- SLOW_QUERY_LOG
- AUDIT_LOG
type: string
type: array
required:
- destination
- destinationConfigurations
- logTypes
type: object
DbSystemStatus:
description: 'Runtime status summary of a DbSystem, aggregating information about availability and operational indicators.
'
properties:
dbSystemId:
description: 'The OCID of the DB System for which the status is gathered.
'
maxLength: 255
minLength: 1
type: string
dbSystemStatusResult:
$ref: '#/components/schemas/DbSystemStatusResult'
timeCreated:
description: "The date and time that the Work Request to generate the DB System status was issued, \nas described by [RFC 3339](https://tools.ietf.org/rfc/rfc3339).\n"
format: date-time
type: string
timeUpdated:
description: "The date and time that the DB System status was generated, \nas described by [RFC 3339](https://tools.ietf.org/rfc/rfc3339).\n"
format: date-time
type: string
required:
- dbSystemId
- timeCreated
- timeUpdated
ReadEndpointDetails:
description: 'The read endpoint of a DB System.
'
properties:
excludeIps:
description: 'A list of IP addresses of read replicas that are excluded from serving read requests.
'
items:
type: string
type: array
isEnabled:
default: false
description: 'Specifies if the DB System read endpoint is enabled or not.
'
type: boolean
readEndpointHostnameLabel:
description: 'The hostname for the read endpoint of the DB System. Used for DNS.
The value is the hostname portion of the primary private IP''s fully qualified domain name (FQDN)
(for example, "dbsystem-1" in FQDN "dbsystem-1.subnet123.vcn1.oraclevcn.com").
Must be unique across all VNICs in the subnet and comply with RFC 952 and RFC 1123.
'
type: string
readEndpointIpAddress:
description: 'The IP address the DB System read endpoint is configured to listen on.
A private IP address of your choice to assign to the read endpoint of the DB System.
Must be an available IP address within the subnet''s CIDR. If you don''t specify a value,
Oracle automatically assigns a private IP address from the subnet. This should be a
"dotted-quad" style IPv4 address.
'
type: string
x-default-description: 'If you don''t specify a value, Oracle automatically assigns a private IPv4 address from the subnet.
'
readEndpointIpv6AddressIpv6SubnetCidrPairDetails:
$ref: '#/components/schemas/Ipv6AddressIpv6SubnetCidrPairDetails'
DbSystemStatusResult:
description: 'The status collected from the DB System.
'
properties:
areAllMysqlInstancesHealthy:
description: 'Specifies if the single MySQL instance in a standalone DB System or all MySQL instances in a highly available
DB System (excluding read replicas) are healthy.
'
type: boolean
canAcceptClientConnections:
description: 'Specifies if the Read/Write endpoint of the DB System can accept client connections.
'
type: boolean
channelsStatus:
description: 'A list showing the status of the channels attached to the DB System for the requested channel IDs.
'
items:
$ref: '#/components/schemas/ChannelStatusResult'
type: array
gtidSet:
description: "The GTID set on the DB System (either GTID_EXECUTED or GTID_AVAILABLE) as specified by the gtidSetType \nparameter in the request.\n"
type: string
isGtidSetApplied:
description: "Specifies if the GTID set in the gtidSetToApply parameter (if provided in the request) is fully applied \non the DB System. If gtidSetToApply is not provided in the request or is \"\", this field will be empty.\n"
type: boolean
isInOfflineMode:
description: 'Specifies if the DB System is in offline mode based on the value of the MySQL system variable
[offline_mode](https://dev.mysql.com/doc/en/server-system-variables.html#sysvar_offline_mode).
If True, access is allowed only to users with specific privileges. If False, access is allowed for all MySQL
user accounts.
'
type: boolean
isStorageFull:
description: 'Specifies if there is any MySQL instance (excluding read replicas) whose storage capacity is below [storage reserve]
(https://docs.oracle.com/en-us/iaas/mysql-database/doc/health-monitor.html#GUID-C6CE25C7-B728-4C80-B548-A76B42005C83.html).
'
type: boolean
isWritable:
description: 'Specifies if connected users can run write queries on the DB System.
'
type: boolean
HeatWaveClusterMemoryEstimate:
description: '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 the table is loaded to the HeatWave cluster memory is returned.
'
properties:
dbSystemId:
description: 'The OCID of the DB System the HeatWave cluster memory estimate is associated with.
'
maxLength: 255
minLength: 1
type: string
status:
description: Current status of the Work Request generating the HeatWave cluster memory estimate.
enum:
- ACCEPTED
- IN_PROGRESS
- FAILED
- SUCCEEDED
- CANCELING
- CANCELED
type: string
x-obmcs-top-level-enum: '#/definitions/HeatWaveClusterMemoryEstimateStatus'
tableSchemas:
description: 'Collection of schemas with estimated memory footprints for MySQL user tables of each schema
when loaded to HeatWave cluster memory.
'
items:
$ref: '#/components/schemas/HeatWaveClusterSchemaMemoryEstimate'
type: array
timeCreated:
description: The date and time that the Work Request to generate the HeatWave cluster memory estimate was issued, as described by [RFC 3339](https://tools.ietf.org/rfc/rfc333).
format: date-time
type: string
timeUpdated:
description: The date and time that the HeatWave cluster memory estimate was generated, as described by [RFC 3339](https://tools.ietf.org/rfc/rfc333).
format: date-time
type: string
required:
- dbSystemId
- status
- timeCreated
- timeUpdated
- tableSchemas
ChannelSummary:
description: Summary of a Channel.
properties:
compartmentId:
description: The OCID of the compartment.
maxLength: 255
minLength: 1
type: string
x-default-description: 'If not specified by the user it will assume the value of the compartment of
the target DB System.
'
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Usage of predefined tag keys. These predefined keys are scoped to namespaces.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
displayName:
description: The user-friendly name for the Channel. It does not have to be unique.
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
id:
description: The OCID of the Channel.
maxLength: 255
minLength: 1
type: string
isEnabled:
default: true
description: Whether the Channel has been enabled by the user.
type: boolean
lifecycleDetails:
description: A message describing the state of the Channel.
type: string
lifecycleState:
description: The state of the Channel.
type: string
x-obmcs-enumref: '#/definitions/Channel/lifecycleState'
source:
$ref: '#/components/schemas/ChannelSource'
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.
Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
'
type: object
target:
$ref: '#/components/schemas/ChannelTarget'
timeCreated:
description: 'The date and time the Channel was created, as described by [RFC 3339](https://tools.ietf.org/rfc/rfc3339).
'
format: date-time
type: string
timeUpdated:
description: 'The time the Channel was last updated, as described by [RFC 3339](https://tools.ietf.org/rfc/rfc3339).
'
format: date-time
type: string
required:
- id
- compartmentId
- isEnabled
- source
- target
- lifecycleState
- displayName
- timeCreated
- timeUpdated
DbSystemSummary:
description: 'A summary of a DB System.
'
properties:
accessMode:
description: "The access mode indicating if the database access is unrestricted (to all MySQL user accounts), \nor restricted (to only certain users with specific privileges):\n - UNRESTRICTED: the access to the database is not restricted;\n - RESTRICTED: the access is allowed only to users with specific privileges; \n RESTRICTED will correspond to setting the MySQL system variable \n [offline_mode](https://dev.mysql.com/doc/en/server-system-variables.html#sysvar_offline_mode) to ON.\n"
type: string
x-obmcs-enumref: '#/definitions/DbSystem/accessMode'
availabilityDomain:
description: 'The availability domain on which to deploy the Read/Write endpoint. This defines the preferred primary instance.
In a failover scenario, the Read/Write endpoint is redirected to one of the other availability domains
and the MySQL instance in that domain is promoted to the primary instance.
This redirection does not affect the IP address of the DB System in any way.
For a standalone DB System, this defines the availability domain in which the DB System is placed.
'
maxLength: 255
minLength: 1
type: string
backupPolicy:
$ref: '#/components/schemas/BackupPolicy'
compartmentId:
description: The OCID of the compartment the DB System belongs in.
maxLength: 255
minLength: 1
type: string
crashRecovery:
default: ENABLED
description: 'Whether to run the DB System with InnoDB Redo Logs and the Double Write Buffer enabled or disabled,
and whether to enable or disable syncing of the Binary Logs.
'
enum:
- ENABLED
- DISABLED
type: string
x-obmcs-top-level-enum: '#/definitions/CrashRecoveryStatus'
currentPlacement:
$ref: '#/components/schemas/DbSystemPlacement'
databaseConsole:
$ref: '#/components/schemas/DatabaseConsoleDetails'
databaseManagement:
default: ENABLED
description: 'Whether to enable monitoring via the Database Management service.
'
enum:
- ENABLED
- DISABLED
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseManagementStatus'
databaseMode:
description: "The database mode indicating the types of statements that are allowed to run in the DB system.\nThis mode applies only to statements run by user connections. Replicated write statements continue \nto be allowed regardless of the DatabaseMode.\n - READ_WRITE: allow running read and write statements on the DB system;\n - READ_ONLY: only allow running read statements on the DB system.\n"
type: string
x-obmcs-enumref: '#/definitions/DbSystem/databaseMode'
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
deletionPolicy:
$ref: '#/components/schemas/DeletionPolicyDetails'
description:
description: User-provided data about the DB System.
maxLength: 400
minLength: 1
type: string
displayName:
description: The user-friendly name for the DB System. It does not have to be unique.
maxLength: 255
minLength: 1
type: string
endpoints:
description: 'The network endpoints available for this DB System.
'
items:
$ref: '#/components/schemas/DbSystemEndpoint'
type: array
faultDomain:
description: 'The fault domain on which to deploy the Read/Write endpoint. This defines the preferred primary instance.
In a failover scenario, the Read/Write endpoint is redirected to one of the other fault domains
and the MySQL instance in that domain is promoted to the primary instance.
This redirection does not affect the IP address of the DB System in any way.
For a standalone DB System, this defines the fault domain in which the DB System is placed.
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
heatWaveCluster:
$ref: '#/components/schemas/HeatWaveClusterSummary'
id:
description: The OCID of the DB System.
maxLength: 255
minLength: 1
type: string
isHeatWaveClusterAttached:
default: false
description: 'If the DB System has a HeatWave Cluster attached.
'
type: boolean
isHighlyAvailable:
default: true
description: 'Specifies if the DB System is highly available.
'
type: boolean
lifecycleState:
description: The current state of the DB System.
type: string
x-obmcs-enumref: '#/definitions/DbSystem/lifecycleState'
mysqlVersion:
description: Name of the MySQL Version in use for the DB System.
type: string
readEndpoint:
$ref: '#/components/schemas/ReadEndpointDetails'
rest:
$ref: '#/components/schemas/RestDetails'
shapeName:
description: 'The shape of the primary instances of the DB System. The shape
determines resources allocated to a DB System - CPU cores
and memory for VM shapes; CPU cores, memory and storage for non-VM
(or bare metal) shapes. To get a list of shapes, use (the
[ListShapes](#/en/mysql/20181021/ShapeSummary/ListShapes) operation.
'
maxLength: 255
minLength: 1
type: string
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.
Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
'
type: object
timeCreated:
description: The date and time the DB System was created.
format: date-time
type: string
timeUpdated:
description: The time the DB System was last updated.
format: date-time
type: string
required:
- displayName
- id
- lifecycleState
- timeCreated
- timeUpdated
- mysqlVersion
- databaseMode
- accessMode
MaintenanceDetails:
description: 'The Maintenance Policy for the DB System or Read Replica that this model is included in.
'
properties:
maintenanceDisabledWindows:
description: 'Time window during which downtime-inducing maintenance shall not be performed.
Downtime-free maintenance may be performed to apply required security patches.
At most one configured window is supported.
'
items:
$ref: '#/components/schemas/MaintenanceDisabledWindow'
type: array
maintenanceScheduleType:
description: 'The maintenance schedule type of the DB system.
EARLY: Maintenance schedule follows a cycle where upgrades are performed when versions become deprecated.
REGULAR: Maintenance schedule follows the normal cycle where upgrades are performed when versions become unavailable.
'
enum:
- EARLY
- REGULAR
type: string
x-default-description: 'The default value is dependant on the DB System''s MySQL version track: REGULAR for LTS and EARLY for Innovation.
'
x-obmcs-top-level-enum: '#/definitions/MaintenanceScheduleType'
targetVersion:
description: 'The version that is expected to be targeted during the next scheduled maintenance run.
'
type: string
timeScheduled:
description: 'The time the scheduled maintenance is expected to start,
as described by [RFC 3339](https://tools.ietf.org/rfc/rfc3339).
'
format: date-time
type: string
versionPreference:
description: 'The preferred version to target when performing an automatic MySQL upgrade.
OLDEST: Choose the oldest available MySQL version based on the current version of the DB System.
SECOND_NEWEST: Choose the MySQL version before the newest for auto-upgrade.
NEWEST: Choose the latest and greatest MySQL version available for auto-upgrade.
'
enum:
- OLDEST
- SECOND_NEWEST
- NEWEST
type: string
x-default-description: 'The default value is dependant on the DB System''s MySQL version track: OLDEST for LTS and NEWEST for Innovation.
'
x-obmcs-top-level-enum: '#/definitions/VersionPreference'
versionTrackPreference:
description: 'The preferred version track to target when performing an automatic MySQL upgrade.
LONG_TERM_SUPPORT: No MySQL database behavior changes.
INNOVATION: Provides access to the latest features and all bug fixes.
FOLLOW: Follows the track of the current MySQL version.
'
enum:
- LONG_TERM_SUPPORT
- INNOVATION
- FOLLOW
type: string
x-default-description: 'The default value is dependant on the DB System''s MySQL version track: FOLLOW for LTS and INNOVATION for Innovation.
'
x-obmcs-top-level-enum: '#/definitions/VersionTrackPreference'
windowStartTime:
description: 'The start time of the maintenance window.
This string is of the format: "{day-of-week} {time-of-day}".
"{day-of-week}" is a case-insensitive string like "mon", "tue", &c.
"{time-of-day}" is the "Time" portion of an RFC3339-formatted timestamp. Any second or sub-second time data will be truncated to zero.
If you set the read replica maintenance window to "" or if not specified, the read replica is set same as the DB system maintenance window.
'
type: string
UpdateHeatWaveClusterDetails:
description: 'Details about the HeatWave cluster properties to be updated.
'
properties:
clusterSize:
description: 'A change to the number of nodes in the HeatWave cluster will result
in the entire cluster being torn down and re-created with the new
cluster of nodes. This may result in a significant downtime for the
analytics capability while the HeatWave cluster is
re-provisioned.
'
maximum: 512
minimum: 1
type: integer
isLakehouseEnabled:
default: false
description: Enable/disable Lakehouse for the HeatWave cluster.
type: boolean
shapeName:
description: 'A change to the shape of the nodes in the HeatWave cluster will
result in the entire cluster being torn down and re-created with
Compute instances of the new Shape. This may result in significant
downtime for the analytics capability while the HeatWave cluster is
re-provisioned.
'
maxLength: 255
minLength: 1
type: string
DataStorageDetails:
description: 'Data Storage configuration properties.
'
properties:
isAutoExpandStorageEnabled:
default: false
description: 'Enable/disable automatic storage expansion. When set to true, the DB System will automatically
add storage incrementally up to the value specified in maxStorageSizeInGBs.
'
type: boolean
maxStorageSizeInGBs:
description: 'Maximum storage size this DB System can expand to. When isAutoExpandStorageEnabled
is set to true, the DB System will add storage incrementally up to this value.
DB Systems with an initial storage size of 400 GB or less can be expanded up to 32 TB.
DB Systems with an initial storage size between 401-800 GB can be expanded up to 64 TB.
DB Systems with an initial storage size between 801-1200 GB can be expanded up to 96 TB.
DB Systems with an initial storage size of 1201 GB or more can be expanded up to 128 TB.
It is not possible to decrease data storage size. You cannot set the maximum data storage size to less
than either current DB System dataStorageSizeInGBs or allocatedStorageSizeInGBs.
'
maximum: 131072
minimum: 100
type: integer
MaintenanceDisabledWindow:
description: 'Time window during which downtime-inducing maintenance shall not be performed.
Downtime-free maintenance may be performed to apply required security patches.
'
properties:
timeEnd:
description: 'The time until when maintenance is disabled.
Must be set together with timeStart and must be after timeStart.
as described by [RFC 3339](https://tools.ietf.org/rfc/rfc3339).
'
format: date-time
type: string
timeStart:
description: 'The time from when maintenance is disabled.
Must be set together with timeEnd and must be before timeEnd.
as described by [RFC 3339](https://tools.ietf.org/rfc/rfc3339).
'
format: date-time
type: string
required:
- timeStart
- timeEnd
UpdateTelemetryConfigurationDetails:
allOf:
- $ref: '#/components/schemas/TelemetryConfigurationDetails'
description: 'Details required to configure how MySQL telemetry should be exposed.
'
AddHeatWaveClusterDetails:
description: 'Details required to add a HeatWave cluster.
'
properties:
clusterSize:
description: 'The number of analytics-processing nodes provisioned for the
HeatWave cluster.
'
maximum: 512
minimum: 1
type: integer
isLakehouseEnabled:
default: false
description: Enable/disable Lakehouse for the HeatWave cluster.
type: boolean
shapeName:
description: 'The shape determines resources to allocate to the HeatWave
nodes - CPU cores, memory.
'
maxLength: 255
minLength: 1
type: string
required:
- shapeName
- clusterSize
UpdateReadEndpointDetails:
allOf:
- $ref: '#/components/schemas/ReadEndpointDetails'
description: 'Read Endpoint details.
'
CreateDeletionPolicyDetails:
description: 'Policy for how the DB System and related resources should be handled at the time of its deletion.
'
properties:
automaticBackupRetention:
default: RETAIN
description: 'Specifies if any automatic backups created for a DB System should be retained or deleted when the DB System is deleted.
'
enum:
- DELETE
- RETAIN
type: string
finalBackup:
default: SKIP_FINAL_BACKUP
description: "Specifies whether or not a backup is taken when the DB System is deleted.\n REQUIRE_FINAL_BACKUP: a backup is taken if the DB System is deleted.\n SKIP_FINAL_BACKUP: a backup is not taken if the DB System is deleted.\n"
enum:
- SKIP_FINAL_BACKUP
- REQUIRE_FINAL_BACKUP
type: string
isDeleteProtected:
default: false
description: 'Specifies whether the DB System can be deleted. Set to true to prevent deletion, false (default) to allow.
'
type: boolean
CreateDbSystemSourceDetails:
description: 'Parameters detailing how to provision the initial data of the system.
'
discriminator:
propertyName: sourceType
properties:
sourceType:
default: NONE
description: 'The specific source identifier.
'
enum:
- NONE
- BACKUP
- PITR
- IMPORTURL
- DBSYSTEM
type: string
required:
- sourceType
EncryptDataDetails:
description: 'Encrypt data details.
'
properties:
keyGenerationType:
default: SYSTEM
description: Select whether to use Oracle-managed key (SYSTEM) or your own key (BYOK).
enum:
- SYSTEM
- BYOK
type: string
x-obmcs-top-level-enum: '#/definitions/KeyGenerationType'
keyId:
description: The OCID of the key to use.
maxLength: 255
minLength: 1
type: string
required:
- keyGenerationType
StopDbSystemDetails:
description: DB System shutdown parameters.
properties:
shutdownType:
default: FAST
description: 'The InnoDB shutdown mode to use, following the option
"[innodb_fast_shutdown](https://dev.mysql.com/doc/refman/en/innodb-parameters.html#sysvar_innodb_fast_shutdown)".
'
enum:
- IMMEDIATE
- FAST
- SLOW
type: string
x-obmcs-top-level-enum: '#/definitions/InnoDbShutdownMode'
required:
- shutdownType
DbSystem:
description: 'A DB System is the core logical unit of MySQL Database Service.
'
properties:
accessMode:
description: "The access mode indicating if the database access is unrestricted (to all MySQL user accounts), \nor restricted (to only certain users with specific privileges):\n - UNRESTRICTED: the access to the database is not restricted;\n - RESTRICTED: access allowed only to users with specific privileges;\n RESTRICTED will correspond to setting the MySQL system variable \n [offline_mode](https://dev.mysql.com/doc/en/server-system-variables.html#sysvar_offline_mode) to ON.\n"
enum:
- UNRESTRICTED
- RESTRICTED
type: string
availabilityDomain:
description: 'The availability domain on which to deploy the Read/Write endpoint. This defines the preferred primary instance.
In a failover scenario, the Read/Write endpoint is redirected to one of the other availability domains
and the MySQL instance in that domain is promoted to the primary instance.
This redirection does not affect the IP address of the DB System in any way.
For a standalone DB System, this defines the availability domain in which the DB System is placed.
'
maxLength: 255
minLength: 1
type: string
backupPolicy:
$ref: '#/components/schemas/BackupPolicy'
channels:
description: A list with a summary of all the Channels attached to the DB System.
items:
$ref: '#/components/schemas/ChannelSummary'
type: array
compartmentId:
description: The OCID of the compartment the DB System belongs in.
maxLength: 255
minLength: 1
type: string
configurationId:
description: The OCID of the Configuration to be used for Instances in this DB System.
maxLength: 255
minLength: 1
type: string
controlledUpdate:
$ref: '#/components/schemas/ControlledUpdate'
crashRecovery:
default: ENABLED
description: 'Whether to run the DB System with InnoDB Redo Logs and the Double Write Buffer enabled or disabled,
and whether to enable or disable syncing of the Binary Logs.
'
enum:
- ENABLED
- DISABLED
type: string
x-obmcs-top-level-enum: '#/definitions/CrashRecoveryStatus'
currentPlacement:
$ref: '#/components/schemas/DbSystemPlacement'
customerContacts:
description: "The list of customer email addresses that receive information from Oracle about the specified OCI DB System resource. \nOracle uses these email addresses to send notifications about planned and unplanned software maintenance updates, information about system hardware, and other information needed by administrators. \nUp to 10 email addresses can be added to the customer contacts for a DB System.\n"
items:
$ref: '#/components/schemas/CustomerContact'
maxItems: 10
type: array
dataStorage:
$ref: '#/components/schemas/DataStorage'
dataStorageSizeInGBs:
description: 'DEPRECATED: User specified size of the data volume. May be less than current allocatedStorageSizeInGBs.
Replaced by dataStorage.dataStorageSizeInGBs.
'
maximum: 131072
minimum: 50
type: integer
x-obmcs-deprecated: true
databaseConsole:
$ref: '#/components/schemas/DatabaseConsoleDetails'
databaseManagement:
default: ENABLED
description: 'Whether to enable monitoring via the Database Management service.
'
enum:
- ENABLED
- DISABLED
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseManagementStatus'
databaseMode:
description: "The database mode indicating the types of statements that are allowed to run in the the DB system.\nThis mode applies only to statements run by user connections. Replicated write statements continue \nto be allowed regardless of the DatabaseMode.\n - READ_WRITE: allow running read and write statements on the DB system;\n - READ_ONLY: only allow running read statements on the DB system.\n"
enum:
- READ_WRITE
- READ_ONLY
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
deletionPolicy:
$ref: '#/components/schemas/DeletionPolicyDetails'
description:
description: User-provided data about the DB System.
maxLength: 400
minLength: 1
type: string
displayName:
description: The user-friendly name for the DB System. It does not have to be unique.
maxLength: 255
minLength: 1
type: string
encryptData:
$ref: '#/components/schemas/EncryptDataDetails'
endpoints:
description: 'The network endpoints available for this DB System.
'
items:
$ref: '#/components/schemas/DbSystemEndpoint'
type: array
faultDomain:
description: 'The fault domain on which to deploy the Read/Write endpoint. This defines the preferred primary instance.
In a failover scenario, the Read/Write endpoint is redirected to one of the other fault domains
and the MySQL instance in that domain is promoted to the primary instance.
This redirection does not affect the IP address of the DB System in any way.
For a standalone DB System, this defines the fault domain in which the DB System is placed.
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
heatWaveCluster:
$ref: '#/components/schemas/HeatWaveClusterSummary'
hostnameLabel:
description: 'The hostname for the primary endpoint of the DB System. Used for DNS.
The value is the hostname portion of the primary private IP''s fully qualified domain name (FQDN)
(for example, "dbsystem-1" in FQDN "dbsystem-1.subnet123.vcn1.oraclevcn.com").
Must be unique across all VNICs in the subnet and comply with RFC 952 and RFC 1123.
'
type: string
id:
description: The OCID of the DB System.
maxLength: 255
minLength: 1
type: string
ipAddress:
description: 'The IP address the DB System is configured to listen on. A private
IP address of the primary endpoint of the DB System. Must be an
available IP address within the subnet''s CIDR. This will be a
"dotted-quad" style IPv4 address.
'
type: string
ipv6AddressIpv6SubnetCidrPairDetails:
$ref: '#/components/schemas/Ipv6AddressIpv6SubnetCidrPairDetails'
isHeatWaveClusterAttached:
default: false
description: 'If the DB System has a HeatWave Cluster attached.
'
type: boolean
isHighlyAvailable:
default: true
description: 'Specifies if the DB System is highly available.
'
type: boolean
isIpv6Enabled:
default: false
description: 'Whether an IPv6 address has been allocated for the DB system when attached
to an IPv6 enabled subnet. Default: False.
'
type: boolean
lifecycleDetails:
description: Additional information about the current lifecycleState.
type: string
lifecycleState:
description: The current state of the DB System.
enum:
- CREATING
- ACTIVE
- INACTIVE
- UPDATING
- DELETING
- DELETED
- FAILED
type: string
maintenance:
$ref: '#/components/schemas/MaintenanceDetails'
mysqlVersion:
description: Name of the MySQL Version in use for the DB System.
type: string
nsgIds:
description: Network Security Group OCIDs used for the VNIC attachment.
items:
type: string
maxItems: 5
minItems: 0
type: array
uniqueItems: true
pointInTimeRecoveryDetails:
$ref: '#/components/schemas/PointInTimeRecoveryDetails'
port:
description: The port for primary endpoint of the DB System to listen on.
maximum: 65535
minimum: 1024
type: integer
portX:
description: 'The network port on which X Plugin listens for TCP/IP connections. This is the X Plugin equivalent of port.
'
maximum: 65535
minimum: 1024
type: integer
readEndpoint:
$ref: '#/components/schemas/ReadEndpointDetails'
rest:
$ref: '#/components/schemas/RestDetails'
secureConnections:
$ref: '#/components/schemas/SecureConnectionDetails'
securityAttributes:
additionalProperties:
additionalProperties:
description: 'Security Attribute value and mode. Only the String type is supported for value. (Mode is reserved and “enforce” in this release)
'
type: object
description: 'Key-value pair representing a ZPR tag key and value, scoped to a namespace.
Example: `{"MaxEgressCount": {"value": "42", "mode": "audit"}}`
'
type: object
description: 'Security Attributes for this resource. Each key is predefined and scoped to a namespace.
For more information, see [ZPR Artifacts](https://docs.oracle.com/en-us/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm).
Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}`
'
type: object
shapeName:
description: 'The shape of the primary instances of the DB System. The shape
determines resources allocated to a DB System - CPU cores
and memory for VM shapes; CPU cores, memory and storage for non-VM
(or bare metal) shapes. To get a list of shapes, use (the
[ListShapes](#/en/mysql/20181021/ShapeSummary/ListShapes) operation.
'
maxLength: 255
minLength: 1
type: string
source:
$ref: '#/components/schemas/DbSystemSource'
subnetId:
description: 'The OCID of the subnet the DB System is associated with.
'
maxLength: 255
minLength: 1
type: string
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.
Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
'
type: object
telemetryConfiguration:
$ref: '#/components/schemas/TelemetryConfigurationDetails'
timeCreated:
description: The date and time the DB System was created.
format: date-time
type: string
timeUpdated:
description: The time the DB System was last updated.
format: date-time
type: string
required:
- compartmentId
- dataStorageSizeInGBs
- displayName
- id
- lifecycleState
- subnetId
- timeCreated
- timeUpdated
- mysqlVersion
- maintenance
- databaseMode
- accessMode
- deletionPolicy
- dataStorage
PitrPolicy:
description: The PITR policy for the DB System.
properties:
isEnabled:
description: Specifies if PITR is enabled or disabled.
type: boolean
required:
- isEnabled
UpdateDeletionPolicyDetails:
description: 'Policy for how the DB System and related resources should be handled at the time of its deletion.
'
properties:
automaticBackupRetention:
default: RETAIN
description: 'Specifies if any automatic backups created for a DB System should be retained or deleted when the DB System is deleted.
'
enum:
- DELETE
- RETAIN
type: string
finalBackup:
default: SKIP_FINAL_BACKUP
description: "Specifies whether or not a backup is taken when the DB System is deleted.\n REQUIRE_FINAL_BACKUP: a backup is taken if the DB System is deleted.\n SKIP_FINAL_BACKUP: a backup is not taken if the DB System is deleted.\n"
enum:
- SKIP_FINAL_BACKUP
- REQUIRE_FINAL_BACKUP
type: string
isDeleteProtected:
default: false
description: 'Specifies whether the DB System can be deleted. Set to true to prevent deletion, false (default) to allow.
'
type: boolean
MaintenanceEvent:
description: 'The details of a maintenance event.
'
properties:
compartmentId:
description: The OCID of the compartment the maintenance event belongs to.
maxLength: 255
minLength: 1
type: string
dbSystemId:
description: The OCID of the DB System this maintenance event is associated with.
maxLength: 255
minLength: 1
type: string
maintenanceAction:
description: 'The nature of the maintenance event.
DATABASE: maintenance event causing a MySQL version upgrade. This may also include OS updates.
OS_UPDATE: maintenance event causing an OS update.
ONLINE_UPDATE: maintenance event causing downtime-free OS security patches.
HARDWARE: hardware maintenance event affecting the DB System''s VMs and BMs.
'
enum:
- DATABASE
- OS_UPDATE
- ONLINE_UPDATE
- HARDWARE
type: string
x-obmcs-top-level-enum: '#/definitions/MaintenanceAction'
maintenanceNotes:
description: Information regarding what was performed during that maintenance.
type: string
maintenanceScope:
default: ALL
description: 'The MySQL instances operated during a maintenance event.
ALL: maintenance event targeting all MySQL instances in a DB System.
ALL_BUT_PRIMARY: maintenance event targeting all MySQL instances in a highly available DB System except the primary group member.
PRIMARY_ONLY: maintenance event targeting only the primary group member in a highly available DB System.
'
enum:
- ALL
- ALL_BUT_PRIMARY
- PRIMARY_ONLY
type: string
x-obmcs-top-level-enum: '#/definitions/MaintenanceScope'
maintenanceStatus:
description: 'The last status of the maintenance event.
'
enum:
- SUCCEEDED
- FAILED
- CANCELED
type: string
maintenanceType:
description: 'How the maintenance event was triggered.
AUTOMATIC: maintenance event triggered as part of scheduled maintenance.
MANUAL: maintenance event triggered manually.
SHAPE: maintenance event triggered by a shape update.
'
enum:
- AUTOMATIC
- MANUAL
- SHAPE
type: string
x-obmcs-top-level-enum: '#/definitions/MaintenanceType'
mysqlVersionAfterMaintenance:
description: The MySQL version after the maintenance.
type: string
mysqlVersionBeforeMaintenance:
description: The MySQL version prior to the maintenance.
type: string
timeCreated:
description: 'The date and time the record was created,
as described by [RFC 3339](https://tools.ietf.org/rfc/rfc3339).
'
format: date-time
type: string
timeEnded:
description: 'The date and time the maintenance event ended,
as described by [RFC 3339](https://tools.ietf.org/rfc/rfc3339).
'
format: date-time
type: string
timeMysqlSwitchOverEnded:
description: 'The date and time the DB System came back online during the maintenance,
as described by [RFC 3339](https://tools.ietf.org/rfc/rfc3339).
'
format: date-time
type: string
timeMysqlSwitchOverStarted:
description: 'The date and time the DB System was initially down during the maintenance,
as described by [RFC 3339](https://tools.ietf.org/rfc/rfc3339).
'
format: date-time
type: string
timeStarted:
description: 'The date and time the maintenance event started,
as described by [RFC 3339](https://tools.ietf.org/rfc/rfc3339).
'
format: date-time
type: string
required:
- dbSystemId
- compartmentId
- timeCreated
- mysqlVersionBeforeMaintenance
- mysqlVersionAfterMaintenance
- maintenanceType
- maintenanceAction
- maintenanceStatus
GenerateDbSystemStatusDetails:
description: Parameters for selecting which attributes to include in the DB System status.
properties:
channelIds:
description: List of Channel IDs for which to collect status information.
items:
type: string
maxItems: 18
minItems: 0
type: array
uniqueItems: true
gtidSetToApply:
description: "Specifies the GTID set to be checked on the DB System to determine whether it has been applied. The result of \nthe check is isGtidSetApplied in the response.\n"
type: string
gtidSetType:
default: GTID_EXECUTED
description: "Specifies whether to collect the full set of GTIDs executed on the DB System \n([gtid_executed](https://dev.mysql.com/doc/en/replication-options-gtids.html#sysvar_gtid_executed)) \nor the set of GTIDs available in the DB System binary logs, not part of\n([gtid_purged](https://dev.mysql.com/doc/en/replication-options-gtids.html#sysvar_gtid_purged)) \n(GTID_AVAILABLE, which is gtid_executed - gtid_purged).\nUse GTID_AVAILABLE if gtid_executed is too large to fit in the response.\n"
enum:
- GTID_EXECUTED
- GTID_AVAILABLE
type: string
RestDetails:
description: 'REST configuration details.
'
properties:
configuration:
default: DISABLED
description: Select how REST is configured across the DB System instances.
enum:
- DISABLED
- DBSYSTEM_ONLY
type: string
x-obmcs-top-level-enum: '#/definitions/RestConfigurationType'
port:
default: 443
description: The port for REST to listen on. Supported port numbers are 443 and from 1024 to 65535.
maximum: 65535
minimum: 443
type: integer
required:
- configuration
parameters:
FilterByConfigurationUpToDateQueryParam:
description: 'Filter instances if they are using the latest revision of the
Configuration they are associated with.
'
in: query
name: isUpToDate
required: false
schema:
type: boolean
default: false
IfNoneMatchHeader:
description: 'For conditional requests. In the GET call for a resource, set the
`If-None-Match` header to the value of the ETag from a previous GET (or
POST or PUT) response for that resource. The server will return with
either a 304 Not Modified response if the resource has not changed, or a
200 OK response with the updated representation.
'
in: header
name: if-none-match
x-default-description: No conditional request is made.
schema:
type: string
IfMatchHeader:
description: 'For optimistic concurrency control. In the PUT or DELETE call for a
resource, set the `If-Match` header to the value of the etag from a
previous GET or POST response for that resource. The resource will be
updated or deleted only if the etag you provide matches the resource''s
current etag value.
'
in: header
name: if-match
schema:
type: string
FilterByCompartmentIdQueryParam:
description: The compartment [OCID](/Content/General/Concepts/identifiers.htm).
in: query
name: compartmentId
required: true
schema:
type: string
maxLength: 255
minLength: 1
SortByMaintenanceEventFieldQueryParam:
description: 'The field to sort by. Only one sort order may be provided.
Time fields are default ordered as descending.
'
in: query
name: sortBy
required: false
schema:
type: string
enum:
- timeCreated
- timeScheduled
- timeStarted
- timeEnded
default: timeScheduled
SortOrderQueryParam:
description: The sort order to use (ASC or DESC).
in: query
name: sortOrder
schema:
type: string
enum:
- ASC
- DESC
default: ASC
SortByDbSystemFieldQueryParam:
description: 'The field to sort by. Only one sort order may be provided. Time fields are default ordered as descending. Display name is default ordered as ascending.
'
in: query
name: sortBy
required: false
schema:
type: string
enum:
- displayName
- timeCreated
default: timeCreated
FilterByMaintenanceEventMysqlVersionAfterMaintenanceQueryParam:
description: The MySQL version after the maintenance event.
in: query
name: mysqlVersionAfterMaintenance
required: false
x-default-description: If not specified, all mysql versions are considered.
schema:
type: string
FilterByMaintenanceActionQueryParam:
description: The nature of the maintenance event.
in: query
name: maintenanceAction
required: false
x-default-description: If not specified, all maintenance actions are considered.
x-obmcs-top-level-enum: '#/definitions/MaintenanceAction'
schema:
type: string
enum:
- DATABASE
- OS_UPDATE
- ONLINE_UPDATE
- HARDWARE
FilterByMaintenanceEventMaintenanceStatusQueryParam:
description: The last status of the maintenance event.
in: query
name: maintenanceStatus
required: false
x-default-description: If not specified, all maintenance statuses are considered.
x-obmcs-enumref: '#/definitions/MaintenanceEvent/maintenanceStatus'
schema:
type: string
FilterByDisplayNameQueryParam:
description: A filter to return only the resource matching the given display name exactly.
in: query
name: displayName
required: false
schema:
type: string
maxLength: 255
FilterByDbSystemLifecycleStateQueryParam:
description: DbSystem Lifecycle State
in: query
name: lifecycleState
required: false
x-obmcs-enumref: '#/definitions/DbSystem/lifecycleState'
schema:
type: string
default: AVAILABLE
FilterByHeatWaveClusterAttachedQueryParam:
description: 'If true, return only DB Systems with a HeatWave cluster attached, if false
return only DB Systems with no HeatWave cluster attached. If not
present, return all DB Systems.
'
in: query
name: isHeatWaveClusterAttached
required: false
schema:
type: boolean
default: false
PaginationTokenQueryParam:
description: 'The value of the `opc-next-page` or `opc-prev-page` response header from
the previous list call. For information about pagination, see [List
Pagination](../../../#API/Concepts/usingapi.htm#List_Pagination).
'
in: query
name: page
schema:
type: string
maxLength: 4096
minLength: 1
FilterByDatabaseManagementStatusQueryParam:
description: 'Filter DB Systems by their Database Management configuration.
'
in: query
name: databaseManagement
required: false
x-default-description: If not specified, all Database Management configurations are considered.
style: form
explode: true
schema:
type: array
items:
enum:
- ENABLED
- DISABLED
type: string
uniqueItems: true
FilterByConfigurationIdQueryParam:
description: The requested Configuration instance.
in: query
name: configurationId
required: false
schema:
type: string
maxLength: 255
minLength: 1
OpcRequestIdHeader:
description: 'Customer-defined unique identifier for the request. If you need to
contact Oracle about a specific request, please provide the request
ID that you supplied in this header with the request.
'
in: header
name: opc-request-id
required: false
schema:
type: string
DbSystemIdPathParam:
description: The DB System [OCID](/Content/General/Concepts/identifiers.htm).
in: path
name: dbSystemId
required: true
schema:
type: string
maxLength: 255
minLength: 1
OpcRetryTokenHeader:
description: 'A token that uniquely identifies a request so it can be retried in case
of a timeout or server error without risk of executing that same action
again. Retry tokens expire after 24 hours, but can be invalidated before
then due to conflicting operations (for example, if a resource has been
deleted and purged from the system, then a retry of the original
creation request may be rejected).
'
in: header
name: opc-retry-token
schema:
type: string
maxLength: 64
minLength: 1
FilterByMaintenanceTypeQueryParam:
description: How the maintenance event was triggered.
in: query
name: maintenanceType
required: false
x-default-description: If not specified, all maintenance types are considered.
x-obmcs-top-level-enum: '#/definitions/MaintenanceType'
schema:
type: string
enum:
- AUTOMATIC
- MANUAL
- SHAPE
FilterByMaintenanceEventMysqlVersionBeforeMaintenanceQueryParam:
description: The MySQL version before the maintenance event.
in: query
name: mysqlVersionBeforeMaintenance
required: false
x-default-description: If not specified, all mysql versions are considered.
schema:
type: string
PaginationLimitQueryParam:
description: 'The maximum number of items to return in a paginated list call. For information about pagination, see
[List Pagination](../../../#API/Concepts/usingapi.htm#List_Pagination).
'
in: query
name: limit
schema:
type: integer
default: 100
maximum: 1000
minimum: 1
FilterByDbSystemIdQueryParam:
description: The DB System [OCID](/Content/General/Concepts/identifiers.htm).
in: query
name: dbSystemId
required: false
schema:
type: string
maxLength: 255
minLength: 1
responses:
412-PreconditionFailed:
description: Precondition Failed
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
500-ServerError:
description: Internal Server Error
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
DefaultError:
description: An error has occurred.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
304-NotModified:
description: The resource with the given ETag has not changed.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
429-TooManyRequests:
description: Too Many Requests
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
retry-after:
description: A decimal number representing the number of seconds the client should wait before polling this endpoint again.
schema:
type: integer
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
409-Conflict:
description: Conflict
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
404-NotFound:
description: Not Found
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
400-BadRequest:
description: Bad Request
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
401-Unauthorized:
description: Unauthorized
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
x-anchors:
x-headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
type: string
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then a partial list might have been returned. Include this value as the `page` parameter for the
subsequent GET request to get the next batch of items.
'
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
type: string
retry-after:
description: A decimal number representing the number of seconds the client should wait before polling this endpoint again.
type: integer
x-properties:
backupPolicyDefinedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Usage of predefined tag keys. These predefined keys are scoped to namespaces.
Tags defined here will be copied verbatim as tags on the Backup resource created by this BackupPolicy.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
backupPolicyFreeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair applied without any predefined name, type or scope. Exists for cross-compatibility only.
Tags defined here will be copied verbatim as tags on the Backup resource created by this BackupPolicy.
Example: `{"bar-key": "value"}`
'
type: object
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
securityAttributes:
additionalProperties:
additionalProperties:
description: 'Security Attribute value and mode. Only the String type is supported for value. (Mode is reserved and “enforce” in this release)
'
type: object
description: 'Key-value pair representing a ZPR tag key and value, scoped to a namespace.
Example: `{"MaxEgressCount": {"value": "42", "mode": "audit"}}`
'
type: object
description: 'Security Attributes for this resource. Each key is predefined and scoped to a namespace.
For more information, see [ZPR Artifacts](https://docs.oracle.com/en-us/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm).
Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}`
'
type: object
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.
Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
'
type: object
x-oracle-package: com.oracle.oci.mysql