Viewing DB System Details

View the DB system details page to see information about the DB system and the resources associated with it.

Using the Console
Using the CLI
Using the REST API, run the GetDbSystem operation.

Using the Console

Use the Console to view the details of a DB system.

Open the navigation menu and select Databases. Under HeatWave MySQL, click DB systems.
Choose your compartment from the List scope.
In the list of DB systems, click the name of the DB system to open the DB system details page.

You can see the following details of the DB system:

DB System Details

Use the DB system details page to see information about the DB system and the resources associated with it.

Table 8-3 DB System Details page

Name	Description
DB system information	Summary information about this DB system and its configuration. See DB System Information.
Connections	Details about networking, endpoint, and security certificate. See Connections.
Tools	Details of Database Management and Ops Insights settings of this DB system. See Tools.
Tags	Details about the tags present on this DB system. See Managing Tags.
Resources	Metrics: Measurements such as the number of connections to this DB system, and its CPU and memory utilization. See Resource: Metrics. Endpoints: Details of the endpoint for MySQL clients and connectors to access this DB system, and its availability status. See Resource: Endpoints. Read replicas: Details of read replicas of the DB system. See Resource: Read Replicas. Backups: The backup plan for this DB system and a list of the backups already made for it. See Resource: Backups. Channels: The replication channels that are configured for this DB system. See Resource: Channels. Work requests: Activity logs for ongoing and recent operations on the DB system. Work requests are retained for 12 hours. See Resource: Work Requests.

Menu Items

Use the menu items at the top of the DB system details page to view related information or perform an action.

Table 8-4 Menu item

Menu item	Description
Performance Hub	Open the Performance Hub details page
HeatWave cluster details or Add HeatWave cluster	If HeatWave cluster is enabled, open the HeatWave cluster details page. If HeatWave cluster is disabled, open the Add HeatWave cluster page.
Lifecycle	Allow you to change the lifecycle of the DB system: Start: Start the DB system. Stop: Stop the DB system. Restart: Restart the DB system. Delete: Delete the DB system.
Create manual backup
More actions	Allow you to perform one of the following actions: Restore to a new DB system: Restore a backup to a new DB system. Create channel: Create a replication channel for this DB system. Administrator password: Change the administrator password of this DB system. Audit: View the audit logs related to this DB system. Add tags: Add one or more tags to this DB system.

DB System Information

Use the DB system information section of the DB system details page to see an overview of the DB system's configuration and resources.

Table 8-5 DB system Information

Field	Description
General information	OCID: The unique identifier of the DB system. Description: A user-defined description of the DB system. Compartment: The name of the compartment in which the DB system is created. To see the OCID of the compartment, click the compartment name. Created: The date and time the DB system was created. Last updated: The date and time the DB system was last updated. Database version: The version of MySQL contained by the DB system. Click Edit to change the MySQL version. See MySQL Server Versions. Access mode: Displays the access mode, whether it is all users or administrators only. Database mode: Displays the database mode whether it is read-write or read-only. Crash recovery: Displays whether crash recovery is enabled or disabled. See Crash Recovery. Customer contacts: Displays whether any customer contact is configured. None or Configured.
Resource allocation	Shape: The resource template applied to the DB system. See Supported Shapes. ECPU count or OCPU count: The number of ECPUs or OCPUs allocated to the DB system. For Highly Available systems, this also provides a breakdown of ECPUs or OCPUs used per instance. Memory: The amount of RAM allocated to the DB system. For Highly Available systems, this also provides a breakdown of RAM allocated per instance. Configuration: The name of the HeatWaave configuration used in the DB system and a link to that configuration's details page. Storage size: (Is shown when automatic storage expansion is disabled) The amount of storage available to the DB system. For Highly Available systems, this also provides a breakdown of storage allocated per instance. Click Edit to open the Update storage size dialog box. See Increasing the Storage of a DB System. Allocated storage size: (Is shown when automatic storage expansion is enabled) The amount of storage currently allocated to the DB system. For Highly Available systems, this also provides a breakdown of storage size allocated to each instance. Automatic storage expansion: Displays automatic storage expansion status. Enabled or Disabled. Click Edit to open the Update storage size dialog box. See Enabling or Disabling Automatic Storage Expansion. Maximum storage size: (Is shown when automatic storage expansion is enabled) The maximum amount of storage that can be allocated to the DB system . For Highly Available systems, this also provides a breakdown of the maximum storage size that can be allocated to each instance.
Maintenance	Maintenance window start: The time at which the maintenance window starts. Required maintenance of the DB system, such as Operating System or MySQL Server patching or maintenance, is performed during a window which starts at this time. See Maintenance.
Encrypt	Encryption key: Displays the type of encryption key used by the DB system. Select Edit to update the encryption key.
HeatWave cluster	HeatWave cluster: Displays HeatWave cluster status for this DB system. Enabled or Disabled. If the DB system is using the correct shape, an active link to Enable HeatWave Cluster is also displayed. This opens the Add HeatWave cluster dialog. See Adding a HeatWave Cluster. State: (Is shown when HeatWave cluster is enabled) Displays the current state of the HeatWave cluster; Active or Inactive. See HeatWave Cluster States.
High availability	High availability: Displays the high availability status for this DB system. Enabled or Disabled. See High Availability. The followings are shown when high availability is enabled: High availability type: One of the following: Multi-AD: The MySQL instances are placed in different availability domains. Multi-FD: The MySQL instances are placed in different fault domains in a single availability domain. Preferred availability domain: (Is shown when high availability is enabled) The selected location of the primary instance. If a failover has occurred, and the MySQL instances are in different availability domains, a message is displayed here, stating that the current primary is not in the preferred location. Preferred fault domain: (Is shown when high availability is enabled) The selected location of the primary instance. If a failover has occurred, and the MySQL instances are in different fault domains, a message is displayed here, stating that the current primary is not in the preferred location.
Backup plan	Automatic backups: Displays automatic backup status. Enabled or Disabled. Click Edit to update the backup plan. The followings are shown when automatic backup is enabled: Backup window: Displays the time at which the automatic backup window starts. Retention days: Displays the number of days the automatic backups are retained. Point-in-time recovery: Displays whether point-in-time recovery is enabled or disabled. See Point-In-Time Recovery. Soft delete: Displays whether soft delete is enabled or disabled. Cross-region copy: Displays whether cross-region copy is enabled or disabled.
Deletion plan	Delete protected: Displays whether delete protection is enabled or disabled on your DB system. Click Edit to update the deletion plan. See Deleting a DB System. Automatic backup retention: Displays whether the automatic backups are retained or deleted after you delete your DB system. By default, automatic backups are deleted when you delete the DB system. Final backup: Displays whether a final backup is created or skipped before deleting the DB system. By default, the final backup is skipped, that is, not created.

Connections

Use the Connections section of the DB system details page to see the details of networking, endpoints and security certificate.

Table 8-6 Connections

Field	Description
Networking	Virtual cloud network: The network on which the DB system was created. Subnet: The subnet to which the DB system is attached. Subnet type: The type of subnet. Regional or AD-specific. Availability domain: The availability domain the DB system is in. See Regions and Availability Domains. Fault domain: The fault domain within the availability domain. See Fault Domains. Network security groups: The list of network security groups which the DB system belongs to.
Security certificate	The details you see depends on the settings in Advanced Option: Connections: If you have let HeatWave Service define the security certificate: Security certificate: Service defined If you have used BYOC and selected a security certificate: Name: The name of the security certificate. Description: The description of the security certificate. State: The state of the security certificate. Compartment: The compartment where the security certificate is present. Configuration type: The type of the configuration, such as `IMPORTED`, or `ISSUED_INTERNAL_CA`. Created: The date and time the security certificate was created. If you have used BYOC and entered the OCID of the security certificate: Security certificate: Bring your own certificate (BYOC) OCID: The OCID of the security certificate.
REST	Configuration: Display REST status. Enabled or Disabled. Click Edit to open the Update REST dialog box. See Updating REST. REST endpoints port: (Is shown when REST is enabled) The port on which REST endpoints are created.
Primary endpoint	Private IP address: The IP address of the primary endpoint of the DB system. This address is not accessible from the internet. Internal FQDN: The Fully Qualified Domain Name of the primary endpoint of the DB system. This value is populated only if you defined a hostname. Database port: The port on which the primary endpoint listens for incoming connections. Database X protocol port: The port on which the primary endpoint listens for clients using the MySQL X Protocol, such as MySQL Shell.
Read endpoint	Read endpoint: Display read endpoint status. Enabled or Disabled. Click Edit to open the Update read endpoint dialog box. See Updating the Read Endpoint of a DB System. The followings are shown when read endpoint is enabled: Private IP address: (Is shown when read endpoint is enabled) The IP address of the read endpoint. This address is not accessible from the internet. Click Edit to open the Update read endpoint dialog box. Internal FQDN: (Is shown when read endpoint is enabled) The Fully Qualified Domain Name of the read endpoint. This value is populated only if you defined a hostname. Click Edit to open the Update read endpoint dialog box. Database port: The port on which the read endpoint listens for incoming connections. Database X protocol port: The port on which the read endpoint listens for clients using the MySQL X Protocol, such as MySQL Shell. Excluded IPs: (Is shown when read endpoint is enabled) A list of IP addresses to be excluded as backends to which connections are forwarded. Click Edit to open the Update read endpoint dialog box.

Tools

Use the Tools section of the DB system details page to see the details of Database Management and Ops Insights.

Table 8-7 Tools

Field	Description
Database Management	Database Management: Displays the status of Database Management. Enabled or Disabled. See Database Management. Performance Hub: Displays the status of Performance Hub. Enabled or Disabled.
Ops Insights	Ops Insights: Displays the status of Ops Insights. Enabled or Disabled. Capacity Planning: The description of the security certificate. SQL insights: The state of the security certificate.

Resource: Metrics

The Metrics resource on the DB system details page shows measurements of resource utilization in the DB system, such as its CPU and memory utilization and disk activity.

Table 8-8 DB System Metrics

Field	Description
Start time	Specify the start time for metric display.
End time	Specify the end time for metric display.
Quick selects	Select a predefined range.
Metrics data	Displayed only for DB systems with HeatWave clusters attached. Filters the metric data. The following selections are possible: All: Display DB system and HeatWave cluster metrics data. DB system: Display DB system metric data only. HeatWave cluster: Display HeatWave cluster metric data, only. Backup: Display backup metric data only. Channel: Display channel metric data only. Read replica: Display read replica metric data only.
Aggregated metrics data	Displays the aggregated metric data for the HeatWave cluster attached to the DB system. Disabled: the data is displayed for each of the cluster's nodes. The relevant metric graphs display a line for each node. Enabled: the node data is aggregated and displayed as a single line.
Metric graphs	For more information on metrics, see Metrics.

Resource: Endpoints

The Endpoints resource on the DB system details page shows the details and current state of the DB system's read/write endpoint, which clients and connectors can use to connect to the MySQL instance.

Table 8-9 Endpoints Overview

Field	Description
Endpoint	The name of the endpoint.
State	Current state: CREATING: Resources are being reserved, the system is booting, and the initial database is being created. Creating can take several minutes. The system is not ready to use yet. ACTIVE: The resource was successfully created. UPDATING: The resource is in the process of starting, stopping, or restarting. INACTIVE: The resource is powered off. DELETING: The DB system is being deleted. DELETED: The DB system has been deleted and is no longer available. FAILED: An error condition prevented the creation or continued operation of the DB system.
Modes	One of the following values: READ, WRITE READ
Type	The type of the endpoint: Primary DB system Read replica Load balancer Read endpoint
Internal FQDN	The internal FQDN of the endpoint. If you did not define a hostname, this field is left blank.
Address	The IP address of the endpoint.
Database port	The classic MySQL protocol port of the endpoint. Default is 3306.
Database X protocol port	The MySQL X Protocol port of the endpoint.

Resource: Read Replicas

The Read replicas resource on the DB system details page shows the details and current state of the read replicas present on the DB system.

Table 8-10 Read Replicas Overview

Field	Description
Name	The name of the read replica.
State	Current state: CREATING: Resources are being reserved, the read replica is booting. Creating can take several minutes. ACTIVE: The read replica was successfully created. UPDATING: The resource is in the process of starting, stopping, or restarting. NEEDS_ATTENTION: The read replica has failed beyond recovery and does not replicate from the DB system anymore. Delete the read replica and create a new one. DELETING: The read replica is being deleted. DELETED: The read replica has been deleted and is no longer available. FAILED: An error condition prevented the creation or continued operation of the read replica.
DB system	The DB system name of the read replica.
Address	The IP address of the read replica.
Created	The date and time the read replica was created.
Last updated	The date and time the read replica was last updated.

Resource: Backups

The Backups resource on the DB system details page shows the details of the backup plan and the DB system deletion plan of the DB system, and lists all backups of the DB system.

Table 8-11 Backups

Field	Description
Create Manual Backup	Opens the Create manual backup dialog box.
Name	The name of the backup.
State	The state of the backup.
DB system	The DB system name of the backup.
Size	The size of the backup.
Created	The date the backup was created.
Soft delete	The soft delete setting of the backup.
Retention Days	Retention period of the backup.
Creation type	The type of the backup.
Actions (three dot) menu	The Actions (three dot) menu contains the following: View details: Open the Backup details page. For more information, see Backup Details Restore to new DB system: Open the Restore to a new DB system page. For more information, see Restoring From a Backup. Copy OCID: Copy the backup OCID to the clipboard. Delete: Open the Delete backup dialog box. Follow the prompts to delete the backup. Cancel deletion: Open the Cancel deletion dialog box. Follow the prompts to cancel the scheduled deletion of the backup.

Resource: Channels

The Channels resource on the DB system details page shows the replication channels that are configured for this DB system, and their current status.

Table 8-12 Channels Overview

Field	Description
Name	The display name of the channel.
Source	The IP address or hostname of the MySQL Source.
Target	The name of the target DB system.
State	Current state: CREATING: The Channel is being created. Provisioning can take several minutes. The channel is not yet replicating data from the source to the target. ACTIVE: The Channel was successfully enabled. UPDATING: A Channel operation is ongoing. NEEDS_ATTENTION: This status is displayed for the following reasons: The Channel is not replicating due to an error. The Details column on the Channels page lists why the channel needs attention. The target DB system is INACTIVE. This can also occur if the channel was created or updated while the DB system was in INACTIVE state. Pending actions are applied if the DB system is started. INACTIVE: The Channel is not replicating because the user disabled it. DELETING: The Channel is being deleted. DELETED: The Channel has been deleted and is no longer available.
Details	Information or errors relating to the current state of the channel.
Enabled	Whether the channel is enabled.
Created	Date and time the channel was created.
Actions menu	The actions (three dot) menu contains the following: View channel details: Opens the Channel details page. For more information, see Channel Details. Disable/Enable: Click Disable to disable the replication channel. Click Enable to enable the replication channel. For more information, see Enabling or Disabling a Channel. Reset: Resets the channel, removing all channel metadata. For more information, see Resetting a Channel. Resume: Resumes the channel in the event of an error. For more information, see Resuming a Channel. Copy OCID: Copies the OCID of the Channel to the clipboard. View tags: Opens the View tags dialog, displaying all tags defined on this channel. Add tags: Opens the Add tags dialog, enabling you to define tags for the channel. Delete: Opens the Delete channel dialog. Follow the prompts to delete the channel.

Resource: Work Requests

The Work requests resource on the DB system details page lists the activity logs for ongoing and recent operations on the DB system. Work requests are retained for 12 hours.

Table 8-13 Work Requests

Field	Description
Operation	One of the following operation names: CREATE_DBSYSTEM UPDATE_DBSYSTEM DELETE_DBSYSTEM START_DBSYSTEM STOP_DBSYSTEM RESTART_DBSYSTEM ADD_HEATWAVE_CLUSTER UPDATE_HEATWAVE_CLUSTER DELETE_HEATWAVE_CLUSTER START_HEATWAVE_CLUSTER STOP_HEATWAVE_CLUSTER RESTART_HEATWAVE_CLUSTER GENERATE_HEATWAVE_CLUSTER_MEMORY_ESTIMATE CREATE_REPLICA UPDATE_REPLICA DELETE_REPLICA For more information on Work Requests, see Work Request Overview.
State	Current state: ACCEPTED: The request is in the work request queue to be processed. IN_PROGRESS: A work request record exists for the specified request, but there is no associated WORK_COMPLETED record. SUCCEEDED: A work request record exists for this request and an associated WORK_COMPLETED record has the state SUCCEEDED. FAILED: A work request record exists for this request and an associated WORK_COMPLETED record has the state FAILED. CANCELING: The work request is in the process of canceling. CANCELED: The work request has been canceled.
% complete	The percentage completion.
Accepted	Date and time the operation was accepted.
Started	Date and time the operation started.
Finished	Date and time the operation finished.
Action menu (3 dots)	Opens the Action menu. The following actions are possible: View work request: opens the Work request details page. Copy OCID: Copy the OCID of the work request to the clipboard.

Using the CLI

Use the command-line interface to view the details of 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.

Open a command prompt and run the following command:

oci mysql db-system get --db-system-id <DBSystemOCID>

If the oci mysql db-system get command validates and runs successfully, you get a response similar to the following, which retreives the DB system details:

{
  "data": {
    "availability-domain": "UK-CARDIFF-1-AD-1",
    "backup-policy": {
      "copy-policies" : [
        {
          "backup-copy-retention-in-days" : 7,
          "copy-to-region" : "eu-frankfurt-1"             
        }
      ],
      "is-enabled": true,
      "pitr-policy": {    
        "is-enabled": true
      },
      "retention-in-days": 7,
      "window-start-time": "00:10",
    },
    "channels": [],
    "compartment-id": "ocid1.compartment.oc1..<ID>",
    "configuration-id": "ocid1.mysqlconfiguration.oc1..<ID>",
    "crash-recovery": "ENABLED",
    "current-placement": {
      "availability-domain": "UK-CARDIFF-1-AD-1",
      "fault-domain": "FAULT-DOMAIN-1"
    },
    "data-storage-size-in-gbs": 1024,
    "defined-tags": {
      "Oracle-Tags": {
        "CreatedBy": "<Username>",
        "CreatedOn": "2023-04-18T07:00:48.996Z"
      }
    },
    "deletion-policy": {
      "automatic-backup-retention": "RETAIN",
      "final-backup": "REQUIRE_FINAL_BACKUP",
      "is-delete-protected": true
    },
    "description": null,
    "display-name": "mysql20230418075107",
    "endpoints": [
      {
        "hostname": null,
        "ip-address": "10.0.1.99",
        "modes": [
          "READ",
          "WRITE"
        ],
        "port": 3306,
        "port-x": 33060,
        "resource-id": "ocid1.mysqlinstance.oc1.<ID>",
        "resource-type": "DBSYSTEM",
        "status": "ACTIVE",
        "status-details": null
      }
    ],
    "fault-domain": "FAULT-DOMAIN-1",
    "freeform-tags": {
      "Template": "Production"
    },
    "heat-wave-cluster": null,
    "hostname-label": null,
    "id": "ocid1.mysqldbsystem.oc1.uk-cardiff-1.<ID>",
    "ip-address": "10.0.1.99",
    "is-heat-wave-cluster-attached": false,
    "is-highly-available": false,
    "lifecycle-details": null,
    "lifecycle-state": "UPDATING",
    "maintenance": {
      "window-start-time": "THURSDAY 05:50"
    },
    "mysql-version": "8.0.32",
    "point-in-time-recovery-details": null,
    "port": 3306,
    "port-x": 33060,
    "shape-name": "MySQL.VM.Standard.E4.4.64GB",
    "source": null,
    "subnet-id": "ocid1.subnet.oc1.uk-cardiff-1.<ID>",
    "time-created": "2023-04-18T07:00:50.576000+00:00",
    "time-updated": "2023-04-18T07:46:27.778000+00:00"
  },
  "etag": "qw1212cee7aff69c2880adc9c432f9eda03f978320e6719c4006c89--gzip"
}

Related Topics

Oracle Cloud Infrastructure Documentation