{ "opencollection": "1.0.0", "info": { "name": "MySQL Database Service Db System API", "version": "20190415" }, "items": [ { "info": { "name": "dbSystem", "type": "folder" }, "items": [ { "info": { "name": "List DB Systems.", "type": "http" }, "http": { "method": "GET", "url": "http://mysql.{region}.ocp.oraclecloud.com/20190415/dbSystems", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "isHeatWaveClusterAttached", "value": "", "type": "query", "description": "If true, return only DB Systems with a HeatWave cluster attached, if false\nreturn only DB Systems with no HeatWave cluster attached. If not\npresent, return all DB Systems.\n" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The compartment [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "dbSystemId", "value": "", "type": "query", "description": "The DB System [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only the resource matching the given display name exactly." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "DbSystem Lifecycle State" }, { "name": "configurationId", "value": "", "type": "query", "description": "The requested Configuration instance." }, { "name": "isUpToDate", "value": "", "type": "query", "description": "Filter instances if they are using the latest revision of the\nConfiguration they are associated with.\n" }, { "name": "databaseManagement", "value": "", "type": "query", "description": "Filter DB Systems by their Database Management configuration.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Time fields are default ordered as descending. Display name is default ordered as ascending.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use (ASC or DESC)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated list call. For information about pagination, see\n[List Pagination](../../../#API/Concepts/usingapi.htm#List_Pagination).\n" }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` or `opc-prev-page` response header from\nthe previous list call. For information about pagination, see [List\nPagination](../../../#API/Concepts/usingapi.htm#List_Pagination).\n" } ] }, "docs": "Get a list of DB Systems in the specified compartment.\nThe default sort order is by timeUpdated, descending.\n" }, { "info": { "name": "Create and launch a DB System.", "type": "http" }, "http": { "method": "POST", "url": "http://mysql.{region}.ocp.oraclecloud.com/20190415/dbSystems", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates and launches a DB System.\n" }, { "info": { "name": "Get a DB System.", "type": "http" }, "http": { "method": "GET", "url": "http://mysql.{region}.ocp.oraclecloud.com/20190415/dbSystems/:dbSystemId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-none-match", "value": "" } ], "params": [ { "name": "dbSystemId", "value": "", "type": "path", "description": "The DB System [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Get information about the specified DB System." }, { "info": { "name": "Update a DB System.", "type": "http" }, "http": { "method": "PUT", "url": "http://mysql.{region}.ocp.oraclecloud.com/20190415/dbSystems/:dbSystemId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "dbSystemId", "value": "", "type": "path", "description": "The DB System [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the configuration of a DB System.\n\nUpdating different fields in the DB System will have different results\non the uptime of the DB System. For example, changing the displayName of\na DB System will take effect immediately, but changing the shape of a\nDB System is an asynchronous operation that involves provisioning new\nCompute resources, pausing the DB System and migrating storage\nbefore making the DB System available again.\n" }, { "info": { "name": "Delete a DB System.", "type": "http" }, "http": { "method": "DELETE", "url": "http://mysql.{region}.ocp.oraclecloud.com/20190415/dbSystems/:dbSystemId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "dbSystemId", "value": "", "type": "path", "description": "The DB System [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Delete a DB System, including terminating, detaching,\nremoving, finalizing and otherwise deleting all related resources.\n" }, { "info": { "name": "Update the selected MySQL instance types.", "type": "http" }, "http": { "method": "POST", "url": "http://mysql.{region}.ocp.oraclecloud.com/20190415/dbSystems/:dbSystemId/actions/controlledUpdate", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "dbSystemId", "value": "", "type": "path", "description": "The DB System [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the chosen subset of MySQL instances based on their role.\n" }, { "info": { "name": "Generate DB System status.", "type": "http" }, "http": { "method": "POST", "url": "http://mysql.{region}.ocp.oraclecloud.com/20190415/dbSystems/:dbSystemId/actions/generateDbSystemStatus", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "dbSystemId", "value": "", "type": "path", "description": "The DB System [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Initiates an asynchronous request to collect the current status of the specified DB System, \nincluding the status of any attached Channels (if requested).\n" }, { "info": { "name": "Restarts a DB System.", "type": "http" }, "http": { "method": "POST", "url": "http://mysql.{region}.ocp.oraclecloud.com/20190415/dbSystems/:dbSystemId/actions/restart", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "dbSystemId", "value": "", "type": "path", "description": "The DB System [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Restarts the specified DB System." }, { "info": { "name": "Starts a DB System.", "type": "http" }, "http": { "method": "POST", "url": "http://mysql.{region}.ocp.oraclecloud.com/20190415/dbSystems/:dbSystemId/actions/start", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "dbSystemId", "value": "", "type": "path", "description": "The DB System [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Start the specified DB System." }, { "info": { "name": "Stops a DB System.", "type": "http" }, "http": { "method": "POST", "url": "http://mysql.{region}.ocp.oraclecloud.com/20190415/dbSystems/:dbSystemId/actions/stop", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "dbSystemId", "value": "", "type": "path", "description": "The DB System [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Stops the specified DB System.\n\nA stopped DB System is not billed.\n" }, { "info": { "name": "Get DB System status.", "type": "http" }, "http": { "method": "GET", "url": "http://mysql.{region}.ocp.oraclecloud.com/20190415/dbSystems/:dbSystemId/dbSystemStatus", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "dbSystemId", "value": "", "type": "path", "description": "The DB System [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Returns the most up-to-date status of the specified DB System, \nincluding the status of any requested Channels.\n" }, { "info": { "name": "Get HeatWave cluster details.", "type": "http" }, "http": { "method": "GET", "url": "http://mysql.{region}.ocp.oraclecloud.com/20190415/dbSystems/:dbSystemId/heatWaveCluster", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-none-match", "value": "" } ], "params": [ { "name": "dbSystemId", "value": "", "type": "path", "description": "The DB System [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Gets information about the HeatWave cluster." }, { "info": { "name": "Update HeatWave cluster.", "type": "http" }, "http": { "method": "PUT", "url": "http://mysql.{region}.ocp.oraclecloud.com/20190415/dbSystems/:dbSystemId/heatWaveCluster", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "dbSystemId", "value": "", "type": "path", "description": "The DB System [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the HeatWave cluster.\n" }, { "info": { "name": "Delete HeatWave cluster.", "type": "http" }, "http": { "method": "DELETE", "url": "http://mysql.{region}.ocp.oraclecloud.com/20190415/dbSystems/:dbSystemId/heatWaveCluster", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "dbSystemId", "value": "", "type": "path", "description": "The DB System [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Deletes the HeatWave cluster including terminating, detaching, removing, finalizing and\notherwise deleting all related resources.\n" }, { "info": { "name": "Add HeatWave cluster.", "type": "http" }, "http": { "method": "POST", "url": "http://mysql.{region}.ocp.oraclecloud.com/20190415/dbSystems/:dbSystemId/heatWaveCluster/actions/add", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "dbSystemId", "value": "", "type": "path", "description": "The DB System [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a HeatWave cluster to the DB System.\n" }, { "info": { "name": "Restart HeatWave cluster.", "type": "http" }, "http": { "method": "POST", "url": "http://mysql.{region}.ocp.oraclecloud.com/20190415/dbSystems/:dbSystemId/heatWaveCluster/actions/restart", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "dbSystemId", "value": "", "type": "path", "description": "The DB System [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Restarts the HeatWave cluster." }, { "info": { "name": "Start HeatWave cluster.", "type": "http" }, "http": { "method": "POST", "url": "http://mysql.{region}.ocp.oraclecloud.com/20190415/dbSystems/:dbSystemId/heatWaveCluster/actions/start", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "dbSystemId", "value": "", "type": "path", "description": "The DB System [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Starts the HeatWave cluster." }, { "info": { "name": "Stop HeatWave cluster.", "type": "http" }, "http": { "method": "POST", "url": "http://mysql.{region}.ocp.oraclecloud.com/20190415/dbSystems/:dbSystemId/heatWaveCluster/actions/stop", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "dbSystemId", "value": "", "type": "path", "description": "The DB System [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Stops the HeatWave cluster." }, { "info": { "name": "Get HeatWave cluster memory estimate.", "type": "http" }, "http": { "method": "GET", "url": "http://mysql.{region}.ocp.oraclecloud.com/20190415/dbSystems/:dbSystemId/heatWaveClusterMemoryEstimate", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "dbSystemId", "value": "", "type": "path", "description": "The DB System [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Gets the most recent HeatWave cluster memory estimate that can be used to determine a suitable\nHeatWave cluster size.\n" }, { "info": { "name": "Generate HeatWave cluster memory estimate.", "type": "http" }, "http": { "method": "POST", "url": "http://mysql.{region}.ocp.oraclecloud.com/20190415/dbSystems/:dbSystemId/heatWaveClusterMemoryEstimate/actions/generate", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "dbSystemId", "value": "", "type": "path", "description": "The DB System [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Sends a request to estimate the memory footprints of user tables when loaded to HeatWave cluster memory.\n" }, { "info": { "name": "List maintenance events.", "type": "http" }, "http": { "method": "GET", "url": "http://mysql.{region}.ocp.oraclecloud.com/20190415/dbSystems/:dbSystemId/maintenanceEvents", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "dbSystemId", "value": "", "type": "path", "description": "The DB System [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "mysqlVersionBeforeMaintenance", "value": "", "type": "query", "description": "The MySQL version before the maintenance event." }, { "name": "mysqlVersionAfterMaintenance", "value": "", "type": "query", "description": "The MySQL version after the maintenance event." }, { "name": "maintenanceType", "value": "", "type": "query", "description": "How the maintenance event was triggered." }, { "name": "maintenanceAction", "value": "", "type": "query", "description": "The nature of the maintenance event." }, { "name": "maintenanceStatus", "value": "", "type": "query", "description": "The last status of the maintenance event." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated list call. For information about pagination, see\n[List Pagination](../../../#API/Concepts/usingapi.htm#List_Pagination).\n" }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` or `opc-prev-page` response header from\nthe previous list call. For information about pagination, see [List\nPagination](../../../#API/Concepts/usingapi.htm#List_Pagination).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided.\nTime fields are default ordered as descending.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use (ASC or DESC)." } ] }, "docs": "List all the maintenance events." } ] } ], "bundled": true }