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.
DB System Details
Use the tabs on the DB system details page to see information about the DB system and the resources associated with it.
Table 8-2 DB System Details page
| Tab Name | Description |
|---|---|
| Details | 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. |
| Maintenance | Details about database maintenance. See Maintenance. |
| Endpoints | Details of the endpoint for MySQL clients and connectors to access this DB system, and its availability status. See Endpoints. |
| Read replicas | Details of read replicas of the DB system. See Read Replicas. |
| Backups | The backup plan for this DB system and a list of the backups already made for it. See Backups. |
| Channels | The replication channels that are configured for this DB system. See Channels. |
| Telemetry | Displays the Log Analytics configurations. See Telemetry. |
| Security | Details about security attributes. See Security. |
| Monitoring | Measurements such as the number of connections to this DB system, and its CPU and memory utilization. See Monitoring. |
| Work requests | Activity logs for ongoing and recent operations on the DB system. Work requests are retained for 12 hours. See Work Requests. |
| Tags | Details about the tags present on this DB system. See Tags. |
Menu Items
Use the menu items described below to view related information or perform an action.
Create manual backup
Create a manual backup of the DB system. See Creating a Manual Backup.
Actions menu
View related information or perform an action.
Table 8-3 Actions menu items
| 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:
|
| 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. |
Details
Use the Details tab of the DB system details page to see an overview of the DB system's configuration and resources.
Table 8-4 Details
| Field | Description |
|---|---|
| DB system information |
|
| Resource allocation |
|
| Encrypt |
|
| HeatWave cluster |
|
| High availability |
|
| DB system status |
|
| Disaster recovery |
|
| Delete protection | Delete protected: Displays whether delete protection is enabled or disabled on your DB system. Select Edit to update the deletion plan. See Deleting a DB System. |
Connections
Use the Connections section of the DB system details page to see the details of networking, endpoints and security certificate.
Table 8-5 Connections
| Field | Description |
|---|---|
| Networking |
|
| Security certificate | The details you see depends on the settings in Advanced Option: Connections:
|
| REST |
|
| Primary endpoint |
|
| Read endpoint |
|
Tools
Use the Tools section of the DB system details page to see the details of Database Management and Ops Insights.
Table 8-6 Tools
| Field | Description |
|---|---|
| MySQL Studio |
Note
The MySQL Studio endpoint is not directly accessible from the internet. To access MySQL Studio endpoint, you need to use a networking service such as a VPN connection or network load balancer. To learn how to change application settings or connect to the application, see Enabling or Disabling MySQL Studio. |
| Database Management |
|
| Ops Insights |
|
Maintenance
Use the Maintenance tab of the DB system details page to view and edit DB system maintenace settings.
Table 8-7 Maintenance
| Field | Description |
|---|---|
| Maintenance window start |
Select Edit to change the maintenance window settings. See Configuring DB System Maintenance. |
| Maintenance-disabled window |
Select Edit to change the maintenance-disabled window settings. See Configuring DB System Maintenance. |
| DB system information | Database version: The current database version. Select Edit to change the MySQL version. See Configuring DB System Maintenance. |
| Maintenance events | Displays the status and details of the automatic monthly scheduled maintenance, manual MySQL version upgrade, and shape change related maintenance. |
Endpoints
The Endpoints tab 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-8 Endpoints Overview
| Field | Description |
|---|---|
| Endpoint | The name of the endpoint. |
| State | Current state:
|
| Modes | One of the following values:
|
| Type | The type of the 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. |
Read Replicas
The Read replicas tab shows the details and current state of the read replicas present on the DB system.
Table 8-9 Read Replicas Overview
| Field | Description |
|---|---|
| Name | The name of the read replica. |
| State | Current state:
|
| 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. |
Backups
The Backups tab shows the details of the backup plan, deletion plan of the DB system, and lists all backups of the DB system.
Table 8-10 Backups
| Field | Description |
|---|---|
| Backup plan |
|
| Deletion plan |
|
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:
|
Channels
The Channels tab 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:
|
| Enabled | Whether the channel is enabled. |
| Created | Date and time the channel was created. |
| Actions menu | The actions (three dot) menu contains the following:
|
Telemetry
The Telemetry tab shows the Log Analytics configurations.
This section assumes familiarity with OCI Log Analytics Service and the Prerequisites of the Telemetry feature.
See Log Analytics Terms and Concepts for information on the terms used.
Table 8-13 Telemetry page
| Log analytics | Description |
|---|---|
| Log type | The following types of MySQL log:
|
| Compartment | The existing compartment the log group is stored in. |
| Log Group | Existing location for the logs. A log type can only be sent to one log group, but multiple log types can be sent to a log group. |
| Log set | Log partitioning key. |
Related Topics
Security
Use the Security section of the DB system details page to see the details of security attributes.
Table 8-14 List of Security Attributes
| Field | Description |
|---|---|
| Add security attribute menu item | Select to add security attributes to the DB system. |
| Namespace | The namespace of the security attribute. |
| Key | The key of the security attribute. |
| Value | The value of the security attribute. |
| Actions menu or icon |
|
Monitoring
The Monitoring tab shows measurements of resource utilization in the DB system, such as its CPU and memory utilization and disk activity.
Table 8-15 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:
|
| Aggregated metrics data | Displays the aggregated metric data for the HeatWave cluster attached to the DB system.
|
| Metric graphs | For more information on metrics, see Metrics. |
Work Requests
The Work requests tab lists the activity logs for ongoing and recent operations on the DB system. Work requests are retained for 12 hours.
Table 8-16 Work Requests
| Field | Description |
|---|---|
| Operation | One of the following operation
names:
For more information on Work Requests, see Work Request Overview. |
| State | Current state:
|
| % 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:
|
Tags
The Tags tab shows details about the tags added to the DB system.
Table 8-17 Tags
| Field | Description |
|---|---|
| Add | Click to open the Add tags dialog box for adding more tags. |
| Namespace | Displays tag names. |
| Key | Displays tag keys. |
| Value | Displays tag values. |
| Type | Displays tag types. |
| Actions (three dots) | The Actions (three dot) menu contains the following:
|
Related Topics
Using the CLI
Use the command-line interface to view the details of a DB system.
- A DB system Oracle Cloud Identifier (OCID).
- A properly configured CLI installation and the requisite SSH keys. See Command Line Interface.
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"
}