openapi: 3.2.0
info:
description: "Use the Database Management API to monitor and manage resources such as\nOracle Databases, MySQL Databases, and External Database Systems. \nFor more information, see [Database Management](/iaas/database-management/home.htm).\n"
title: Database Management Managed My Sql Databases API
version: '20201101'
x-provenance:
method: harvested
first_party: true
publisher: Oracle
source: https://docs.oracle.com/en-us/iaas/api/specs/e7e7138b3ad5254432bc9203d07c08e1e84e00d89a283cd6935a4ef61a6929cf.yaml
harvested: '2026-08-04'
note: Published by Oracle as the contract for the Database Management 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/e7e7138b3ad5254432bc9203d07c08e1e84e00d89a283cd6935a4ef61a6929cf.yaml
what: the harvested document for Database Management API
servers:
- url: http://dbmgmt.{region}.oci.oraclecloud.com/20201101
- url: https://dbmgmt.{region}.oci.oraclecloud.com/20201101
tags:
- name: managedMySqlDatabases
paths:
/heatWaveFleetMetrics:
get:
deprecated: true
description: 'Gets the health metrics for a fleet of HeatWave clusters in a compartment.
MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
'
operationId: GetHeatWaveFleetMetric
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/MetricNameFilterParam'
- $ref: '#/components/parameters/StartTimeQueryParam'
- $ref: '#/components/parameters/EndTimeQueryParam'
- $ref: '#/components/parameters/FilterByHeatWaveStatusParam'
- $ref: '#/components/parameters/FilterByHeatWaveShapeParam'
- $ref: '#/components/parameters/IsHeatWaveLakehouseEnabledParam'
responses:
200:
description: The HeatWave cluster fleet metrics were retrieved successfully.
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/HeatWaveFleetMetrics'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Gets the health metrics for a fleet of HeatWave clusters.
tags:
- managedMySqlDatabases
x-example: 'GET /20201101/heatWaveFleetMetrics?compartmentId=<compartmentId>&startTime=<startTime>
&endTime=<endTime>&filterByMetricNames=<filterByMetricNames>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
/managedMySqlDatabases:
get:
deprecated: true
description: "Gets the list of Managed MySQL Databases in a specific compartment. \nMySQL support within OCI Database Management service has been deprecated as of January 29, 2026.\n"
operationId: ListManagedMySqlDatabases
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/FilterByMySqlDatabaseTypeParam'
- $ref: '#/components/parameters/SortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
responses:
200:
description: The list of MySQL Databases was retrieved successfully.
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:
$ref: '#/components/schemas/ManagedMySqlDatabaseCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: 'Lists Managed MySql Databases.
'
tags:
- managedMySqlDatabases
x-example: 'GET /20201101/managedMySqlDatabases?compartmentId=<compartmentId>&limit=10
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
/managedMySqlDatabases/{managedMySqlDatabaseId}:
get:
deprecated: true
description: 'Retrieves the general information for a specific MySQL Database.
MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
'
operationId: GetManagedMySqlDatabase
parameters:
- $ref: '#/components/parameters/MySqlManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The MySQL Database information was retrieved successfully.
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/ManagedMySqlDatabase'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Get managed MySql databases General Information
tags:
- managedMySqlDatabases
x-example: 'GET /20201101/managedMySqlDatabases/<managedMySqlDatabaseId>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/ManagedMySqlDatabase'
/managedMySqlDatabases/{managedMySqlDatabaseId}/actions/changeManagementType:
post:
deprecated: true
description: 'Changes the management type for a HeatWave MySQL instance, from BASIC to FULL and vice versa.
It can also be used to enable or disable Database Management.
MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
'
operationId: ChangeMysqlDatabaseManagementType
parameters:
- $ref: '#/components/parameters/MySqlManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/ChangeMysqlDatabaseManagementTypeDetailsBodyParam'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: The request to change management type was received successfully.
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'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: 'Changes the management type for a HeatWave MySQL instance, enables or disables Database Management.
'
tags:
- managedMySqlDatabases
x-example: "POST /20201101/managedMySqlDatabases/{managedMySqlDatabaseId}/actions/changeManagementType\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"managementType\": \"FULL\",\n \"operation\": \"UPDATE_DBMGMT_TYPE\"\n}\n"
x-obmcs-client-retries-enabled: true
x-obmcs-terraform:
actionType: SPECIAL_UPDATE
identifier: MANAGED_MYSQL_DATABASE
x-related-resource: '#/definitions/ManagedMySqlDatabase'
/managedMySqlDatabases/{managedMySqlDatabaseId}/availabilityMetrics:
get:
deprecated: true
description: 'Gets the availability metrics for the MySQL Database specified by managedMySqlDatabaseId.
MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
'
operationId: SummarizeManagedMySqlDatabaseAvailabilityMetrics
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/MySqlManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/StartTimeQueryParam'
- $ref: '#/components/parameters/EndTimeQueryParam'
responses:
200:
description: 'The availability metrics for a given MySQL Database were retrieved successfully.
'
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:
$ref: '#/components/schemas/MetricsAggregationRangeCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: 'Gets availability metrics of given managed MySql database.
'
tags:
- managedMySqlDatabases
x-example: 'GET /20201101/managedMySqlDatabases/<managedMySqlDatabaseId>/availabilityMetrics?startTime=<startTime>
&endTime=<endTime>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ManagedMySqlDatabase'
/managedMySqlDatabases/{managedMySqlDatabaseId}/binaryLogInformation:
get:
deprecated: true
description: 'Retrieves information pertaining to the binary log of a specific MySQL server.
MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
'
operationId: GetBinaryLogInformation
parameters:
- $ref: '#/components/parameters/MySqlManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: Information pertaining to the binary log of the MySQL server was retrieved successfully.
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:
$ref: '#/components/schemas/ManagedMySqlDatabaseBinaryLogInformation'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Get information pertaining to the binary log of the managed MySQL server.
tags:
- managedMySqlDatabases
x-example: 'GET /20201101/managedMySqlDatabases/<managedMySqlDatabaseId>/binaryLogInformation
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ManagedMySqlDatabase'
/managedMySqlDatabases/{managedMySqlDatabaseId}/configurationData:
get:
deprecated: true
description: 'Retrieves configuration data for a specific MySQL database.
MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
'
operationId: ListManagedMySqlDatabaseConfigurationData
parameters:
- $ref: '#/components/parameters/MySqlManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderDescQueryParam'
- $ref: '#/components/parameters/SortByQueryParam'
responses:
200:
description: The configuration data for the MySQL Database was retrieved successfully.
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:
$ref: '#/components/schemas/MySqlConfigurationDataCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Get managed MySql databases configuration data
tags:
- managedMySqlDatabases
x-example: 'GET /20201101/managedMySqlDatabases/<managedMySqlDatabaseId>/configurationData
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ManagedMySqlDatabase'
/managedMySqlDatabases/{managedMySqlDatabaseId}/digestErrors:
get:
deprecated: true
description: 'Retrieves any potential errors for a given digest.
MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
'
operationId: ListMySqlDigestErrors
parameters:
- $ref: '#/components/parameters/MySqlManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/QueryDigestParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/SortByQueryParamDigestErrors'
- $ref: '#/components/parameters/SortOrderQueryParam'
responses:
200:
description: The MySQL errors for the given digest were retrieved successfully.
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:
$ref: '#/components/schemas/MySqlDigestErrorsCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: List the unique set of errors for given digest.
tags:
- managedMySqlDatabases
x-example: 'GET /20201101/managedMySqlDatabases/<managedMySqlDatabaseId>/digestErrors?digest=<digest>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ManagedMySqlDatabase'
/managedMySqlDatabases/{managedMySqlDatabaseId}/generalReplicationInformation:
get:
deprecated: true
description: 'Retrieves general information regarding the replication of a specific MySQL server.
MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
'
operationId: GetGeneralReplicationInformation
parameters:
- $ref: '#/components/parameters/MySqlManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: General information pertaining to the replication of the MySQL server was retrieved successfully.
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:
$ref: '#/components/schemas/ManagedMySqlDatabaseGeneralReplicationInformation'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Get general information pertaining to the replication of a MySQL server.
tags:
- managedMySqlDatabases
x-example: 'GET /20201101/managedMySqlDatabases/<managedMySqlDatabaseId>/generalReplicationInformation
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ManagedMySqlDatabase'
/managedMySqlDatabases/{managedMySqlDatabaseId}/highAvailabilityMembers:
get:
deprecated: true
description: 'Retrieves information about the high availability members of a specific MySQL server''s replication group.
MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
'
operationId: ListHighAvailabilityMembers
parameters:
- $ref: '#/components/parameters/MySqlManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/SortByQueryParamGroupMembers'
responses:
200:
description: List of high availability members of the MySQL server's replication group was retrieved successfully.
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:
$ref: '#/components/schemas/ManagedMySqlDatabaseHighAvailabilityMemberCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: List the high availability members of a MySQL server's replication group.
tags:
- managedMySqlDatabases
x-example: 'GET /20201101/managedMySqlDatabases/<managedMySqlDatabaseId>/highAvailabilityMembers
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ManagedMySqlDatabase'
/managedMySqlDatabases/{managedMySqlDatabaseId}/inboundReplications:
get:
deprecated: true
description: 'Retrieves information about the inbound replications of a specific MySQL server.
MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
'
operationId: ListInboundReplications
parameters:
- $ref: '#/components/parameters/MySqlManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/SortByQueryParamInboundReplication'
responses:
200:
description: Information about the inbound replications of the MySQL server was retrieved successfully.
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:
$ref: '#/components/schemas/ManagedMySqlDatabaseInboundReplicationCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Get the managed MySQL server's source replication status.
tags:
- managedMySqlDatabases
x-example: 'GET /20201101/managedMySqlDatabases/<managedMySqlDatabaseId>/inboundReplications
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ManagedMySqlDatabase'
/managedMySqlDatabases/{managedMySqlDatabaseId}/outboundReplications:
get:
deprecated: true
description: 'Retrieves information pertaining to the outbound replications of a specific MySQL server.
MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
'
operationId: ListOutboundReplications
parameters:
- $ref: '#/components/parameters/MySqlManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/SortByQueryParamOutboundReplication'
responses:
200:
description: Information pertaining to the outbound replications of the MySQL server was retrieved successfully.
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:
$ref: '#/components/schemas/ManagedMySqlDatabaseOutboundReplicationCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Get information pertaining to the outbound replications of the managed MySQL server.
tags:
- managedMySqlDatabases
x-example: 'GET /20201101/managedMySqlDatabases/<managedMySqlDatabaseId>/outboundReplications
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ManagedMySqlDatabase'
/managedMySqlDatabases/{managedMySqlDatabaseId}/queryDetails:
get:
deprecated: true
description: 'Retrieves query sample details, explain plan, and potential warnings for a given digest.
MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
'
operationId: GetMySqlQueryDetails
parameters:
- $ref: '#/components/parameters/MySqlManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/QueryDigestParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The SQL query details for the query sample were retrieved successfully.
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/MySqlQueryDetails'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Get a Query Sample and Related Data for a Given Digest.
tags:
- managedMySqlDatabases
x-example: 'GET /20201101/managedMySqlDatabases/<managedMySqlDatabaseId>/getSqlQueryDetails?digest=<digest>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ManagedMySqlDatabase'
/managedMySqlDatabases/{managedMySqlDatabaseId}/sqlData:
get:
deprecated: true
description: 'Retrieves the SQL performance data for a specific MySQL database.
MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
'
operationId: ListManagedMySqlDatabaseSqlData
parameters:
- $ref: '#/components/parameters/MySqlManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/FilterColumnQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/StartTimeQueryParam'
- $ref: '#/components/parameters/EndTimeQueryParam'
- $ref: '#/components/parameters/SortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
responses:
200:
description: The SQL performance data for the MySQL Database was retrieved successfully.
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:
$ref: '#/components/schemas/MySqlDataCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Get ManagedMySqlDatabases SQL Data
tags:
- managedMySqlDatabases
x-example: 'GET /20201101/managedMySqlDatabases/<managedMySqlDatabaseId>/sqlData
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ManagedMySqlDatabase'
/mysqlFleetMetrics:
get:
deprecated: true
description: 'Gets the health metrics for a fleet of MySQL Databases in a compartment.
MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
'
operationId: GetMySqlFleetMetric
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/MetricNameFilterParam'
- $ref: '#/components/parameters/StartTimeQueryParam'
- $ref: '#/components/parameters/EndTimeQueryParam'
- $ref: '#/components/parameters/FilterByMySqlDeploymentTypeParam'
- $ref: '#/components/parameters/FilterByMdsTypeParam'
- $ref: '#/components/parameters/FilterByMySqlDatabaseTypeParam'
- $ref: '#/components/parameters/FilterByMySqlStatusParam'
- $ref: '#/components/parameters/FilterByMySqlDatabaseVersionParam'
- $ref: '#/components/parameters/IsHeatWaveEnabled'
responses:
200:
description: The MySQL Database fleet metrics were retrieved successfully.
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/MySqlFleetMetrics'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Gets the health metrics for a fleet of MySQL databases.
tags:
- managedMySqlDatabases
x-example: 'GET /20201101/mysqlFleetMetrics?compartmentId=<compartmentId>&startTime=<startTime>
&endTime=<endTime>&filterByMetricNames=<filterByMetricNames>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
components:
schemas:
ManagedMySqlDatabaseBinaryLogInformation:
description: Information pertaining to the binary logs of a MySQL server. MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
properties:
binaryLogCompression:
description: Indicates whether compression is enabled for transactions written to binary log files on the MySQL server.
type: string
binaryLogCompressionPercent:
description: The compression ratio for the binary log, expressed as a percentage.
type: integer
binaryLogFormat:
description: The binary logging format used by the MySQL server.
type: string
binaryLogName:
description: The name of the binary log file.
type: string
binaryLogPosition:
description: The position within the binary log file.
format: int64
type: integer
binaryLogging:
description: The status of binary logging on the MySQL server.
type: string
required:
- binaryLogging
type: object
Error:
description: Error Information.
properties:
code:
description: A short error code that defines the error, meant for programmatic parsing.
type: string
message:
description: A human-readable error string.
type: string
required:
- code
- message
MySqlFleetMetricSummaryDefinition:
description: A summary of the fleet metrics, which provides the metric aggregated value of the MySQL Databases in the fleet. MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
properties:
dimensions:
description: The unique dimension key and values of the metric.
items:
$ref: '#/components/schemas/MetricDimensionDefinition'
type: array
metricName:
description: The name of the metric.
type: string
metricValue:
description: The aggregated metric value.
format: integer
type: number
unit:
description: The unit of the metric value.
type: string
required:
- metricValue
- dimensions
- metricName
- unit
type: object
HeatWaveFleetMetrics:
description: The details of the HeatWave cluster fleet health metrics. MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
properties:
endTime:
description: The end of the time range during which metric data is retrieved.
type: string
fleetClusters:
description: The list of HeatWave clusters in the fleet and their usage metrics.
items:
$ref: '#/components/schemas/HeatWaveClusterUsageMetrics'
type: array
fleetSummary:
description: The number of HeatWave clusters in the fleet and a summary of the metrics that provide the aggregated usage of CPU, storage, and so on of all the clusters.
items:
$ref: '#/components/schemas/HeatWaveFleetSummary'
type: array
startTime:
description: The beginning of the time range during which metric data is retrieved.
type: string
required:
- startTime
- endTime
- fleetClusters
- fleetSummary
type: object
MySqlQueryExplainPlan:
description: The explain plan for a given MySQL query. MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
properties:
jsonExplain:
description: The JSON format of the explain plan.
type: string
jsonExplainVersion:
description: The version of the JSON format of the MySQL explain plan.
enum:
- V1
- V2
type: string
x-obmcs-top-level-enum: '#/definitions/MySqlJsonExplainVersion'
required:
- jsonExplain
- jsonExplainVersion
type: object
MySqlChannelApplyError:
description: MySQL server replication channel name and error from its apply operation. MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
properties:
applyError:
$ref: '#/components/schemas/MySqlApplyError'
channelName:
description: The name of the replication channel.
type: string
required:
- applyError
type: object
HeatWaveFleetMetricSummaryDefinition:
description: A summary of the fleet metrics, which provides the metric aggregated value of the HeatWave clusters in the fleet. MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
properties:
dimensions:
description: The unique dimension key and values of the metric.
items:
$ref: '#/components/schemas/MetricDimensionDefinition'
type: array
metricName:
description: The name of the metric.
type: string
metricValue:
description: The aggregated metric value.
format: double
type: number
unit:
description: The unit of the metric value.
type: string
required:
- metricValue
- dimensions
- metricName
- unit
type: object
MySqlDatabaseUsageMetrics:
description: The list of aggregated metrics for Managed MySQL Databases in the fleet. MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
properties:
compartmentId:
description: The OCID of the compartment where the Managed MySQL Database resides.
type: string
databaseName:
description: The display name of the Managed MySQL Database.
type: string
databaseStatus:
description: 'The status of the MySQL Database. Indicates whether the status of the database
is UP, DOWN, or UNKNOWN at the current time.
'
enum:
- UP
- DOWN
- UNKNOWN
type: string
x-obmcs-top-level-enum: '#/definitions/MySqlDatabaseStatus'
databaseType:
description: Indicates MySQL Database type, ONPREMISE or MySQL Database System.
type: string
databaseVersion:
description: The version of the MySQL Database.
type: string
dbId:
description: The OCID of the Managed MySQL Database.
type: string
heatWaveClusterDisplayName:
description: The name of the HeatWave cluster.
type: string
heatWaveManagementType:
description: The selected management type for a HeatWave MySQL DB system.
type: string
x-obmcs-enumref: '#/definitions/ManagedMySqlDatabase/heatWaveManagementType'
heatWaveNodeCount:
description: The number of nodes in the HeatWave cluster.
type: integer
isHeatWaveEnabled:
description: Indicates whether HeatWave is enabled for the MySQL Database System or not.
type: boolean
mdsDeploymentType:
description: The type of MySQL Database System.
type: string
mdslifecycleState:
description: The lifecycle state of the MySQL Database System.
type: string
metrics:
description: A list of the database health metrics like CPU, Storage, and Memory.
items:
$ref: '#/components/schemas/MySqlFleetMetricDefinition'
type: array
required:
- compartmentId
- databaseName
- databaseType
- mdsDeploymentType
- mdslifecycleState
- databaseStatus
- databaseVersion
- dbId
- metrics
type: object
DbManagementAnalyticsMetric:
description: The metric details of a Database Management resource.
properties:
dimensions:
additionalProperties:
type: string
description: The qualifiers provided in the definition of the returned metric.
type: object
durationInSeconds:
description: The duration of the returned aggregated data in seconds.
format: int64
type: integer
mean:
description: The mean value of the metric.
format: double
type: number
metadata:
additionalProperties:
type: string
description: 'The additional information about the metric.
Example: `"unit": "bytes"`
'
type: object
metricName:
description: The name of the metric.
type: string
startTimestampInEpochSeconds:
description: The start time associated with the value of the metric.
format: int64
type: integer
type: object
MySqlFleetByCategory:
description: The number of MySQL Databases in the fleet, grouped by database type and sub type. MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
properties:
databaseType:
description: 'The type of the MySQL Database. Indicates whether the database is on premises or Oracle Cloud. Allowed values are: MDS and ONPREMISE'
type: string
inventoryCount:
description: The number of MySQL Databases.
type: integer
mdsDeploymentType:
description: 'The type of MySQL Database installation. Allowed values are: STANDALONE, HEATWAVE and HA'
type: string
required:
- databaseType
- mdsDeploymentType
- inventoryCount
type: object
MySqlHighAvailabilityStatusSummary:
description: High availability status summary of a MySQL server. MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
properties:
channelApplyErrors:
description: A list of MySqlChannelApplyError records.
items:
$ref: '#/components/schemas/MySqlChannelApplyError'
type: array
channelFetchErrors:
description: A list of MySqlChannelFetchError records.
items:
$ref: '#/components/schemas/MySqlChannelFetchError'
type: array
type: object
HeatWaveClusterUsageMetrics:
description: The list of aggregated metrics for a HeatWave cluster in the fleet. MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
properties:
dbSystemId:
description: The OCID of the MySQL Database System associated with the HeatWave cluster.
type: string
dbSystemName:
description: The name of the MySQL Database System associated with the HeatWave cluster.
type: string
heatWaveClusterDisplayName:
description: The name of the HeatWave cluster.
type: string
heatWaveNodeShape:
description: The shape of the nodes in the HeatWave cluster.
type: string
isLakehouseEnabled:
description: Indicates whether Lakehouse is enabled for the HeatWave cluster or not.
type: boolean
memorySize:
description: The total memory belonging to the HeatWave cluster in GBs.
type: integer
metrics:
description: A list of the HeatWave cluster health metrics like CPU and Memory.
items:
$ref: '#/components/schemas/HeatWaveFleetMetricDefinition'
type: array
nodeCount:
description: The number of nodes in the HeatWave cluster.
type: integer
status:
description: The status of the HeatWave cluster. Indicates whether the status of the cluster is UP, DOWN, or UNKNOWN at the current time.
enum:
- UP
- DOWN
- UNKNOWN
type: string
x-obmcs-top-level-enum: '#/definitions/HeatWaveClusterStatus'
required:
- status
- dbSystemId
- dbSystemName
- heatWaveClusterDisplayName
- nodeCount
- isLakehouseEnabled
- heatWaveNodeShape
- memorySize
- metrics
type: object
MySqlFleetSummary:
description: A summary of the inventory count and the metrics that describe the aggregated usage of CPU, storage, and so on of all the MySQL Databases in the fleet. MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
properties:
aggregatedMetrics:
description: The usage metrics for the Managed MySQL Databases in the fleet.
items:
$ref: '#/components/schemas/MySqlFleetMetricSummaryDefinition'
type: array
inventory:
description: A list of MySQL Databases in the fleet, grouped by database type.
items:
$ref: '#/components/schemas/MySqlFleetByCategory'
type: array
required:
- aggregatedMetrics
- inventory
type: object
ChangeMysqlDatabaseManagementTypeDetails:
description: Details required to change the management type for a HeatWave MySQL instance, from BASIC to FULL and vice versa. MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
properties:
managementType:
description: The type of HeatWave management.
type: string
x-obmcs-enumref: '#/definitions/ManagedMySqlDatabase/heatWaveManagementType'
operation:
default: UPDATE_DBMGMT_TYPE
description: 'The type of operation to perform: Update managementType, enable, or disable Database Management.
'
enum:
- ENABLE_DBMGMT
- UPDATE_DBMGMT_TYPE
- DISABLE_DBMGMT
type: string
required:
- managementType
type: object
MySqlQuerySampleDetails:
description: The details of a query sample including the query text, execution time, and other details. MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
properties:
executionTime:
description: The total amount of time that has been spent executing the query sample.
format: int64
type: integer
host:
description: The host from which the query sample was run.
maxLength: 255
type: string
mysqlInstance:
description: The MySQL instance against which the query sample was run.
maxLength: 128
type: string
querySampleText:
description: The query sample mapped by MySQL to a given normalized query.
maxLength: 1048576
type: string
threadId:
description: The thread ID of the connection.
type: integer
timeQuerySampleSeen:
description: The date and time the query sample was last seen.
format: date-time
type: string
user:
description: The user who ran the query sample.
maxLength: 128
type: string
required:
- querySampleText
- timeQuerySampleSeen
- executionTime
- threadId
- user
- host
- mysqlInstance
type: object
MySqlFetchError:
description: Error from the fetch operation of a MySQL server replication channel. MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
properties:
lastErrorMessage:
description: The error message of the most recent error that caused the I/O thread to stop.
type: string
lastErrorNumber:
description: The error number of the most recent error that caused the I/O thread to stop.
type: integer
timeLastError:
description: The timestamp when the most recent I/O error occurred.
format: date-time
type: string
required:
- lastErrorNumber
- lastErrorMessage
- timeLastError
type: object
MySqlReplicationApplierFilter:
description: Filter configured for a replication channel. MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
properties:
filterName:
description: The type of replication filter that has been configured for the replication channel.
type: string
filterRule:
description: The rules configured for the replication filter type.
type: string
required:
- filterName
type: object
MySqlFleetMetrics:
description: The details of the MySQL Database fleet health metrics. MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
properties:
endTime:
description: The end of the time range during which metric data is retrieved.
type: string
fleetDatabases:
description: The list of MySQL Databases in the fleet and their usage metrics.
items:
$ref: '#/components/schemas/MySqlDatabaseUsageMetrics'
type: array
fleetSummary:
description: A summary of the inventory count and the metrics that describe the aggregated usage of CPU, storage, and so on of all the MySQL Databases in the fleet.
items:
$ref: '#/components/schemas/MySqlFleetSummary'
type: array
startTime:
description: The beginning of the time range during which metric data is retrieved.
type: string
required:
- startTime
- endTime
- fleetDatabases
- fleetSummary
type: object
MySqlChannelFetchError:
description: MySQL server replication channel name and error from its fetch operation. MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
properties:
channelName:
description: The name of the replication channel.
type: string
fetchError:
$ref: '#/components/schemas/MySqlFetchError'
required:
- fetchError
type: object
HeatWaveFleetByCategory:
description: The number of HeatWave clusters in the fleet, grouped by shape and Lakehouse-enabled status. MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
properties:
count:
description: The number of matching HeatWave clusters.
type: integer
name:
description: The name of the HeatWave fleet category.
type: string
value:
description: The value of the HeatWave fleet category.
type: string
required:
- name
- value
- count
type: object
MySqlConfigurationDataCollection:
description: The collection of configuration records for a specific MySQL Database. MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
properties:
items:
description: The list of ConfigurationDataSummary records.
items:
$ref: '#/components/schemas/MySqlConfigurationDataSummary'
type: array
required:
- items
type: object
ManagedMySqlDatabaseSummary:
description: The details of the Managed MySQL Database. MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
properties:
compartmentId:
description: The OCID of the compartment.
type: string
databaseType:
description: 'The type of the MySQL Database. Indicates whether the database
is external or MDS.
'
enum:
- EXTERNAL
- MDS
type: string
x-obmcs-top-level-enum: '#/definitions/MySqlType'
dbName:
description: The name of the MySQL Database.
type: string
dbVersion:
description: The version of the MySQL Database.
type: string
heatWaveManagementType:
description: The selected management type for a HeatWave MySQL DB system.
type: string
x-obmcs-enumref: '#/definitions/ManagedMySqlDatabase/heatWaveManagementType'
id:
description: The OCID of the Managed MySQL Database.
type: string
lifecycleState:
description: Indicates lifecycle state of the resource.
enum:
- CREATING
- UPDATING
- ACTIVE
- DELETING
- DELETED
- FAILED
type: string
x-obmcs-top-level-enum: '#/definitions/LifecycleStates'
managementState:
description: Indicates database management status.
enum:
- ENABLED
- DISABLED
type: string
x-obmcs-top-level-enum: '#/definitions/ManagementState'
name:
description: The name of the Managed MySQL Database.
type: string
timeCreated:
description: The date and time the Managed MySQL Database was created.
format: date-time
type: string
required:
- dbName
- name
- dbVersion
- id
- compartmentId
- timeCreated
type: object
ManagedMySqlDatabaseHighAvailabilityMemberCollection:
description: Information pertaining to high availability of a MySQL server. MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
properties:
flowControl:
description: The mode used for flow control.
type: string
groupAutoIncrement:
description: The interval between successive values for auto-incremented columns for transactions that execute on this server instance.
type: integer
groupName:
description: The name of the group to which this server instance belongs.
type: string
items:
description: A list of MySqlHighAvailabilityMember records.
items:
$ref: '#/components/schemas/ManagedMySqlDatabaseHighAvailabilityMemberSummary'
type: array
memberRole:
description: The role of this server as a group replication member.
type: string
memberState:
description: The state of this server as a group replication member.
type: string
singlePrimaryMode:
description: Indicates if the replication group is running in single-primary mode.
type: string
statusSummary:
$ref: '#/components/schemas/MySqlHighAvailabilityStatusSummary'
transactionsInGtidExecuted:
description: The number of transactions that were replicated within the cluster.
format: int64
type: integer
viewId:
description: The current view identifier for this group.
type: string
required:
- items
type: object
MySqlDigestErrorSummary:
description: The MySQL digest error and the number of times it is encountered. MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
properties:
error:
$ref: '#/components/schemas/MySqlQueryMessage'
occurrenceCount:
description: The number of times a MySQL error is encountered.
type: integer
required:
- error
- occurrenceCount
type: object
MySqlApplyErrorWorker:
description: If the replica is multi-threaded, error from worker threads. Otherwise, error from the applier thread. MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
properties:
lastErrorMessage:
description: The error message of the most recent error that caused the worker thread to stop.
type: string
lastErrorNumber:
description: The error number of the most recent error that caused the worker thread to stop.
type: integer
timeLastError:
description: The timestamp when the most recent worker error occurred.
format: date-time
type: string
required:
- lastErrorNumber
- lastErrorMessage
- timeLastError
type: object
MetricDimensionDefinition:
description: The metric dimension details.
properties:
dimensionName:
description: The name of the dimension.
type: string
dimensionValue:
description: The value of the dimension.
type: string
type: object
MySqlDataCollection:
description: The collection of SQL performance data records for a specific Managed MySQL Database. MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
properties:
items:
description: The list of SQLDataSummary records.
items:
$ref: '#/components/schemas/MySqlDataSummary'
type: array
required:
- items
type: object
ManagedMySqlDatabaseCollection:
description: A collection of Managed MySQL Database objects. MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
properties:
items:
description: An array of ManagedMySqlDatabaseSummary resources.
items:
$ref: '#/components/schemas/ManagedMySqlDatabaseSummary'
type: array
required:
- items
type: object
HeatWaveNode:
description: The information about an individual HeatWave node. MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
properties:
id:
description: The ID associated with the HeatWave node.
type: string
status:
description: The status of the HeatWave node. Indicates whether the status of the node is UP, DOWN, or UNKNOWN at the current time.
enum:
- UP
- DOWN
- UNKNOWN
type: string
x-obmcs-top-level-enum: '#/definitions/HeatWaveNodeStatus'
timeCreated:
description: The date and time the HeatWave node was created.
format: date-time
type: string
required:
- id
- status
- timeCreated
type: object
MetricsAggregationRange:
description: The set of aggregated data returned for a metric.
properties:
header:
$ref: '#/components/schemas/DbManagementAnalyticsMetric'
metrics:
description: 'The list of metrics returned for the specified request. Each of the metrics
has a `metricName` and additional properties like `metadata`, `dimensions`.
If a property is not set, then use the value from `header`.
Suppose `m` be an item in the `metrics` array:
- If `m.metricName` is not set, use `header.metricName` instead
- If `m.durationInSeconds` is not set, use `header.durationInSeconds` instead
- If `m.dimensions` is not set, use `header.dimensions` instead
- If `m.metadata` is not set, use `header.metadata` instead
'
items:
$ref: '#/components/schemas/DbManagementAnalyticsMetric'
type: array
rangeEndTimeInEpochSeconds:
description: The end of the time range (exclusive) of the returned metric data.
format: int64
type: integer
rangeStartTimeInEpochSeconds:
description: The beginning of the time range (inclusive) of the returned metric data.
format: int64
type: integer
type: object
MySqlApplyError:
description: Error from the apply operation of a MySQL server replication channel. MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
properties:
lastErrorMessage:
description: The error message of the most recent error that caused the SQL or coordinator thread to stop.
type: string
lastErrorNumber:
description: The error number of the most recent error that caused the SQL or coordinator thread to stop.
type: integer
timeLastError:
description: The timestamp when the most recent SQL or coordinator error occurred.
format: date-time
type: string
workerErrors:
description: A list of MySqlApplyErrorWorker records.
items:
$ref: '#/components/schemas/MySqlApplyErrorWorker'
type: array
type: object
ManagedMySqlDatabaseGeneralReplicationInformation:
description: General information about the replication of a MySQL server. MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
properties:
applyStatusSummary:
description: A summary of the current status of apply operations.
type: string
binaryLogFormat:
description: The binary logging format used by this server.
type: string
binaryLogging:
description: The status of binary logging on this server.
type: string
executedGtidSet:
description: The set of global transaction identifiers for transactions that have been executed on this source server.
type: string
fetchStatusSummary:
description: A summary of the current status of fetch operations.
type: string
gtidMode:
description: The Global Transaction Identifier (GTID) mode of this server.
type: string
highAvailabilityMemberState:
description: The state of this server as a group replication member.
type: string
hostName:
description: This server's host name.
type: string
inboundReplicationsCount:
description: The number of sources this server is replicating from.
type: integer
instanceType:
description: The type of the instance for example, Source, Replica, Primary Group Member, and Secondary Group Member. If the instance is replicating from one or more sources and has one or more replicas, which means, it belongs to a replication chain, the instance type can be Replica/Source.
type: string
isHighAvailabilityEnabled:
description: Specifies if high availability is enabled on this server.
type: boolean
outboundReplicationsCount:
description: The number of replicas replicating from this server.
type: integer
port:
description: The number of the port on which the server listens for TCP/IP connections.
type: integer
readOnly:
description: If the value is ON, the instance is configured as read_only. If the value is SUPER, the instance is configured as super_read_only. If the value is OFF, the instance is neither read_only nor super_read_only.
enum:
- 'ON'
- SUPER
- 'OFF'
type: string
x-obmcs-top-level-enum: '#/definitions/MySqlReadOnly'
secondsBehindSourceMax:
description: The number of seconds the replica is behind the source. When multiple sources are involved, this is the maximum value across all sources.
format: int64
type: integer
serverId:
description: This server's ID.
format: int64
type: integer
serverUuid:
description: This server's Universally Unique Identifier (UUID).
type: string
required:
- serverUuid
- serverId
- readOnly
type: object
MySqlQueryDetails:
description: The details of a given MySQL query, which consists of the query sample details, the explain plan, and potential warnings. MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
properties:
queryExplainPlan:
$ref: '#/components/schemas/MySqlQueryExplainPlan'
queryMessages:
description: The errors, warnings, and notes that could be raised by the execution of the query.
items:
$ref: '#/components/schemas/MySqlQueryMessage'
type: array
querySampleDetails:
$ref: '#/components/schemas/MySqlQuerySampleDetails'
required:
- querySampleDetails
type: object
HeatWaveFleetMetricDefinition:
description: An aggregated metric for a HeatWave cluster. MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
properties:
dimensions:
description: The dimensions of the metric.
items:
$ref: '#/components/schemas/MetricDimensionDefinition'
type: array
metricName:
description: The name of the metric.
type: string
metricValue:
description: The value of the metric.
format: double
type: number
timestamp:
description: The data point date and time in UTC in ISO-8601 format.
format: date-time
type: string
unit:
description: The unit of the metric value.
type: string
required:
- metricValue
- dimensions
- metricName
- timestamp
- unit
type: object
MySqlFleetMetricDefinition:
description: The list of aggregated metrics for the Managed MySQL Databases in the fleet. MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
properties:
dimensions:
description: The dimensions of the metric.
items:
$ref: '#/components/schemas/MetricDimensionDefinition'
type: array
metricName:
description: The name of the metric.
type: string
metricValue:
description: The value of the metric.
type: integer
metricValueDouble:
description: The value of the metric.
format: double
type: number
timestamp:
description: The data point date and time in UTC in ISO-8601 format.
format: date-time
type: string
unit:
description: The unit of the metric value.
type: string
required:
- metricValue
- dimensions
- metricName
- timestamp
- unit
type: object
ManagedMySqlDatabaseHighAvailabilityMemberSummary:
description: Information about a member of a MySQL server group replication for high availability. MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
properties:
memberHost:
description: The host name of the group member that clients use to connect to it.
type: string
memberPort:
description: The port number of the group member that clients use to connect to it.
type: integer
memberRole:
description: The current role of the group member in the group.
type: string
memberState:
description: The current state of the group member.
type: string
memberUuid:
description: The Universally Unique Identifier (UUID) of the member server.
type: string
required:
- memberHost
- memberPort
- memberUuid
type: object
ManagedMySqlDatabaseInboundReplicationSummary:
description: Inbound replication information of a MySQL replica. MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
properties:
applierFilters:
description: A list of MySqlReplicationApplierFilter records.
items:
$ref: '#/components/schemas/MySqlReplicationApplierFilter'
type: array
applyDelay:
description: The time in seconds that the current transaction took between being committed on the source and being applied on the replica.
format: double
type: number
applyError:
$ref: '#/components/schemas/MySqlApplyError'
applyStatus:
description: The current status of apply operations.
type: string
busyWorkers:
description: The number of workers currently busy applying transactions from the source server.
type: integer
channelName:
description: The name of the replication channel.
type: string
desiredDelaySeconds:
description: The desired number of seconds that the replica must lag the source.
format: int64
type: integer
fetchError:
$ref: '#/components/schemas/MySqlFetchError'
fetchStatus:
description: The current status of fetch operations.
type: string
gtidAssignment:
description: Indicates whether the channel assigns global transaction identifiers (GTIDs) to anonymous replicated transactions. OFF means no GTIDs are assigned. LOCAL means a GTID is assigned that includes this replica's own universally unique identifier (UUID). A UUID as value indicates that a GTID is assigned, which includes that manually set UUID value.
type: string
relayLogStorageSpaceUsed:
description: The total size in bytes of all the existing relay log files pertaining to this channel.
format: int64
type: integer
remainingDelaySeconds:
description: If the replica is waiting for the desired delay seconds to pass since the source applied an event, this field contains the number of delay seconds remaining.
format: int64
type: integer
retrievedGtidSet:
description: The set of global transaction IDs corresponding to all transactions received by this replica from the source server. Empty if GTIDs are not in use.
type: string
secondsBehindSource:
description: The number of seconds the replica is behind the source server.
format: int64
type: integer
sourceHost:
description: The host name or IP address of the source this replica is connected to.
type: string
sourcePort:
description: The port used to connect to the source.
type: integer
sourceServerId:
description: The server ID value from the source server.
format: int64
type: integer
sourceUuid:
description: The Universally Unique Identifier (UUID) value from the source server.
type: string
transactionsReceived:
description: The number of transactions received by this replica from the source server.
format: int64
type: integer
required:
- sourceHost
- sourcePort
- sourceUuid
type: object
MySqlDataSummary:
description: The SQL performance data record for a specific SQL query. MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
properties:
avgTimerWait:
description: The average execution time.
type: number
countStar:
description: The number Of times the query has been executed.
type: number
digest:
description: The digest information of the normalized query.
type: string
digestText:
description: The normalized query.
type: string
firstSeen:
description: The date and time the query was first seen. If the table is truncated, the first seen value is reset.
format: date-time
type: string
heatWaveOffloaded:
description: The number of query executions offloaded to HeatWave.
type: number
heatWaveOutOfMemory:
description: The number of query executions with HeatWave out-of-memory errors.
type: number
lastSeen:
description: The date and time the query was last seen.
format: date-time
type: string
maxControlledMemory:
description: The maximum amount of controlled memory used by a statement during execution.
format: int64
type: integer
maxTimerWait:
description: The slowest the query has been executed.
type: number
maxTotalMemory:
description: The maximum amount of memory used by a statement during execution.
format: int64
type: integer
minTimerWait:
description: The fastest the query has been executed.
type: number
quantile95:
description: The 95th percentile of the query latency. That is, 95% of the queries complete in the time given or in less time.
type: number
quantile99:
description: The 99th percentile of the query latency.
type: number
quantile999:
description: The 99.9th percentile of the query latency.
type: number
schemaName:
description: The name of the default schema when executing the query. If a schema is not set as the default, then the value is NULL.
type: string
sumCpuTime:
description: The total amount of time spent on CPU for this statement.
format: int64
type: integer
sumCreatedTempDiskTables:
description: The total number of On-Disk internal temporary tables that have been created by the query.
type: number
sumCreatedTempTables:
description: The total number of internal temporary tables (in memory or on disk), which have been created by the query.
type: number
sumErrors:
description: 'The total number of errors that have been encountered executing the query. '
type: number
sumLockTime:
description: The total amount of time that has been spent waiting for table locks.
type: number
sumNoGoodIndexUsed:
description: The total number of times no good index was used. This means that the extra column in The EXPLAIN output includes “Range Checked For Each Record.”
type: number
sumNoIndexUsed:
description: The total number of times no index was used to execute the query.
type: number
sumRowsAffected:
description: The total number of rows that have been modified by the query.
type: number
sumRowsExamined:
description: The total number of rows that have been examined by the query.
type: number
sumRowsSent:
description: The total number of rows that have been returned (sent) to the client.
type: number
sumSelectFullJoin:
description: The total number of joins that have performed full table scans as there was no join condition or no index for the join condition. This is the same as the select_full_join status variable.
type: number
sumSelectFullRangeJoin:
description: The total number of joins that use a full range search. This is the same as the select_full_range_join status variable.
type: number
sumSelectRange:
description: The total number of times the query has used a range search. This is the same as the select_range status variable.
type: number
sumSelectRangeCheck:
description: The total number of joins by the query where the join does not have an index that checks for the index usage after each row. This is the same as the select_range_check status variable.
type: number
sumSelectScan:
description: The total number of times the query has performed a full table scan on the first table in the join. This is the same as the select_scan status variable.
type: number
sumSortMergePasses:
description: The total number of sort merge passes that have been done to sort the result of the query. This is the same as the sort_merge_passes status variable.
type: number
sumSortRange:
description: The total number of times a sort was done using ranges. This is the same as the sort_range status variable.
type: number
sumSortRows:
description: The total number of rows sorted. This is the same as the sort_rowsStatus variable.
type: number
sumSortScan:
description: The total number of times a sort was done by scanning the table. This is the same as the sort_scan status variable.
type: number
sumTimerWait:
description: The total amount of time that has been spent executing the query.
type: number
sumWarnings:
description: 'The total number of warnings that have been encountered executing the query. '
type: number
required:
- schemaName
- digest
- digestText
- countStar
- sumTimerWait
- minTimerWait
- avgTimerWait
- maxTimerWait
- sumLockTime
- sumErrors
- sumWarnings
- sumRowsAffected
- sumRowsExamined
- sumRowsSent
- sumCreatedTempDiskTables
- sumCreatedTempTables
- sumSelectFullJoin
- sumSelectFullRangeJoin
- sumSelectRange
- sumSortMergePasses
- sumSelectRangeCheck
- sumSelectScan
- sumSortRange
- sumSortRows
- sumSortScan
- sumNoIndexUsed
- sumNoGoodIndexUsed
- firstSeen
- lastSeen
- quantile95
- quantile99
- quantile999
type: object
ManagedMySqlDatabaseOutboundReplicationCollection:
description: The collection of outbound replication records of a MySQL server. MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
properties:
items:
description: The list of ManagedMySqlDatabaseOutboundReplicationSummary records.
items:
$ref: '#/components/schemas/ManagedMySqlDatabaseOutboundReplicationSummary'
type: array
outboundReplicationsCount:
description: The number of outbound replications from the MySQL server.
type: integer
required:
- items
type: object
MySqlConfigurationDataSummary:
description: The configuration variables for a MySQL Database. MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
properties:
defaultValue:
description: The default value of the variable.
type: string
description:
description: The description of the variable.
type: string
hostSet:
description: The host from where the value of the variable was set. This is empty for a MySQL Database System.
type: string
isConfigurable:
description: Indicates whether the variable is configurable.
type: boolean
isDynamic:
description: Indicates whether the variable can be set dynamically or not.
type: boolean
isInit:
description: Indicates whether the variable is set at server startup.
type: boolean
maxValue:
description: The maximum value of the variable.
type: number
minValue:
description: The minimum value of the variable.
type: number
name:
description: The name of the configuration variable
type: string
path:
description: The path name of the option file (VARIABLE_PATH), if the variable was set in an option file. If the variable was not set in an
type: string
possibleValues:
description: The comma-separated list of possible values for the variable in value:valueDescription format.
type: string
source:
description: The source from which the variable was most recently set.
enum:
- COMPILED
- GLOBAL
- SERVER
- EXPLICIT
- EXTRA
- USER
- LOGIN
- COMMAND_LINE
- PERSISTED
- DYNAMIC
type: string
supportedVersions:
description: The comma-separated list of MySQL versions that support the variable.
type: string
timeSet:
description: The time when the value of the variable was set.
format: date-time
type: string
type:
description: The type of variable.
type: string
userSet:
description: The user who sets the value of the variable. This is empty for a MySQL Database System.
type: string
value:
description: The value of the variable.
type: string
required:
- name
- value
- source
- minValue
- maxValue
- type
- defaultValue
- timeSet
- hostSet
- userSet
- isDynamic
- isInit
- isConfigurable
- path
- description
- possibleValues
- supportedVersions
type: object
HeatWaveFleetSummary:
description: The inventory count of HeatWave clusters in the fleet and a summary of the metrics that provide the aggregated usage of CPU, storage, and so on of all the clusters. MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
properties:
aggregatedMetrics:
description: The usage metrics for the HeatWave clusters in the fleet.
items:
$ref: '#/components/schemas/HeatWaveFleetMetricSummaryDefinition'
type: array
inventory:
description: The number of HeatWave clusters in the fleet, grouped by cluster type or other properties.
items:
$ref: '#/components/schemas/HeatWaveFleetByCategory'
type: array
required:
- aggregatedMetrics
- inventory
type: object
MetricsAggregationRangeCollection:
description: The collection of metrics.
properties:
endTime:
description: 'The end of the metric data query time range. Expressed in UTC in
ISO-8601 format, which is `yyyy-MM-dd''T''hh:mm:ss.sss''Z''`.
'
type: string
items:
description: The metric data.
items:
$ref: '#/components/schemas/MetricsAggregationRange'
type: array
startTime:
description: 'The beginning of the metric data query time range. Expressed in UTC in
ISO-8601 format, which is `yyyy-MM-dd''T''hh:mm:ss.sss''Z''`.
'
type: string
required:
- items
type: object
MySqlQueryMessage:
description: The MySQL error, warning, or note raised when a query is run, if any. MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
properties:
code:
description: The MySQL code of the raised error, warning, or note.
type: integer
level:
description: The level of severity of the MySQL message.
enum:
- ERROR
- WARNING
- NOTE
type: string
x-obmcs-top-level-enum: '#/definitions/MySqlMessageSeverity'
messageText:
description: The MySQL message text of the raised error, warning, or note.
maxLength: 512
type: string
required:
- level
- code
- messageText
type: object
ManagedMySqlDatabaseOutboundReplicationSummary:
description: An outbound replication record of a MySQL server. MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
properties:
replicaHost:
description: The host name of the replica server, as specified on the replica with the --report-host option. This can differ from the machine name as configured in the operating system.
type: string
replicaPort:
description: The port on the replica server, as specified on the replica with the --report-port option. A zero in this column means that the replica port (--report-port) was not set.
type: integer
replicaServerId:
description: The server ID value of the replica.
format: int64
type: integer
replicaUuid:
description: The Universally Unique Identifier (UUID) value of the replica server.
type: string
required:
- replicaUuid
- replicaServerId
type: object
ManagedMySqlDatabase:
description: The details of the Managed MySQL Database. MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
properties:
compartmentId:
description: The OCID of the compartment.
type: string
databaseType:
description: 'The type of the MySQL Database. Indicates whether the database
is external or MDS.
'
enum:
- EXTERNAL
- MDS
type: string
x-obmcs-top-level-enum: '#/definitions/MySqlType'
dbName:
description: The name of the MySQL Database.
type: string
dbVersion:
description: The version of the MySQL Database.
type: string
heatWaveClusterDisplayName:
description: The name of the HeatWave cluster.
type: string
heatWaveManagementType:
description: The selected management type for a HeatWave MySQL DB system.
enum:
- BASIC
- FULL
type: string
heatWaveMemorySize:
description: The total memory belonging to the HeatWave cluster in GBs.
type: integer
heatWaveNodeShape:
description: The shape of the nodes in the HeatWave cluster.
type: string
heatWaveNodes:
description: The information about individual HeatWave nodes in the cluster.
items:
$ref: '#/components/schemas/HeatWaveNode'
type: array
id:
description: The OCID of the Managed MySQL Database.
type: string
isHeatWaveActive:
description: Indicates whether the HeatWave cluster is active or not.
type: boolean
isHeatWaveEnabled:
description: Indicates whether HeatWave is enabled for the MySQL Database System or not.
type: boolean
isLakehouseEnabled:
description: Indicates whether HeatWave Lakehouse is enabled for the MySQL Database System or not.
type: boolean
lifecycleState:
description: Indicates lifecycle state of the resource.
enum:
- CREATING
- UPDATING
- ACTIVE
- DELETING
- DELETED
- FAILED
type: string
x-obmcs-top-level-enum: '#/definitions/LifecycleStates'
managementState:
description: Indicates database management status.
enum:
- ENABLED
- DISABLED
type: string
x-obmcs-top-level-enum: '#/definitions/ManagementState'
name:
description: The name of the Managed MySQL Database.
type: string
timeCreated:
description: The date and time the Managed MySQL Database was created.
format: date-time
type: string
timeCreatedHeatWave:
description: The date and time the Managed MySQL Database was created.
format: date-time
type: string
timeUpdated:
description: The date and time the Managed MySQL Database was updated.
format: date-time
type: string
required:
- dbName
- name
- dbVersion
- id
- compartmentId
- timeCreated
type: object
MySqlDigestErrorsCollection:
description: The collection of errors for a given digest. MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
properties:
items:
description: The unique set of errors for a given digest.
items:
$ref: '#/components/schemas/MySqlDigestErrorSummary'
type: array
required:
- items
type: object
ManagedMySqlDatabaseInboundReplicationCollection:
description: The collection of inbound replication records for a specific MySQL server. MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
properties:
inboundReplicationsCount:
description: The number of sources this server is replicating from.
type: integer
items:
description: A list of ManagedMySqlDatabaseInboundReplicationSummary records.
items:
$ref: '#/components/schemas/ManagedMySqlDatabaseInboundReplicationSummary'
type: array
parallelWorkers:
description: The number of applier threads for executing replication transactions in parallel.
type: integer
preserveCommitOrder:
description: For multi-threaded replicas, indicates if transactions are executed and committed on the replica in the same order as they appear in the relay log.
type: string
replicaServerId:
description: The server ID value of this replica.
format: int64
type: integer
replicaUuid:
description: The Universally Unique Identifier (UUID) value of this replica server.
type: string
required:
- items
type: object
parameters:
FilterColumnQueryParam:
description: 'The parameter to filter results by key criteria which include :
- AVG_TIMER_WAIT
- SUM_TIMER_WAIT
- COUNT_STAR
- SUM_ERRORS
- SUM_ROWS_AFFECTED
- SUM_ROWS_SENT
- SUM_ROWS_EXAMINED
- SUM_CREATED_TMP_TABLES
- SUM_NO_INDEX_USED
- SUM_NO_GOOD_INDEX_USED
- FIRST_SEEN
- LAST_SEEN
- HEATWAVE_OFFLOADED
- HEATWAVE_OUT_OF_MEMORY
'
in: query
name: filterColumn
required: false
x-default-description: 'null'
schema:
type: string
EndTimeQueryParam:
description: 'The end time of the time range to retrieve the health metrics of a Managed Database
in UTC in ISO-8601 format, which is "yyyy-MM-dd''T''hh:mm:ss.sss''Z''".
'
in: query
name: endTime
required: true
schema:
type: string
IfMatchHeader:
description: 'For optimistic concurrency control. In the PUT or DELETE call
for a resource, set the `if-match` parameter 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
required: false
schema:
type: string
SortByQueryParamGroupMembers:
description: "The field to sort information by. Only one sortOrder can be used. \nThe default sort by field is ‘memberHost’.\nThe default sort order for ‘memberHost’ is ascending.\nThe ‘memberHost’ sort order is case-sensitive.\n"
in: query
name: sortBy
schema:
type: string
enum:
- memberHost
default: memberHost
MySqlManagedDatabaseIdPathParam:
description: The OCID of the Managed MySQL Database.
in: path
name: managedMySqlDatabaseId
required: true
x-default-description: 'null'
schema:
type: string
SortOrderQueryParam:
description: The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order.
in: query
name: sortOrder
x-obmcs-top-level-enum: '#/definitions/SortOrders'
schema:
type: string
enum:
- ASC
- DESC
default: ASC
SortByQueryParamInboundReplication:
description: "The field to sort information by. Only one sortOrder can be used. \nThe default sort by field is ‘sourceHost’.\nThe default sort order for ‘sourceHost’ is ascending.\nThe ‘sourceHost’ sort order is case-sensitive.\n"
in: query
name: sortBy
schema:
type: string
enum:
- sourceHost
default: sourceHost
SortByQueryParamDigestErrors:
description: 'The field to sort information by. Only one sortOrder can be used.
The default sort by field is ‘occurrenceCount’.
The default sort order for ‘occurrenceCount’ is descending.
'
in: query
name: sortBy
schema:
type: string
enum:
- occurrenceCount
default: occurrenceCount
FilterByHeatWaveStatusParam:
description: The parameter to filter by HeatWave cluster status.
in: query
name: filterByHeatWaveStatus
required: false
x-default-description: 'null'
x-obmcs-top-level-enum: '#/definitions/HeatWaveClusterStatus'
schema:
type: string
enum:
- UP
- DOWN
- UNKNOWN
RequestIdHeader:
description: The client request ID for tracing.
in: header
name: opc-request-id
schema:
type: string
QueryDigestParam:
description: The digest of a MySQL normalized query.
in: query
name: digest
required: true
x-default-description: 'null'
schema:
type: string
SortByQueryParam:
description: 'The field to sort information by. Only one sortOrder can be used. The default sort order
for ‘TIMECREATED’ is descending and the default sort order for ‘NAME’ is ascending.
The ‘NAME’ sort order is case-sensitive.
'
in: query
name: sortBy
schema:
type: string
enum:
- TIMECREATED
- NAME
default: TIMECREATED
FilterByMySqlDatabaseTypeParam:
description: The parameter to filter by MySQL database type. Allowed values are EXTERNAL or MDS.
in: query
name: filterByMySqlDatabaseTypeParam
required: false
x-default-description: 'null'
x-obmcs-top-level-enum: '#/definitions/MySqlType'
schema:
type: string
enum:
- EXTERNAL
- MDS
SortOrderDescQueryParam:
description: The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Descending order is the default order.
in: query
name: sortOrder
x-obmcs-top-level-enum: '#/definitions/SortOrders'
schema:
type: string
enum:
- ASC
- DESC
default: DESC
StartTimeQueryParam:
description: 'The start time of the time range to retrieve the health metrics of a Managed Database
in UTC in ISO-8601 format, which is "yyyy-MM-dd''T''hh:mm:ss.sss''Z''".
'
in: query
name: startTime
required: true
schema:
type: string
IsHeatWaveEnabled:
description: The parameter to filter based on whether HeatWave is enabled for the database.
in: query
name: isHeatWaveEnabled
required: false
x-default-description: 'null'
schema:
type: boolean
FilterByHeatWaveShapeParam:
description: The parameter to filter by HeatWave node shape.
in: query
name: filterByHeatWaveShape
required: false
x-default-description: 'null'
schema:
type: string
SortByQueryParamOutboundReplication:
description: "The field to sort information by. Only one sortOrder can be used. \nThe default sort by field is ‘replicaHost’.\nThe default sort order for ‘replicaHost’ is ascending.\nThe ‘replicaHost’ sort order is case-sensitive.\n"
in: query
name: sortBy
schema:
type: string
enum:
- replicaHost
default: replicaHost
PaginationTokenQueryParam:
description: 'The page token representing the page from where the next set of paginated results
are retrieved. This is usually retrieved from a previous list call.
'
in: query
name: page
x-default-description: 'null'
schema:
type: string
maxLength: 1024
minLength: 1
FilterByMySqlDeploymentTypeParam:
description: The parameter to filter by MySQL deployment type.
in: query
name: filterByMySqlDeploymentTypeParam
required: false
x-default-description: 'null'
x-obmcs-top-level-enum: '#/definitions/MySqlDeploymentType'
schema:
type: string
enum:
- ONPREMISE
- MDS
FilterByMySqlStatusParam:
description: The parameter to filter by MySQL Database status.
in: query
name: filterByMySqlStatus
required: false
x-default-description: 'null'
x-obmcs-top-level-enum: '#/definitions/DatabaseStatus'
schema:
type: string
enum:
- UP
- DOWN
- UNKNOWN
FilterByMdsTypeParam:
description: The parameter to filter by MySQL Database System type.
in: query
name: filterByMdsDeploymentType
required: false
x-default-description: 'null'
x-obmcs-top-level-enum: '#/definitions/MdsType'
schema:
type: string
enum:
- HA
- HEATWAVE
- STANDALONE
MetricNameFilterParam:
description: The filter used to retrieve a specific set of metrics by passing the desired metric names with a comma separator. Note that, by default, the service returns all supported metrics.
in: query
name: filterByMetricNames
required: false
x-default-description: 'null'
schema:
type: string
RetryTokenHeader:
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
might be rejected.
'
in: header
name: opc-retry-token
required: false
schema:
type: string
maxLength: 64
minLength: 1
IsHeatWaveLakehouseEnabledParam:
description: The parameter to filter based on whether HeatWave Lakehouse is enabled for the cluster.
in: query
name: isHeatWaveLakehouseEnabled
required: false
x-default-description: 'null'
schema:
type: boolean
ChangeMysqlDatabaseManagementTypeDetailsBodyParam:
description: The details required to change the management type of a MySQL managed database.
in: body
name: ChangeMysqlDatabaseManagementTypeDetails
required: true
schema:
$ref: '#/components/schemas/ChangeMysqlDatabaseManagementTypeDetails'
CompartmentIdQueryParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
in: query
name: compartmentId
required: true
schema:
type: string
maxLength: 255
minLength: 1
PaginationLimitQueryParam:
description: The maximum number of records returned in the paginated response.
in: query
name: limit
schema:
type: integer
default: 10
maximum: 1000
minimum: 1
FilterByMySqlDatabaseVersionParam:
description: The parameter to filter by MySQL database version.
in: query
name: filterByMySqlDatabaseVersion
required: false
x-default-description: 'null'
schema:
type: string
responses:
default:
description: Unknown 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'
x-anchors:
x-headers:
content-location:
description: Content Location of the resource.
format: uri-reference
type: string
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
type: string
location:
description: Location of the resource.
format: uri-reference
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
x-properties:
Sunset:
description: 'Sunset date when this operation will stop working, in format, Fri, 29 Jan 2027 00:00:00 GMT.
'
type: string
cloudDbSystemConnectorCredentialName:
description: 'The name of the credential information that used to connect to the DB system resource.
The name should be in "x.y" format, where the length of "x" has a maximum of 64 characters,
and length of "y" has a maximum of 199 characters. The name strings can contain letters,
numbers and the underscore character only. Other characters are not valid, except for
the "." character that separates the "x" and "y" portions of the name.
*IMPORTANT* - The name must be unique within the OCI region the credential is being created in.
If you specify a name that duplicates the name of another credential within the same OCI region,
you may overwrite or corrupt the credential that is already using the name.
For example: inventorydb.abc112233445566778899
'
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
externalDbSystemConnectorCredentialName:
description: 'The name of the credential information that used to connect to the DB system resource.
The name should be in "x.y" format, where the length of "x" has a maximum of 64 characters,
and length of "y" has a maximum of 199 characters. The name strings can contain letters,
numbers and the underscore character only. Other characters are not valid, except for
the "." character that separates the "x" and "y" portions of the name.
*IMPORTANT* - The name must be unique within the OCI region the credential is being created in.
If you specify a name that duplicates the name of another credential within the same OCI region,
you may overwrite or corrupt the credential that is already using the name.
For example: inventorydb.abc112233445566778899
'
maxLength: 255
minLength: 1
type: string
externalLicenseModel:
description: 'The Oracle license model that applies to the external database.
'
enum:
- LICENSE_INCLUDED
- BRING_YOUR_OWN_LICENSE
type: string
freeformTags:
additionalProperties:
type: string
description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
Example: `{"Department": "Finance"}`
'
type: object
licenseModel:
description: 'The Oracle license model that applies to the database management resources.
'
enum:
- LICENSE_INCLUDED
- BRING_YOUR_OWN_LICENSE
type: string
lifecycleState:
description: The current lifecycle state of the database resource.
enum:
- CREATING
- ACTIVE
- INACTIVE
- UPDATING
- DELETING
- DELETED
- FAILED
type: string
securityAttributes:
additionalProperties:
additionalProperties:
description: 'Attribute value and mode. Only the String type is supported for value. Mode is currently always "enforce".
'
type: object
description: 'Key-value pair representing a security attribute key and value, scoped to a namespace.
Example: `{"MaxEgressCount": {"value": "42", "mode": "enforce"}}`
'
type: object
description: 'Security attributes for this resource. Each key is predefined and scoped to a namespace.
For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}`
'
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 a defined tag key and value, scoped to a namespace.
Example: `{"free-tier-retained": "true"}`
'
type: object
description: 'System tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
System tags can be viewed by users, but can only be created by the system.
Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
'
type: object
x-oracle-package: com.oracle.oci.dpd.dbmgmt