API Operations

You must have the correct permissions to use an API operation.

Table 20-28 API Operations

API Operation Permission Required
ListShapes MYSQL_INSTANCE_INSPECT
ListVersions MYSQL_INSTANCE_INSPECT
ListDbSystems MYSQL_INSTANCE_INSPECT
GetDbSystem MYSQL_INSTANCE_READ
CreateDbSystem MYSQL_INSTANCE_CREATE
StopDbSystem MYSQL_INSTANCE_USE or MYSQL_INSTANCE_STOP
StartDbSystem MYSQL_INSTANCE_USE or MYSQL_INSTANCE_START
RestartDbSystem MYSQL_INSTANCE_USE or (MYSQL_INSTANCE_START and MYSQL_INSTANCE_STOP)
DeleteDbSystem

MYSQL_INSTANCE_DELETE.

MYSQL_CHANNEL_DELETE is also required if a replication channel is associated with the DB System.

UpdateDbSystem MYSQL_INSTANCE_UPDATE
CreateConfiguration MYSQL_CONFIGURATIONS_CREATE
ListConfigurations MYSQL_CONFIGURATIONS_INSPECT
GetConfiguration MYSQL_CONFIGURATIONS_READ (required for Custom configurations only. Any user can read Default configurations.)
UpdateConfiguration MYSQL_CONFIGURATIONS_UPDATE
CopyConfiguration MYSQL_CONFIGURATIONS_READ and MYSQL_CONFIGURATIONS_CREATE (you must also have READ on the source compartment and READ and CREATE on the destination compartment.)
DeleteConfiguration MYSQL_CONFIGURATIONS_DELETE
DbSystemBackup MYSQL_BACKUP_CREATE and MYSQL_INSTANCE_CONTENT_READ
DeleteBackup MYSQL_BACKUP_DELETE and MYSQL_BACKUP_INSPECT
ListBackups MYSQL_BACKUP_INSPECT
GetBackup MYSQL_BACKUP_READ
UpdateBackup MYSQL_BACKUP_UPDATE
ChangeBackupCompartment MYSQL_BACKUP_MOVE
RestoreBackup MYSQL_BACKUP_INSPECT and MYSQL_INSTANCE_CONTENT_READ and MYSQL_INSTANCE_CONTENT_WRITE and MYSQL_INSTANCE_CREATE
ListWorkRequests MYSQL_INSTANCE_WORK_REQUEST_INSPECT or MYSQL_INSTANCE_INSPECT
GetWorkRequest MYSQL_INSTANCE_WORK_REQUEST_READ or MYSQL_INSTANCE_READ
DeleteWorkRequest MYSQL_INSTANCE_WORK_REQUEST_DELETE
ListChannels MYSQL_CHANNEL_INSPECT
GetChannel MYSQL_CHANNEL_READ
CreateChannel MYSQL_CHANNEL_CREATE and MYSQL_INSTANCE_USE and MYSQL_INSTANCE_CONTENT_WRITE
UpdateChannel MYSQL_CHANNEL_UPDATE and MYSQL_INSTANCE_USE and MYSQL_INSTANCE_CONTENT_WRITE
ResetChannel MYSQL_CHANNEL_RESET and MYSQL_INSTANCE_USE and MYSQL_INSTANCE_CONTENT_WRITE
ResumeChannel MYSQL_CHANNEL_RESUME and MYSQL_INSTANCE_USE
DeleteChannel MYSQL_CHANNEL_DELETE and MYSQL_INSTANCE_USE and MYSQL_INSTANCE_CONTENT_WRITE
GetHeatWaveCluster MYSQL_HEATWAVE_READ
AddHeatWaveCluster MYSQL_INSTANCE_USE and MYSQL_HEATWAVE_CREATE
StopHeatWaveCluster MYSQL_INSTANCE_USE or MYSQL_INSTANCE_STOP or MYSQL_HEATWAVE_USE or MYSQL_HEATWAVE_STOP
StartHeatWaveCluster MYSQL_INSTANCE_USE or MYSQL_INSTANCE_START or MYSQL_HEATWAVE_USE or MYSQL_HEATWAVE_START
RestartHeatWaveCluster MYSQL_INSTANCE_USE or MYSQL_HEATWAVE_USE or (MYSQL_INSTANCE_START and MYSQL_INSTANCE_STOP) or (MYSQL_HEATWAVE_START and MYSQL_HEATWAVE_STOP)
DeleteHeatWaveCluster MYSQL_INSTANCE_DELETE or (MYSQL_INSTANCE_USE and MYSQL_HEATWAVE_DELETE)
UpdateHeatWaveCluster MYSQL_INSTANCE_USE and MYSQL_HEATWAVE_CREATE and MYSQL_HEATWAVE_DELETE
GetHeatWaveClusterMemoryEstimate MYSQL_INSTANCE_CONTENT_READ and MYSQL_HEATWAVE_USE
EstimateHeatWaveClusterMemory MYSQL_INSTANCE_CONTENT_READ and MYSQL_HEATWAVE_USE