Oracle Cloud Infrastructure Documentation

Updating REST

You can update the REST setting of a DB system.

Use one of the following methods to update the REST setting of a DB system:

Using the Console

Use the Console to update REST setting of the DB system.

This task requires the following
  • A running standalone DB system with high availability disabled.
  • The DB system has a version of 9.3.1 or higher.
  • The DB system database mode is read-write.
  • The DB system access mode is all users.
Do the following to update the REST setting of the DB system.
  1. On the DB systems list page, select the DB system that you want to work with. If you need help finding the list page or the DB system, see Listing DB Systems - Using the Console.

    The details page opens and displays information about the DB system.

  2. Select the Connections tab.
  3. Select Edit in the Configuration field under the REST section.
  4. To enable REST, do the following:
    • Configuration: Select to toggle REST configuration to Enabled. The following field is shown when REST is enabled.
      • REST port: (Optional) Specify a port number to assign to REST endpoints. Supported port numbers are 443 and from 1024 to 65535. If you do not specify a port number, the default port 443 is used.
        Note

        The port number must be different from the database port and database X protocol port.
  5. To disable REST, do the following:
    • Configuration: Select to toggle REST configuration to Disabled. No other field is shown when REST is disabled.
  6. Select Update.

Using the CLI

Use the command-line interface to update REST settings for a DB system.

This task requires the following:
  • A DB system Oracle Cloud Identifier (OCID).
  • A properly configured CLI installation and the requisite SSH keys. See Command Line Interface.
  1. Open a command prompt and run the following command:
    oci mysql db-system update --db-system-id <DBSystemOCID> --rest file://<RESTDetailsFile>
    • db-system-id: Specify the OCID of the DB system.
    • rest: Specify a JSON file containing the REST settings. To generate a sample JSON file, run oci mysql db-system update --generate-param-json-input rest.
  2. In the REST details file, specify valid values for the REST configuration and port.
The command updates the DB system and returns the work request information.