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 and (SUBNET_ATTACH, SUBNET_READ, and SUBNET_DETACH on the DB system subnet's compartment) MYSQL_CONFIGURATIONS_READ on the configuration's compartment is also required if a custom configuration is used. MYSQL_BACKUP_READ on the backup's compartment is also required if this is a clone operation. VNIC_CREATE, VNIC_DELETE, NETWORK_SECURITY_GROUP_UPDATE_MEMBERS, and VNIC_ASSOCIATE_NETWORK_SECURITY_GROUP on the DB system subnet's compartment are also required if a read endpoint is enabled. NETWORK_SECURITY_GROUP_READ and NETWORK_SECURITY_GROUP_UPDATE_MEMBERS on the NSG's compartment, and VNIC_ASSOCIATE_NETWORK_SECURITY_GROUP on the DB system subnet's compartment are also required if Network Security Group is configured.
`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 MYSQL_CONFIGURATIONS_READ on the configuration's compartment is also required if the configuration is updated to use a custom configuration. PRIVATE_IP_UPDATE on the DB system subnet's compartment is also required if the Hostname is updated. VNIC_CREATE, VNIC_DELETE, NETWORK_SECURITY_GROUP_UPDATE_MEMBERS, and VNIC_ASSOCIATE_NETWORK_SECURITY_GROUP on the DB system subnet's compartment are also required if the read endpoint is enabled. VNIC_UPDATE, NETWORK_SECURITY_GROUP_UPDATE_MEMBERS, and VNIC_ASSOCIATE_NETWORK_SECURITY_GROUP on the DB system subnet's compartment are also required if the read endpoint is updated. VNIC_DELETE, NETWORK_SECURITY_GROUP_UPDATE_MEMBERS, and VNIC_ASSOCIATE_NETWORK_SECURITY_GROUP on the DB system subnet's compartment are also required if the read endpoint is disabled. NETWORK_SECURITY_GROUP_READ and NETWORK_SECURITY_GROUP_UPDATE_MEMBERS on the NSG's compartment, and VNIC_ASSOCIATE_NETWORK_SECURITY_GROUP on the DB system subnet's compartment are also required if Network Security Group is added to the DB system. NETWORK_SECURITY_GROUP_READ and NETWORK_SECURITY_GROUP_UPDATE_MEMBERS on the NSG's compartment, and VNIC_DISASSOCIATE_NETWORK_SECURITY_GROUP on the DB system subnet's compartment are also required if Network Security Group is removed from the DB system.
`CreateConfiguration`	MYSQL_CONFIGURATIONS_CREATE MYSQL_CONFIGURATIONS_READ on the source configuration's compartment is also required if the configuration is copied from a custom configuration.
`ListConfigurations`	MYSQL_CONFIGURATIONS_INSPECT
`GetConfiguration`	MYSQL_CONFIGURATIONS_READ (required for Custom configurations only. Any user can read Default configurations.)
`UpdateConfiguration`	MYSQL_CONFIGURATIONS_UPDATE
`DeleteConfiguration`	MYSQL_CONFIGURATIONS_DELETE
`CreateBackup`	MYSQL_BACKUP_CREATE
`DeleteBackup`	MYSQL_BACKUP_DELETE
`ListBackups`	MYSQL_BACKUP_INSPECT
`GetBackup`	MYSQL_BACKUP_READ
`UpdateBackup`	MYSQL_BACKUP_UPDATE
`ValidateBackup`	MYSQL_BACKUP_UPDATE
`CancelDeletion`	MYSQL_BACKUP_UPDATE
`ChangeBackupCompartment`	MYSQL_BACKUP_MOVE in both the source and destination compartment
`CopyBackup`	MYSQL_BACKUP_COPY and MYSQL_BACKUP_READ in the source region and MYSQL_BACKUP_CREATE in the destination region
`ListWorkRequests`	MYSQL_INSTANCE_WORK_REQUEST_INSPECT or MYSQL_INSTANCE_INSPECT
`GetWorkRequest`	MYSQL_INSTANCE_WORK_REQUEST_READ or MYSQL_INSTANCE_READ
`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
`ListReplicas`	MYSQL_INSTANCE_INSPECT
`GetReplica`	MYSQL_INSTANCE_READ
`CreateReplica`	MYSQL_INSTANCE_CREATE and (SUBNET_ATTACH, SUBNET_READ, and SUBNET_DETACH on the DB system subnet's compartment) MYSQL_CONFIGURATIONS_READ on the configuration's compartment is also required if a custom configuration is used. NETWORK_SECURITY_GROUP_READ and NETWORK_SECURITY_GROUP_UPDATE_MEMBERS on the NSG's compartment, and VNIC_ASSOCIATE_NETWORK_SECURITY_GROUP on the DB system subnet's compartment are also required if Network Security Group is added to the read replica.
`UpdateReplica`	MYSQL_INSTANCE_UPDATE MYSQL_CONFIGURATIONS_READ on the configuration's compartment is also required if the configuration is updated to use a custom configuration. NETWORK_SECURITY_GROUP_READ and NETWORK_SECURITY_GROUP_UPDATE_MEMBERS on the NSG's compartment, and VNIC_ASSOCIATE_NETWORK_SECURITY_GROUP on the DB system subnet's compartment are also required if Network Security Group is added to the read replica. NETWORK_SECURITY_GROUP_READ and NETWORK_SECURITY_GROUP_UPDATE_MEMBERS on the NSG's compartment, and VNIC_DISASSOCIATE_NETWORK_SECURITY_GROUP on the DB system subnet's compartment are also required if Network Security Group is removed from the read replica.
`DeleteReplica`	MYSQL_INSTANCE_DELETE
`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
`GenerateHeatWaveClusterMemoryEstimate`	MYSQL_INSTANCE_CONTENT_READ and MYSQL_HEATWAVE_USE

Oracle Cloud Infrastructure Documentation

API Operations