{ "opencollection": "1.0.0", "info": { "name": "Database Management Managed My Sql Databases API", "version": "20201101" }, "items": [ { "info": { "name": "managedMySqlDatabases", "type": "folder" }, "items": [ { "info": { "name": "Gets the health metrics for a fleet of HeatWave clusters.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/heatWaveFleetMetrics", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "filterByMetricNames", "value": "", "type": "query", "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." }, { "name": "startTime", "value": "", "type": "query", "description": "The start time of the time range to retrieve the health metrics of a Managed Database\nin UTC in ISO-8601 format, which is \"yyyy-MM-dd'T'hh:mm:ss.sss'Z'\".\n" }, { "name": "endTime", "value": "", "type": "query", "description": "The end time of the time range to retrieve the health metrics of a Managed Database\nin UTC in ISO-8601 format, which is \"yyyy-MM-dd'T'hh:mm:ss.sss'Z'\".\n" }, { "name": "filterByHeatWaveStatus", "value": "", "type": "query", "description": "The parameter to filter by HeatWave cluster status." }, { "name": "filterByHeatWaveShape", "value": "", "type": "query", "description": "The parameter to filter by HeatWave node shape." }, { "name": "isHeatWaveLakehouseEnabled", "value": "", "type": "query", "description": "The parameter to filter based on whether HeatWave Lakehouse is enabled for the cluster." } ] }, "docs": "Gets the health metrics for a fleet of HeatWave clusters in a compartment.\nMySQL support within OCI Database Management service has been deprecated as of January 29, 2026.\n" }, { "info": { "name": "Lists Managed MySql Databases.\n", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedMySqlDatabases", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "filterByMySqlDatabaseTypeParam", "value": "", "type": "query", "description": "The parameter to filter by MySQL database type. Allowed values are EXTERNAL or MDS." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort information by. Only one sortOrder can be used. The default sort order\nfor ‘TIMECREATED’ is descending and the default sort order for ‘NAME’ is ascending.\nThe ‘NAME’ sort order is case-sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order." } ] }, "docs": "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" }, { "info": { "name": "Get managed MySql databases General Information", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedMySqlDatabases/:managedMySqlDatabaseId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "managedMySqlDatabaseId", "value": "", "type": "path", "description": "The OCID of the Managed MySQL Database." } ] }, "docs": "Retrieves the general information for a specific MySQL Database.\nMySQL support within OCI Database Management service has been deprecated as of January 29, 2026.\n" }, { "info": { "name": "Changes the management type for a HeatWave MySQL instance, enables or disables Database Management.\n", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedMySqlDatabases/:managedMySqlDatabaseId/actions/changeManagementType", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "managedMySqlDatabaseId", "value": "", "type": "path", "description": "The OCID of the Managed MySQL Database." } ] }, "docs": "Changes the management type for a HeatWave MySQL instance, from BASIC to FULL and vice versa.\nIt can also be used to enable or disable Database Management.\nMySQL support within OCI Database Management service has been deprecated as of January 29, 2026.\n" }, { "info": { "name": "Gets availability metrics of given managed MySql database.\n", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedMySqlDatabases/:managedMySqlDatabaseId/availabilityMetrics", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "managedMySqlDatabaseId", "value": "", "type": "path", "description": "The OCID of the Managed MySQL Database." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "startTime", "value": "", "type": "query", "description": "The start time of the time range to retrieve the health metrics of a Managed Database\nin UTC in ISO-8601 format, which is \"yyyy-MM-dd'T'hh:mm:ss.sss'Z'\".\n" }, { "name": "endTime", "value": "", "type": "query", "description": "The end time of the time range to retrieve the health metrics of a Managed Database\nin UTC in ISO-8601 format, which is \"yyyy-MM-dd'T'hh:mm:ss.sss'Z'\".\n" } ] }, "docs": "Gets the availability metrics for the MySQL Database specified by managedMySqlDatabaseId.\nMySQL support within OCI Database Management service has been deprecated as of January 29, 2026.\n" }, { "info": { "name": "Get information pertaining to the binary log of the managed MySQL server.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedMySqlDatabases/:managedMySqlDatabaseId/binaryLogInformation", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "managedMySqlDatabaseId", "value": "", "type": "path", "description": "The OCID of the Managed MySQL Database." } ] }, "docs": "Retrieves information pertaining to the binary log of a specific MySQL server.\nMySQL support within OCI Database Management service has been deprecated as of January 29, 2026.\n" }, { "info": { "name": "Get managed MySql databases configuration data", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedMySqlDatabases/:managedMySqlDatabaseId/configurationData", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "managedMySqlDatabaseId", "value": "", "type": "path", "description": "The OCID of the Managed MySQL Database." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Descending order is the default order." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort information by. Only one sortOrder can be used. The default sort order\nfor ‘TIMECREATED’ is descending and the default sort order for ‘NAME’ is ascending.\nThe ‘NAME’ sort order is case-sensitive.\n" } ] }, "docs": "Retrieves configuration data for a specific MySQL database.\nMySQL support within OCI Database Management service has been deprecated as of January 29, 2026.\n" }, { "info": { "name": "List the unique set of errors for given digest.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedMySqlDatabases/:managedMySqlDatabaseId/digestErrors", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "managedMySqlDatabaseId", "value": "", "type": "path", "description": "The OCID of the Managed MySQL Database." }, { "name": "digest", "value": "", "type": "query", "description": "The digest of a MySQL normalized query." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort information by. Only one sortOrder can be used.\nThe default sort by field is ‘occurrenceCount’.\nThe default sort order for ‘occurrenceCount’ is descending.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order." } ] }, "docs": "Retrieves any potential errors for a given digest.\nMySQL support within OCI Database Management service has been deprecated as of January 29, 2026.\n" }, { "info": { "name": "Get general information pertaining to the replication of a MySQL server.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedMySqlDatabases/:managedMySqlDatabaseId/generalReplicationInformation", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "managedMySqlDatabaseId", "value": "", "type": "path", "description": "The OCID of the Managed MySQL Database." } ] }, "docs": "Retrieves general information regarding the replication of a specific MySQL server.\nMySQL support within OCI Database Management service has been deprecated as of January 29, 2026.\n" }, { "info": { "name": "List the high availability members of a MySQL server's replication group.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedMySqlDatabases/:managedMySqlDatabaseId/highAvailabilityMembers", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "managedMySqlDatabaseId", "value": "", "type": "path", "description": "The OCID of the Managed MySQL Database." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order." }, { "name": "sortBy", "value": "", "type": "query", "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" } ] }, "docs": "Retrieves information about the high availability members of a specific MySQL server's replication group.\nMySQL support within OCI Database Management service has been deprecated as of January 29, 2026.\n" }, { "info": { "name": "Get the managed MySQL server's source replication status.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedMySqlDatabases/:managedMySqlDatabaseId/inboundReplications", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "managedMySqlDatabaseId", "value": "", "type": "path", "description": "The OCID of the Managed MySQL Database." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order." }, { "name": "sortBy", "value": "", "type": "query", "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" } ] }, "docs": "Retrieves information about the inbound replications of a specific MySQL server.\nMySQL support within OCI Database Management service has been deprecated as of January 29, 2026.\n" }, { "info": { "name": "Get information pertaining to the outbound replications of the managed MySQL server.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedMySqlDatabases/:managedMySqlDatabaseId/outboundReplications", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "managedMySqlDatabaseId", "value": "", "type": "path", "description": "The OCID of the Managed MySQL Database." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order." }, { "name": "sortBy", "value": "", "type": "query", "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" } ] }, "docs": "Retrieves information pertaining to the outbound replications of a specific MySQL server.\nMySQL support within OCI Database Management service has been deprecated as of January 29, 2026.\n" }, { "info": { "name": "Get a Query Sample and Related Data for a Given Digest.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedMySqlDatabases/:managedMySqlDatabaseId/queryDetails", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "managedMySqlDatabaseId", "value": "", "type": "path", "description": "The OCID of the Managed MySQL Database." }, { "name": "digest", "value": "", "type": "query", "description": "The digest of a MySQL normalized query." } ] }, "docs": "Retrieves query sample details, explain plan, and potential warnings for a given digest.\nMySQL support within OCI Database Management service has been deprecated as of January 29, 2026.\n" }, { "info": { "name": "Get ManagedMySqlDatabases SQL Data", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedMySqlDatabases/:managedMySqlDatabaseId/sqlData", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "managedMySqlDatabaseId", "value": "", "type": "path", "description": "The OCID of the Managed MySQL Database." }, { "name": "filterColumn", "value": "", "type": "query", "description": "The parameter to filter results by key criteria which include :\n- AVG_TIMER_WAIT\n- SUM_TIMER_WAIT\n- COUNT_STAR\n- SUM_ERRORS\n- SUM_ROWS_AFFECTED\n- SUM_ROWS_SENT\n- SUM_ROWS_EXAMINED\n- SUM_CREATED_TMP_TABLES\n- SUM_NO_INDEX_USED\n- SUM_NO_GOOD_INDEX_USED\n- FIRST_SEEN\n- LAST_SEEN\n- HEATWAVE_OFFLOADED\n- HEATWAVE_OUT_OF_MEMORY\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "startTime", "value": "", "type": "query", "description": "The start time of the time range to retrieve the health metrics of a Managed Database\nin UTC in ISO-8601 format, which is \"yyyy-MM-dd'T'hh:mm:ss.sss'Z'\".\n" }, { "name": "endTime", "value": "", "type": "query", "description": "The end time of the time range to retrieve the health metrics of a Managed Database\nin UTC in ISO-8601 format, which is \"yyyy-MM-dd'T'hh:mm:ss.sss'Z'\".\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort information by. Only one sortOrder can be used. The default sort order\nfor ‘TIMECREATED’ is descending and the default sort order for ‘NAME’ is ascending.\nThe ‘NAME’ sort order is case-sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order." } ] }, "docs": "Retrieves the SQL performance data for a specific MySQL database.\nMySQL support within OCI Database Management service has been deprecated as of January 29, 2026.\n" }, { "info": { "name": "Gets the health metrics for a fleet of MySQL databases.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/mysqlFleetMetrics", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "filterByMetricNames", "value": "", "type": "query", "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." }, { "name": "startTime", "value": "", "type": "query", "description": "The start time of the time range to retrieve the health metrics of a Managed Database\nin UTC in ISO-8601 format, which is \"yyyy-MM-dd'T'hh:mm:ss.sss'Z'\".\n" }, { "name": "endTime", "value": "", "type": "query", "description": "The end time of the time range to retrieve the health metrics of a Managed Database\nin UTC in ISO-8601 format, which is \"yyyy-MM-dd'T'hh:mm:ss.sss'Z'\".\n" }, { "name": "filterByMySqlDeploymentTypeParam", "value": "", "type": "query", "description": "The parameter to filter by MySQL deployment type." }, { "name": "filterByMdsDeploymentType", "value": "", "type": "query", "description": "The parameter to filter by MySQL Database System type." }, { "name": "filterByMySqlDatabaseTypeParam", "value": "", "type": "query", "description": "The parameter to filter by MySQL database type. Allowed values are EXTERNAL or MDS." }, { "name": "filterByMySqlStatus", "value": "", "type": "query", "description": "The parameter to filter by MySQL Database status." }, { "name": "filterByMySqlDatabaseVersion", "value": "", "type": "query", "description": "The parameter to filter by MySQL database version." }, { "name": "isHeatWaveEnabled", "value": "", "type": "query", "description": "The parameter to filter based on whether HeatWave is enabled for the database." } ] }, "docs": "Gets the health metrics for a fleet of MySQL Databases in a compartment.\nMySQL support within OCI Database Management service has been deprecated as of January 29, 2026.\n" } ] } ], "bundled": true }