openapi: 3.2.0 info: description: The API for the MySQL Database Service license: name: Oracle Corporation title: MySQL Database Service Db Backups API version: '20190415' x-provenance: method: harvested first_party: true publisher: Oracle source: https://docs.oracle.com/en-us/iaas/api/specs/c21bc5da8ceddf436da4e56b2328b97fa65fa6675d07108e7a0447de3e832a0a.yaml harvested: '2026-08-04' note: Published by Oracle as the contract for the MySQL Database Service API OCI service and stored verbatim; API Evangelist added only this provenance block. x-evidence: - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json what: Oracle's own index of every OCI service specification - url: https://docs.oracle.com/en-us/iaas/api/specs/c21bc5da8ceddf436da4e56b2328b97fa65fa6675d07108e7a0447de3e832a0a.yaml what: the harvested document for MySQL Database Service API servers: - url: http://mysql.{region}.ocp.oraclecloud.com/20190415 tags: - name: dbBackups paths: /backups: get: description: 'Get a list of DB System backups. ' operationId: ListBackups parameters: - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/FilterByBackupIdQueryParam' - $ref: '#/components/parameters/FilterByBackupLifecycleStateQueryParam' - $ref: '#/components/parameters/FilterByCompartmentIdQueryParam' - $ref: '#/components/parameters/FilterByDbSystemIdQueryParam' - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' - $ref: '#/components/parameters/FilterByBackupSoftDeleteQueryParam' - $ref: '#/components/parameters/FilterByBackupPreparationStatusQueryParam' - $ref: '#/components/parameters/FilterByValidationStatusQueryParam' - $ref: '#/components/parameters/FilterByBackupCreationTypeQueryParam' - $ref: '#/components/parameters/SortByBackupFieldQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' responses: 200: description: All Backups. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/BackupSummary' type: array 400: $ref: '#/components/responses/400-BadRequest' 401: $ref: '#/components/responses/401-Unauthorized' 404: $ref: '#/components/responses/404-NotFound' 429: $ref: '#/components/responses/429-TooManyRequests' 500: $ref: '#/components/responses/500-ServerError' default: $ref: '#/components/responses/DefaultError' summary: List Backups tags: - dbBackups x-obmcs-client-retries-enabled: true post: description: 'Create a backup of a DB System. ' operationId: CreateBackup parameters: - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/OpcRetryTokenHeader' responses: 201: description: 'The DB System backup action has been Created, but might not yet be Available for use. ' headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Backup' 400: $ref: '#/components/responses/400-BadRequest' 401: $ref: '#/components/responses/401-Unauthorized' 404: $ref: '#/components/responses/404-NotFound' 409: $ref: '#/components/responses/409-Conflict' 412: $ref: '#/components/responses/412-PreconditionFailed' 429: $ref: '#/components/responses/429-TooManyRequests' 500: $ref: '#/components/responses/500-ServerError' default: $ref: '#/components/responses/DefaultError' summary: Create DB System Backup tags: - dbBackups x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/Backup' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateBackupDetails' description: Create a Backup of a DB System. required: true /backups/actions/copy: post: description: 'Creates a copy of a DB system backup available in the specified source region. ' operationId: CopyBackup parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/OpcRetryTokenHeader' responses: 202: description: The request was successfully received and the DB system backup is being copied. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Backup' 400: $ref: '#/components/responses/400-BadRequest' 401: $ref: '#/components/responses/401-Unauthorized' 404: $ref: '#/components/responses/404-NotFound' 409: $ref: '#/components/responses/409-Conflict' 412: $ref: '#/components/responses/412-PreconditionFailed' 429: $ref: '#/components/responses/429-TooManyRequests' 500: $ref: '#/components/responses/500-ServerError' default: $ref: '#/components/responses/DefaultError' summary: Copy a DB system backup to another region. tags: - dbBackups x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/Backup' requestBody: content: application/json: schema: $ref: '#/components/schemas/CopyBackupDetails' description: Details required to copy a given DB system backup to another region. required: true /backups/{backupId}: delete: description: 'Delete a Backup. ' operationId: DeleteBackup parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/BackupIdPathParam' responses: 204: description: The request to delete the resource was successful. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400-BadRequest' 401: $ref: '#/components/responses/401-Unauthorized' 404: $ref: '#/components/responses/404-NotFound' 412: $ref: '#/components/responses/412-PreconditionFailed' 429: $ref: '#/components/responses/429-TooManyRequests' 500: $ref: '#/components/responses/500-ServerError' default: $ref: '#/components/responses/DefaultError' summary: Delete a Backup. tags: - dbBackups x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/Backup' get: description: Get information about the specified Backup operationId: GetBackup parameters: - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/IfNoneMatchHeader' - $ref: '#/components/parameters/BackupIdPathParam' responses: 200: description: The requested Backup. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Backup' 304: $ref: '#/components/responses/304-NotModified' 400: $ref: '#/components/responses/400-BadRequest' 401: $ref: '#/components/responses/401-Unauthorized' 404: $ref: '#/components/responses/404-NotFound' 429: $ref: '#/components/responses/429-TooManyRequests' 500: $ref: '#/components/responses/500-ServerError' default: $ref: '#/components/responses/DefaultError' summary: Get a Backup. tags: - dbBackups x-obmcs-client-retries-enabled: true put: description: Update the metadata of a Backup. Metadata such as the displayName or description operationId: UpdateBackup parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/BackupIdPathParam' responses: 200: description: The Backup metadata was updated. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Backup' 304: $ref: '#/components/responses/304-NotModified' 400: $ref: '#/components/responses/400-BadRequest' 401: $ref: '#/components/responses/401-Unauthorized' 404: $ref: '#/components/responses/404-NotFound' 412: $ref: '#/components/responses/412-PreconditionFailed' 429: $ref: '#/components/responses/429-TooManyRequests' 500: $ref: '#/components/responses/500-ServerError' default: $ref: '#/components/responses/DefaultError' summary: Update the Backup metadata. tags: - dbBackups x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/Backup' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateBackupDetails' description: Request to update a Backup's metadata. required: true /backups/{backupId}/actions/cancelDeletion: post: description: 'Cancels the scheduled deletion of a backup and moves it to ACTIVE state. ' operationId: CancelBackupDeletion parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/OpcRetryTokenHeader' - $ref: '#/components/parameters/BackupIdPathParam' responses: 204: description: The request to cancel scheduled deletion of a backup is successful. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400-BadRequest' 401: $ref: '#/components/responses/401-Unauthorized' 404: $ref: '#/components/responses/404-NotFound' 409: $ref: '#/components/responses/409-Conflict' 412: $ref: '#/components/responses/412-PreconditionFailed' 429: $ref: '#/components/responses/429-TooManyRequests' 500: $ref: '#/components/responses/500-ServerError' default: $ref: '#/components/responses/DefaultError' summary: Cancel the scheduled deletion of a backup. tags: - dbBackups x-obmcs-client-retries-enabled: true x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/Backup' /backups/{backupId}/actions/changeCompartment: post: description: 'Moves a DB System Backup into a different compartment. When provided, If-Match is checked against ETag values of the Backup. ' operationId: ChangeBackupCompartment parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/OpcRetryTokenHeader' - $ref: '#/components/parameters/BackupIdPathParam' responses: 204: description: DB System Backup compartment has been changed. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400-BadRequest' 401: $ref: '#/components/responses/401-Unauthorized' 404: $ref: '#/components/responses/404-NotFound' 409: $ref: '#/components/responses/409-Conflict' 412: $ref: '#/components/responses/412-PreconditionFailed' 429: $ref: '#/components/responses/429-TooManyRequests' 500: $ref: '#/components/responses/500-ServerError' default: $ref: '#/components/responses/DefaultError' summary: Move a DB System Backup from one compartment to another. tags: - dbBackups x-related-resource: '#/definitions/Backup' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeBackupCompartmentDetails' description: Target compartment for a DB System Backup. required: true /backups/{backupId}/actions/export: post: description: 'Export logical data from a DB system backup to an Object Storage bucket. ' operationId: ExportBackup parameters: - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/OpcRetryTokenHeader' - $ref: '#/components/parameters/BackupIdPathParam' responses: 202: description: The request was successfully received and the DB system backup is being exported. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400-BadRequest' 401: $ref: '#/components/responses/401-Unauthorized' 404: $ref: '#/components/responses/404-NotFound' 409: $ref: '#/components/responses/409-Conflict' 412: $ref: '#/components/responses/412-PreconditionFailed' 429: $ref: '#/components/responses/429-TooManyRequests' 500: $ref: '#/components/responses/500-ServerError' default: $ref: '#/components/responses/DefaultError' summary: Export a DB system backup to an Object Storage bucket. tags: - dbBackups x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/Backup' requestBody: content: application/json: schema: $ref: '#/components/schemas/ExportBackupDetails' description: Details required to export a given DB system backup to an Object Storage bucket. required: true /backups/{backupId}/actions/validate: post: description: 'Request to validate the backup by checking the data consistency. ' operationId: ValidateBackup parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/OpcRetryTokenHeader' - $ref: '#/components/parameters/BackupIdPathParam' responses: 202: description: Validate backup request has been successfully triggered. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Backup' 400: $ref: '#/components/responses/400-BadRequest' 401: $ref: '#/components/responses/401-Unauthorized' 404: $ref: '#/components/responses/404-NotFound' 409: $ref: '#/components/responses/409-Conflict' 412: $ref: '#/components/responses/412-PreconditionFailed' 429: $ref: '#/components/responses/429-TooManyRequests' 500: $ref: '#/components/responses/500-ServerError' default: $ref: '#/components/responses/DefaultError' summary: 'Request to validate the backup by checking the data consistency. ' tags: - dbBackups x-obmcs-client-retries-enabled: true x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/Backup' requestBody: content: application/json: schema: $ref: '#/components/schemas/ValidateBackupDetails' description: Details required to validate the backup. components: schemas: BackupPolicy: description: The Backup policy for the DB System. properties: copyPolicies: description: 'List of policies of a DB system to schedule cross-region DB system backup copy. The policy includes the name of the destination region to which the DB system backup will be copied, and an optional parameter which specifies the retention period of the copied DB system backup in days. **Note:** Currently, only one policy can be specified in the list. ' items: $ref: '#/components/schemas/CopyPolicy' type: array definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of predefined tag keys. These predefined keys are scoped to namespaces. Tags defined here will be copied verbatim as tags on the Backup resource created by this BackupPolicy. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair applied without any predefined name, type or scope. Exists for cross-compatibility only. Tags defined here will be copied verbatim as tags on the Backup resource created by this BackupPolicy. Example: `{"bar-key": "value"}` ' type: object isEnabled: default: true description: If automated backups are enabled or disabled. type: boolean pitrPolicy: $ref: '#/components/schemas/PitrPolicy' retentionInDays: description: 'The number of days automated backups are retained. ' maximum: 35 minimum: 1 type: integer softDelete: description: 'Retains the backup to be deleted due to the retention policy in DELETE SCHEDULED state for 7 days before permanently deleting it. ' enum: - ENABLED - DISABLED type: string x-obmcs-top-level-enum: '#/definitions/SoftDelete' windowStartTime: description: 'The start of a 30-minute window of time in which daily, automated backups occur. This should be in the format of the "Time" portion of an RFC3339-formatted timestamp. Any second or sub-second time data will be truncated to zero. At some point in the window, the system may incur a brief service disruption as the backup is performed. If not defined, a window is selected from the following Region-based time-spans: - eu-frankfurt-1: 20:00 - 04:00 UTC - us-ashburn-1: 03:00 - 11:00 UTC - uk-london-1: 06:00 - 14:00 UTC - ap-tokyo-1: 13:00 - 21:00 - us-phoenix-1: 06:00 - 14:00 ' type: string required: - isEnabled - windowStartTime - retentionInDays Backup: description: 'A full or incremental copy of a DB System which can be used to create a new DB System or recover a DB System. To use any of the API operations, you must be authorized in an IAM policy. If you''re not authorized, talk to an administrator. If you''re an administrator who needs to write policies to give users access, see [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm). ' properties: backupSizeInGBs: description: The size of the backup in base-2 (IEC) gibibytes. (GiB). type: integer backupType: description: The type of backup. enum: - FULL - INCREMENTAL type: string backupValidationDetails: $ref: '#/components/schemas/BackupValidationDetails' compartmentId: description: The OCID of the compartment. maxLength: 255 minLength: 1 type: string creationType: description: If the backup was created automatically, or by a manual request. enum: - MANUAL - AUTOMATIC type: string dataStorageSizeInGBs: description: 'Initial size of the data volume in GiBs. ' maximum: 131072 minimum: 50 type: integer dbSystemId: description: The OCID of the DB System the backup is associated with. maxLength: 255 minLength: 1 type: string dbSystemSnapshot: $ref: '#/components/schemas/DbSystemSnapshot' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: A user-supplied description for the backup. maxLength: 400 minLength: 1 type: string displayName: description: A user-supplied display name for the backup. maxLength: 255 minLength: 1 type: string encryptData: $ref: '#/components/schemas/EncryptDataDetails' freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: OCID of the backup itself maxLength: 255 minLength: 1 type: string immediateSourceBackupId: description: 'The OCID of the immediate source DB system backup from which this DB system backup was copied. ' maxLength: 255 minLength: 1 type: string lifecycleDetails: description: Additional information about the current lifecycleState. type: string lifecycleState: description: The state of the backup. enum: - CREATING - ACTIVE - INACTIVE - UPDATING - DELETING - DELETED - FAILED - DELETE_SCHEDULED type: string mysqlVersion: description: The MySQL server version of the DB System used for backup. type: string originalSourceBackupId: description: 'The OCID of the original source DB system backup from which this DB system backup was copied. ' maxLength: 255 minLength: 1 type: string retentionInDays: default: 365 description: Number of days to retain this backup. maximum: 365 minimum: 1 type: integer shapeName: description: The shape of the DB System used for backup. maxLength: 255 minLength: 1 type: string softDelete: description: 'Retains the backup to be deleted due to the retention policy in DELETE SCHEDULED state for 7 days before permanently deleting it. ' enum: - ENABLED - DISABLED type: string x-obmcs-top-level-enum: '#/definitions/SoftDelete' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCopyCreated: description: 'The date and time the DB system backup copy was created, as described by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). ' format: date-time type: string timeCreated: description: The time the backup record was created. format: date-time type: string timeUpdated: description: The time at which the backup was updated. format: date-time type: string required: - id - timeCreated - timeUpdated - lifecycleState - lifecycleDetails - backupType - creationType - dbSystemId - compartmentId DeletionPolicyDetails: description: The Deletion policy for the DB System. properties: automaticBackupRetention: default: RETAIN description: 'Specifies if any automatic backups created for a DB System should be retained or deleted when the DB System is deleted. ' enum: - DELETE - RETAIN type: string finalBackup: default: SKIP_FINAL_BACKUP description: "Specifies whether or not a backup is taken when the DB System is deleted.\n REQUIRE_FINAL_BACKUP: a backup is taken if the DB System is deleted.\n SKIP_FINAL_BACKUP: a backup is not taken if the DB System is deleted.\n" enum: - SKIP_FINAL_BACKUP - REQUIRE_FINAL_BACKUP type: string isDeleteProtected: default: false description: 'Specifies whether the DB System can be deleted. Set to true to prevent deletion, false (default) to allow. ' type: boolean required: - automaticBackupRetention - finalBackup - isDeleteProtected PreparedBackupDetails: description: Prepared backup details. properties: preparedBackupRestoreReductionInMinutes: description: The estimated time saving when this prepared backup is restored. type: integer timePrepared: description: The date and time the backup was prepared. format: date-time type: string TelemetryConfigurationDetails: description: 'Telemetry configuration details of a DB System or a read replica. ' properties: logs: description: Telemetry configuration details for logging. items: $ref: '#/components/schemas/LoggingDestinationConfiguration' maxItems: 10 minItems: 1 type: array SecureConnectionDetails: description: 'Secure connection configuration details. ' properties: certificateGenerationType: default: SYSTEM description: 'Select whether to use MySQL Database Service-managed certificate (SYSTEM) or your own certificate (BYOC). ' enum: - SYSTEM - BYOC type: string x-obmcs-top-level-enum: '#/definitions/CertificateGenerationType' certificateId: description: The OCID of the certificate to use. maxLength: 255 type: string required: - certificateGenerationType CopyBackupDetails: description: Details required to copy a DB system backup from its source region to a destination region. properties: backupCopyRetentionInDays: description: 'Number of days to retain the copied DB system backup. **Note:** The maximum value for an automatic backup is 35, and the maximum value for a manual backup is 365. ' minimum: 1 type: integer compartmentId: description: 'The OCID of the compartment the DB system backup is to be copied to. **Note:** The compartment must be the same as the compartment of the DB system backup in the source region. ' maxLength: 255 minLength: 1 type: string description: description: 'A user-supplied description for the DB system backup. By default, the source backup description will be used. ' maxLength: 400 minLength: 1 type: string displayName: description: 'A user-supplied display name for the DB system backup. By default, the source backup display name will be used. ' maxLength: 255 minLength: 1 type: string encryptData: $ref: '#/components/schemas/EncryptDataDetails' sourceBackupId: description: 'The OCID of DB system backup to be copied. ' maxLength: 255 minLength: 1 type: string sourceRegion: description: 'The region identifier of the source region where the DB system backup exists. For more information, please see [Regions and Availability Domains](https://docs.oracle.com/en-us/iaas/Content/General/Concepts/regions.htm). ' maxLength: 64 minLength: 1 type: string required: - compartmentId - sourceBackupId - sourceRegion EncryptDataDetails: description: 'Encrypt data details. ' properties: keyGenerationType: default: SYSTEM description: Select whether to use Oracle-managed key (SYSTEM) or your own key (BYOK). enum: - SYSTEM - BYOK type: string x-obmcs-top-level-enum: '#/definitions/KeyGenerationType' keyId: description: The OCID of the key to use. maxLength: 255 minLength: 1 type: string required: - keyGenerationType Error: description: Sorry. properties: code: description: 'A short error code that defines the error, meant for programmatic parsing. See [API Errors](/Content/API/References/apierrors.htm). ' type: string message: description: A human-readable error string. type: string required: - code - message ExportBackupDetails: description: The parameters required to export a DB system backup. properties: bucketName: description: The Object Storage bucket name. maxLength: 256 minLength: 1 type: string exportOptions: $ref: '#/components/schemas/ExportOptions' namespaceName: description: The Object Storage namespace. minLength: 1 type: string subnetId: description: 'The OCID of the subnet which the temporary MySQL instance is associated with. If not specified, the subnet OCID of the DB system from which the backup is taken will be used by default. To export a backup copied from another region, it is mandatory to specify a valid subnet OCID in the current region. ' maxLength: 255 minLength: 1 type: string required: - bucketName - namespaceName UpdateBackupDetails: description: 'The Backup metadata which can be updated. ' properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: A user-supplied description for the backup. maxLength: 400 minLength: 1 type: string displayName: description: A user-supplied display name for the backup. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object retentionInDays: description: 'The number of days backups are retained. ' maximum: 365 minimum: 1 type: integer softDelete: description: 'Retains the backup to be deleted due to the retention policy in DELETE SCHEDULED state for 7 days before permanently deleting it. ' enum: - ENABLED - DISABLED type: string x-obmcs-top-level-enum: '#/definitions/SoftDelete' BackupSummary: description: 'Details of Backups such as OCID, description, backupType, and so on. To use any of the API operations, you must be authorized in an IAM policy. If you''re not authorized, talk to an administrator. If you''re an administrator who needs to write policies to give users access, see [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm). ' properties: backupPreparationStatus: description: 'Indicates whether the backup has been prepared successfully. ' type: string x-obmcs-enumref: '#/definitions/BackupValidationDetails/backupPreparationStatus' backupSizeInGBs: description: The size of the backup in GiBs. type: integer backupType: description: The type of backup. type: string x-obmcs-enumref: '#/definitions/Backup/backupType' compartmentId: description: The OCID of the compartment the backup exists in. maxLength: 255 minLength: 1 type: string creationType: description: If the backup was created automatically, or by a manual request. type: string x-obmcs-enumref: '#/definitions/Backup/creationType' dataStorageSizeInGBs: description: Size of the data volume in GiBs. maximum: 131072 minimum: 50 type: integer dbSystemId: description: The OCID of the DB System the Backup is associated with. maxLength: 255 minLength: 1 type: string dbSystemSnapshotSummary: $ref: '#/components/schemas/DbSystemSnapshotSummary' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: A user-supplied description of the backup. maxLength: 400 minLength: 1 type: string displayName: description: A user-supplied display name for the backup. maxLength: 255 minLength: 1 type: string encryptData: $ref: '#/components/schemas/EncryptDataDetails' freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: OCID of the backup. maxLength: 255 minLength: 1 type: string immediateSourceBackupId: description: 'The OCID of the immediate source DB system backup from which this DB system backup was copied. ' maxLength: 255 minLength: 1 type: string lifecycleDetails: description: Additional information about the current lifecycleState. type: string lifecycleState: description: The state of the backup. type: string x-obmcs-enumref: '#/definitions/Backup/lifecycleState' mysqlVersion: description: The version of the DB System used for backup. type: string originalSourceBackupId: description: 'The OCID of the original source DB system backup from which this DB system backup was copied. ' maxLength: 255 minLength: 1 type: string retentionInDays: default: 365 description: Number of days to retain this backup. maximum: 365 minimum: 1 type: integer shapeName: description: The shape of the DB System instance used for backup. maxLength: 255 minLength: 1 type: string softDelete: description: 'Retains the backup to be deleted due to the retention policy in DELETE SCHEDULED state for 7 days before permanently deleting it. ' enum: - ENABLED - DISABLED type: string x-obmcs-top-level-enum: '#/definitions/SoftDelete' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCopyCreated: description: 'The date and time the DB system backup copy was created, as described by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). ' format: date-time type: string timeCreated: description: The time the backup was created. format: date-time type: string validationStatus: description: Status of the backup validation. type: string x-obmcs-enumref: '#/definitions/BackupValidationDetails/validationStatus' required: - id - timeCreated - lifecycleState - backupType - creationType - dbSystemId - compartmentId CompressionOptions: description: The additional compression options used while exporting the DB system backup. properties: isEnabled: default: true description: The compression status of the exported data. type: boolean level: default: 1 description: The level of compression to use when creating the dump files. maximum: 22 minimum: 1 type: integer type: default: ZSTD description: The compression type to use when creating the dump files. enum: - GZIP - ZSTD type: string DatabaseConsoleDetails: description: 'Database console configuration details. ' properties: port: default: 8443 description: The port on which the database console can be accessed. Supported port numbers are 443 and from 1024 to 65535. maximum: 65535 minimum: 443 type: integer status: default: DISABLED description: Whether the database console is enabled on the DB System. enum: - ENABLED - DISABLED type: string x-obmcs-top-level-enum: '#/definitions/DatabaseConsoleStatus' required: - status PitrPolicy: description: The PITR policy for the DB System. properties: isEnabled: description: Specifies if PITR is enabled or disabled. type: boolean required: - isEnabled ChangeBackupCompartmentDetails: description: OCID of the target compartment for DB System Backup change compartment request. properties: compartmentId: description: OCID of the target compartment. maxLength: 255 minLength: 1 type: string required: - compartmentId DestinationConfiguration: description: Configuration variable of a given destination. properties: key: description: Name of the destination configuration variable. maxLength: 255 minLength: 1 type: string value: description: Value of the destination configuration variable. maxLength: 255 minLength: 1 type: string required: - key - value type: object DbSystemSnapshot: description: 'Snapshot of the DbSystem details at the time of the backup ' properties: adminUsername: description: The username for the administrative user. maxLength: 32 minLength: 1 type: string availabilityDomain: description: 'The Availability Domain where the primary DB System should be located. ' maxLength: 255 minLength: 1 type: string backupPolicy: $ref: '#/components/schemas/BackupPolicy' compartmentId: description: The OCID of the compartment the DB System belongs in. maxLength: 255 minLength: 1 type: string configurationId: description: The OCID of the Configuration to be used for Instances in this DB System. maxLength: 255 minLength: 1 type: string crashRecovery: default: ENABLED description: 'Whether to run the DB System with InnoDB Redo Logs and the Double Write Buffer enabled or disabled, and whether to enable or disable syncing of the Binary Logs. ' enum: - ENABLED - DISABLED type: string x-obmcs-top-level-enum: '#/definitions/CrashRecoveryStatus' dataStorage: $ref: '#/components/schemas/DataStorage' dataStorageSizeInGBs: description: 'DEPRECATED: User specified size of the data volume. May be less than current allocatedStorageSizeInGBs. Replaced by dataStorage.dataStorageSizeInGBs. ' maximum: 131072 minimum: 50 type: integer databaseConsole: $ref: '#/components/schemas/DatabaseConsoleDetails' databaseManagement: default: ENABLED description: 'Whether to enable monitoring via the Database Management service. ' enum: - ENABLED - DISABLED type: string x-obmcs-top-level-enum: '#/definitions/DatabaseManagementStatus' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object deletionPolicy: $ref: '#/components/schemas/DeletionPolicyDetails' description: description: User-provided data about the DB System. maxLength: 400 minLength: 1 type: string displayName: description: The user-friendly name for the DB System. It does not have to be unique. maxLength: 255 minLength: 1 type: string encryptData: $ref: '#/components/schemas/EncryptDataDetails' endpoints: description: 'The network endpoints available for this DB System. ' items: $ref: '#/components/schemas/DbSystemEndpoint' type: array faultDomain: description: 'The name of the Fault Domain the DB System is located in. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object hostnameLabel: description: 'The hostname for the primary endpoint of the DB System. Used for DNS. The value is the hostname portion of the primary private IP''s fully qualified domain name (FQDN) (for example, "dbsystem-1" in FQDN "dbsystem-1.subnet123.vcn1.oraclevcn.com"). Must be unique across all VNICs in the subnet and comply with RFC 952 and RFC 1123. ' type: string id: description: The OCID of the DB System. maxLength: 255 minLength: 1 type: string ipAddress: description: 'The IP address the DB System is configured to listen on. A private IP address of the primary endpoint of the DB System. Must be an available IP address within the subnet''s CIDR. This will be a "dotted-quad" style IPv4 address. ' type: string ipv6Address: description: The IPv6 address the DB System is configured to listen on. maxLength: 45 minLength: 1 type: string isHighlyAvailable: default: true description: 'Specifies if the DB System is highly available. ' type: boolean maintenance: $ref: '#/components/schemas/MaintenanceDetails' mysqlVersion: description: Name of the MySQL Version in use for the DB System. type: string nsgIds: description: Network Security Group OCIDs used for the VNIC attachment. items: type: string maxItems: 5 minItems: 0 type: array uniqueItems: true port: description: The port for primary endpoint of the DB System to listen on. maximum: 65535 minimum: 1024 type: integer portX: description: 'The network port on which X Plugin listens for TCP/IP connections. This is the X Plugin equivalent of port. ' maximum: 65535 minimum: 1024 type: integer readEndpoint: $ref: '#/components/schemas/ReadEndpointDetails' region: description: 'The region identifier of the region where the DB system exists. For more information, please see [Regions and Availability Domains](https://docs.oracle.com/en-us/iaas/Content/General/Concepts/regions.htm). ' maxLength: 64 minLength: 1 type: string rest: $ref: '#/components/schemas/RestDetails' secureConnections: $ref: '#/components/schemas/SecureConnectionDetails' securityAttributes: additionalProperties: additionalProperties: description: 'Security Attribute value and mode. Only the String type is supported for value. (Mode is reserved and “enforce” in this release) ' type: object description: 'Key-value pair representing a ZPR tag key and value, scoped to a namespace. Example: `{"MaxEgressCount": {"value": "42", "mode": "audit"}}` ' type: object description: 'Security Attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see [ZPR Artifacts](https://docs.oracle.com/en-us/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm). Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}` ' type: object shapeName: description: 'The shape of the primary instances of the DB System. The shape determines resources allocated to a DB System - CPU cores and memory for VM shapes; CPU cores, memory and storage for non-VM (or bare metal) shapes. To get a list of shapes, use (the [ListShapes](#/en/mysql/20181021/ShapeSummary/ListShapes) operation. ' maxLength: 255 minLength: 1 type: string subnetId: description: 'The OCID of the subnet the DB System is associated with. ' maxLength: 255 minLength: 1 type: string telemetryConfiguration: $ref: '#/components/schemas/TelemetryConfigurationDetails' required: - compartmentId - dataStorageSizeInGBs - displayName - id - subnetId - mysqlVersion - maintenance - deletionPolicy Ipv6AddressIpv6SubnetCidrPairDetails: description: Details to assign an IPv6 subnet prefix or IPv6 address to a resource. properties: ipv6Address: description: 'An IPv6 address of your choice. Must be an available IPv6 address within the subnet''s prefix. ' maxLength: 45 minLength: 1 type: string x-default-description: 'If an IPv6 address is not provided: - Oracle will automatically assign an IPv6 address from the subnet''s IPv6 prefix if and only if there is only one IPv6 prefix on the subnet. - Oracle will automatically assign an IPv6 address from the subnet''s IPv6 Oracle GUA prefix if it exists on the subnet. ' ipv6SubnetCidr: description: The IPv6 prefix allocated to the subnet. maxLength: 45 minLength: 1 type: string x-default-description: 'null' ExportOptions: description: The additional options used while exporting the DB system backup. properties: compressionOptions: $ref: '#/components/schemas/CompressionOptions' dataFormat: default: CSV description: The format used for storing data. enum: - CSV - TSV type: string folderName: description: 'The name of the folder in the Object Storage bucket where the dump files will be stored. A folder with the same name must not exist in the bucket. The folder will be created in the export process. ' maxLength: 1024 minLength: 1 type: string BackupValidationDetails: description: Backup validation details. properties: backupPreparationStatus: description: "Indicates whether the backup has been prepared successfully. \nPREPARED: The backup is prepared one.\nNOT_PREPARED: The backup is not prepared.\n" enum: - PREPARED - NOT_PREPARED type: string errorMessage: description: Error message if the backup validation has failed. type: string estimatedRestoreDuration: description: The estimated restore duration of the backup. format: x-obmcs-duration type: string preparedBackupDetails: $ref: '#/components/schemas/PreparedBackupDetails' timeLastValidated: description: The date and time of the most recent validation performed on the backup. format: date-time type: string validationStatus: description: "The status of backup validation: \nNOT_VALIDATED (Default): The backup has not been validated. \nVALIDATED: The backup has been validated successfully. \nNEEDS_ATTENTION: The backup validation failed due to a transient issue. Validation should be retried. \nFAILED: The backup cannot be restored.\n" enum: - NOT_VALIDATED - VALIDATED - NEEDS_ATTENTION - FAILED type: string CopyPolicy: description: 'A policy of a DB system to schedule cross-region DB system backup copy. ' properties: backupCopyRetentionInDays: description: Number of days to retain the copied DB system backup. maximum: 35 minimum: 1 type: integer copyToRegion: description: The destination region name to which the DB system backup will be copied. maxLength: 64 minLength: 1 type: string required: - copyToRegion LoggingDestinationConfiguration: description: Configuration parameters for a given destination. properties: destination: description: Type of destination where MySQL telemetry is exposed to. enum: - LOG_ANALYTICS - OPEN_TELEMETRY type: string destinationConfigurations: description: List of configuration variables for a given destination type. items: $ref: '#/components/schemas/DestinationConfiguration' maxItems: 10 type: array logTypes: description: List of MySQL telemetry types that can be exposed on a telemetry destination items: enum: - ERROR_LOG - GENERAL_LOG - SLOW_QUERY_LOG - AUDIT_LOG type: string type: array required: - destination - destinationConfigurations - logTypes type: object ReadEndpointDetails: description: 'The read endpoint of a DB System. ' properties: excludeIps: description: 'A list of IP addresses of read replicas that are excluded from serving read requests. ' items: type: string type: array isEnabled: default: false description: 'Specifies if the DB System read endpoint is enabled or not. ' type: boolean readEndpointHostnameLabel: description: 'The hostname for the read endpoint of the DB System. Used for DNS. The value is the hostname portion of the primary private IP''s fully qualified domain name (FQDN) (for example, "dbsystem-1" in FQDN "dbsystem-1.subnet123.vcn1.oraclevcn.com"). Must be unique across all VNICs in the subnet and comply with RFC 952 and RFC 1123. ' type: string readEndpointIpAddress: description: 'The IP address the DB System read endpoint is configured to listen on. A private IP address of your choice to assign to the read endpoint of the DB System. Must be an available IP address within the subnet''s CIDR. If you don''t specify a value, Oracle automatically assigns a private IP address from the subnet. This should be a "dotted-quad" style IPv4 address. ' type: string x-default-description: 'If you don''t specify a value, Oracle automatically assigns a private IPv4 address from the subnet. ' readEndpointIpv6AddressIpv6SubnetCidrPairDetails: $ref: '#/components/schemas/Ipv6AddressIpv6SubnetCidrPairDetails' CreateBackupDetails: description: Complete information for a Backup. properties: backupType: default: INCREMENTAL description: The type of backup. enum: - FULL - INCREMENTAL type: string dbSystemId: description: The OCID of the DB System the Backup is associated with. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: A user-supplied description for the backup. maxLength: 400 minLength: 1 type: string displayName: description: A user-supplied display name for the backup. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object retentionInDays: default: 365 description: Number of days to retain this backup. maximum: 365 minimum: 1 type: integer softDelete: description: 'Retains the backup to be deleted due to the retention policy in DELETE SCHEDULED state for 7 days before permanently deleting it. ' enum: - ENABLED - DISABLED type: string x-obmcs-top-level-enum: '#/definitions/SoftDelete' required: - dbSystemId MaintenanceDetails: description: 'The Maintenance Policy for the DB System or Read Replica that this model is included in. ' properties: maintenanceDisabledWindows: description: 'Time window during which downtime-inducing maintenance shall not be performed. Downtime-free maintenance may be performed to apply required security patches. At most one configured window is supported. ' items: $ref: '#/components/schemas/MaintenanceDisabledWindow' type: array maintenanceScheduleType: description: 'The maintenance schedule type of the DB system. EARLY: Maintenance schedule follows a cycle where upgrades are performed when versions become deprecated. REGULAR: Maintenance schedule follows the normal cycle where upgrades are performed when versions become unavailable. ' enum: - EARLY - REGULAR type: string x-default-description: 'The default value is dependant on the DB System''s MySQL version track: REGULAR for LTS and EARLY for Innovation. ' x-obmcs-top-level-enum: '#/definitions/MaintenanceScheduleType' targetVersion: description: 'The version that is expected to be targeted during the next scheduled maintenance run. ' type: string timeScheduled: description: 'The time the scheduled maintenance is expected to start, as described by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). ' format: date-time type: string versionPreference: description: 'The preferred version to target when performing an automatic MySQL upgrade. OLDEST: Choose the oldest available MySQL version based on the current version of the DB System. SECOND_NEWEST: Choose the MySQL version before the newest for auto-upgrade. NEWEST: Choose the latest and greatest MySQL version available for auto-upgrade. ' enum: - OLDEST - SECOND_NEWEST - NEWEST type: string x-default-description: 'The default value is dependant on the DB System''s MySQL version track: OLDEST for LTS and NEWEST for Innovation. ' x-obmcs-top-level-enum: '#/definitions/VersionPreference' versionTrackPreference: description: 'The preferred version track to target when performing an automatic MySQL upgrade. LONG_TERM_SUPPORT: No MySQL database behavior changes. INNOVATION: Provides access to the latest features and all bug fixes. FOLLOW: Follows the track of the current MySQL version. ' enum: - LONG_TERM_SUPPORT - INNOVATION - FOLLOW type: string x-default-description: 'The default value is dependant on the DB System''s MySQL version track: FOLLOW for LTS and INNOVATION for Innovation. ' x-obmcs-top-level-enum: '#/definitions/VersionTrackPreference' windowStartTime: description: 'The start time of the maintenance window. This string is of the format: "{day-of-week} {time-of-day}". "{day-of-week}" is a case-insensitive string like "mon", "tue", &c. "{time-of-day}" is the "Time" portion of an RFC3339-formatted timestamp. Any second or sub-second time data will be truncated to zero. If you set the read replica maintenance window to "" or if not specified, the read replica is set same as the DB system maintenance window. ' type: string ValidateBackupDetails: description: Details required to validate backup. properties: isPreparedBackupRequired: default: false description: "Specifies whether the backup needs to be prepared for fast restore or not. \nSet to true to prepare the backup, set to false (default) if not required.\nNote: The prepared backup will replace the original backup and will not generate a new backup copy.\nThe cost associated with the backup may vary, as the prepared backup will consistently be a full backup, \nit may also change the storage size of the original backup.\n" type: boolean required: - isPreparedBackupRequired DbSystemEndpoint: description: 'A particular functional endpoint for access to a DB System, and the properties that apply to it. ' properties: hostname: description: The network address of the DB System. type: string ipAddress: description: The IP address the DB System is configured to listen on. type: string ipAddressVersion: description: The internet protocol (IP) version of the IP address. enum: - IPV4 - IPV6 type: string modes: description: The access modes from the client that this endpoint supports. items: enum: - READ - WRITE type: string type: array uniqueItems: true port: description: The port the MySQL instance listens on. maximum: 65535 minimum: 1024 type: integer portX: description: The network port where to connect to use this endpoint using the X protocol. maximum: 65535 minimum: 1024 type: integer status: description: 'The state of the endpoints, as far as it can seen from the DB System. There may be some inconsistency with the actual state of the MySQL service. ' enum: - ACTIVE - INACTIVE - UPDATING type: string statusDetails: description: Additional information about the current endpoint status. type: string required: - ipAddress - port - portX DbSystemSnapshotSummary: description: 'A summary of snapshot of the DB system details at the time of the backup. ' properties: displayName: description: The user-friendly name for the DB system. It does not have to be unique. maxLength: 255 minLength: 1 type: string id: description: The OCID of the DB System. maxLength: 255 minLength: 1 type: string region: description: 'The region identifier of the region where the DB system exists. For more information, please see [Regions and Availability Domains](https://docs.oracle.com/en-us/iaas/Content/General/Concepts/regions.htm). ' maxLength: 64 minLength: 1 type: string required: - displayName - id - region RestDetails: description: 'REST configuration details. ' properties: configuration: default: DISABLED description: Select how REST is configured across the DB System instances. enum: - DISABLED - DBSYSTEM_ONLY type: string x-obmcs-top-level-enum: '#/definitions/RestConfigurationType' port: default: 443 description: The port for REST to listen on. Supported port numbers are 443 and from 1024 to 65535. maximum: 65535 minimum: 443 type: integer required: - configuration DataStorageDetails: description: 'Data Storage configuration properties. ' properties: isAutoExpandStorageEnabled: default: false description: 'Enable/disable automatic storage expansion. When set to true, the DB System will automatically add storage incrementally up to the value specified in maxStorageSizeInGBs. ' type: boolean maxStorageSizeInGBs: description: 'Maximum storage size this DB System can expand to. When isAutoExpandStorageEnabled is set to true, the DB System will add storage incrementally up to this value. DB Systems with an initial storage size of 400 GB or less can be expanded up to 32 TB. DB Systems with an initial storage size between 401-800 GB can be expanded up to 64 TB. DB Systems with an initial storage size between 801-1200 GB can be expanded up to 96 TB. DB Systems with an initial storage size of 1201 GB or more can be expanded up to 128 TB. It is not possible to decrease data storage size. You cannot set the maximum data storage size to less than either current DB System dataStorageSizeInGBs or allocatedStorageSizeInGBs. ' maximum: 131072 minimum: 100 type: integer MaintenanceDisabledWindow: description: 'Time window during which downtime-inducing maintenance shall not be performed. Downtime-free maintenance may be performed to apply required security patches. ' properties: timeEnd: description: 'The time until when maintenance is disabled. Must be set together with timeStart and must be after timeStart. as described by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). ' format: date-time type: string timeStart: description: 'The time from when maintenance is disabled. Must be set together with timeEnd and must be before timeEnd. as described by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). ' format: date-time type: string required: - timeStart - timeEnd DataStorage: allOf: - $ref: '#/components/schemas/DataStorageDetails' - required: - allocatedStorageSizeInGBs - isAutoExpandStorageEnabled - dataStorageSizeInGBs - dataStorageSizeLimitInGBs - properties: allocatedStorageSizeInGBs: description: 'The actual allocated storage size for the DB System. This may be higher than dataStorageSizeInGBs if an automatic storage expansion has occurred. ' maximum: 131072 minimum: 50 type: integer dataStorageSizeInGBs: description: 'User specified size of the data volume. May be less than current allocatedStorageSizeInGBs. ' maximum: 131072 minimum: 50 type: integer dataStorageSizeLimitInGBs: description: 'The absolute limit the DB System''s storage size may ever expand to, either manually or automatically. This limit is based based on the initial dataStorageSizeInGBs when the DB System was first created. Both dataStorageSizeInGBs and maxDataStorageSizeInGBs can not exceed this value. DB Systems with an initial storage size of 400 GB or less can be expanded up to 32 TB. DB Systems with an initial storage size between 401-800 GB can be expanded up to 64 TB. DB Systems with an initial storage size between 801-1200 GB can be expanded up to 96 TB. DB Systems with an initial storage size of 1201 GB or more can be expanded up to 128 TB. ' enum: - 32768 - 65536 - 98304 - 131072 type: integer description: 'Data Storage information. ' parameters: PaginationTokenQueryParam: description: 'The value of the `opc-next-page` or `opc-prev-page` response header from the previous list call. For information about pagination, see [List Pagination](../../../#API/Concepts/usingapi.htm#List_Pagination). ' in: query name: page schema: type: string maxLength: 4096 minLength: 1 IfNoneMatchHeader: description: 'For conditional requests. In the GET call for a resource, set the `If-None-Match` header to the value of the ETag from a previous GET (or POST or PUT) response for that resource. The server will return with either a 304 Not Modified response if the resource has not changed, or a 200 OK response with the updated representation. ' in: header name: if-none-match x-default-description: No conditional request is made. schema: type: string OpcRetryTokenHeader: description: 'A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). ' in: header name: opc-retry-token schema: type: string maxLength: 64 minLength: 1 IfMatchHeader: description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `If-Match` header to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource''s current etag value. ' in: header name: if-match schema: type: string SortByBackupFieldQueryParam: description: 'The field to sort by. Only one sort order may be provided. Time fields are default ordered as descending. ' in: query name: sortBy required: false schema: type: string enum: - timeCreated - timeUpdated - displayName default: timeCreated FilterByBackupPreparationStatusQueryParam: description: 'Indicates whether the backup has been prepared successfully. ' in: query name: backupPreparationStatus required: false x-obmcs-enumref: '#/definitions/BackupValidationDetails/backupPreparationStatus' schema: type: string default: NOT_PREPARED FilterByCompartmentIdQueryParam: description: The compartment [OCID](/Content/General/Concepts/identifiers.htm). in: query name: compartmentId required: true schema: type: string maxLength: 255 minLength: 1 FilterByDisplayNameQueryParam: description: A filter to return only the resource matching the given display name exactly. in: query name: displayName required: false schema: type: string maxLength: 255 FilterByValidationStatusQueryParam: description: Backup validation status in: query name: validationStatus required: false x-obmcs-enumref: '#/definitions/BackupValidationDetails/validationStatus' schema: type: string default: NOT_VALIDATED PaginationLimitQueryParam: description: 'The maximum number of items to return in a paginated list call. For information about pagination, see [List Pagination](../../../#API/Concepts/usingapi.htm#List_Pagination). ' in: query name: limit schema: type: integer default: 100 maximum: 1000 minimum: 1 FilterByBackupCreationTypeQueryParam: description: Backup creationType in: query name: creationType required: false x-obmcs-enumref: '#/definitions/Backup/creationType' schema: type: string SortOrderQueryParam: description: The sort order to use (ASC or DESC). in: query name: sortOrder schema: type: string enum: - ASC - DESC default: ASC FilterByBackupSoftDeleteQueryParam: description: Backup Soft Delete in: query name: softDelete required: false x-obmcs-top-level-enum: '#/definitions/SoftDelete' schema: type: string enum: - ENABLED - DISABLED OpcRequestIdHeader: description: 'Customer-defined unique identifier for the request. If you need to contact Oracle about a specific request, please provide the request ID that you supplied in this header with the request. ' in: header name: opc-request-id required: false schema: type: string FilterByBackupIdQueryParam: description: Backup OCID in: query name: backupId required: false schema: type: string FilterByDbSystemIdQueryParam: description: The DB System [OCID](/Content/General/Concepts/identifiers.htm). in: query name: dbSystemId required: false schema: type: string maxLength: 255 minLength: 1 FilterByBackupLifecycleStateQueryParam: description: Backup Lifecycle State in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/Backup/lifecycleState' schema: type: string default: AVAILABLE BackupIdPathParam: description: The OCID of the Backup in: path name: backupId required: true schema: type: string maxLength: 255 minLength: 1 responses: 409-Conflict: description: Conflict headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 404-NotFound: description: Not Found headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 400-BadRequest: description: Bad Request headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 500-ServerError: description: Internal Server Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' DefaultError: description: An error has occurred. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 412-PreconditionFailed: description: Precondition Failed headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 401-Unauthorized: description: Unauthorized headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 304-NotModified: description: The resource with the given ETag has not changed. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 429-TooManyRequests: description: Too Many Requests headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string retry-after: description: A decimal number representing the number of seconds the client should wait before polling this endpoint again. schema: type: integer content: application/json: schema: $ref: '#/components/schemas/Error' x-anchors: x-headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' type: string opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' type: string retry-after: description: A decimal number representing the number of seconds the client should wait before polling this endpoint again. type: integer x-properties: backupPolicyDefinedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of predefined tag keys. These predefined keys are scoped to namespaces. Tags defined here will be copied verbatim as tags on the Backup resource created by this BackupPolicy. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object backupPolicyFreeformTags: additionalProperties: type: string description: 'Simple key-value pair applied without any predefined name, type or scope. Exists for cross-compatibility only. Tags defined here will be copied verbatim as tags on the Backup resource created by this BackupPolicy. Example: `{"bar-key": "value"}` ' type: object definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object securityAttributes: additionalProperties: additionalProperties: description: 'Security Attribute value and mode. Only the String type is supported for value. (Mode is reserved and “enforce” in this release) ' type: object description: 'Key-value pair representing a ZPR tag key and value, scoped to a namespace. Example: `{"MaxEgressCount": {"value": "42", "mode": "audit"}}` ' type: object description: 'Security Attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see [ZPR Artifacts](https://docs.oracle.com/en-us/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm). Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}` ' type: object systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object x-oracle-package: com.oracle.oci.mysql