openapi: 3.2.0 info: description: 'The API for the Database Service. Use this API to manage resources such as databases and DB Systems. For more information, see [Overview of the Database Service](/iaas/Content/Database/Concepts/databaseoverview.htm). ' license: name: Oracle Corporation title: Service Database API version: '20160918' x-provenance: method: harvested first_party: true publisher: Oracle source: https://docs.oracle.com/en-us/iaas/api/specs/69fd32495b9fdc31c32fba60ad4f13c01b794927ed16b3cc949de12a3e983147.yaml harvested: '2026-08-04' note: Published by Oracle as the contract for the 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/69fd32495b9fdc31c32fba60ad4f13c01b794927ed16b3cc949de12a3e983147.yaml what: the harvested document for Database Service API servers: - url: http://localhost:19222/20160918 tags: - name: database paths: /applicationVip: get: description: 'Gets a list of application virtual IP (VIP) addresses on a cloud VM cluster. ' operationId: ListApplicationVips parameters: - $ref: '#/components/parameters/CompartmentId' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' - $ref: '#/components/parameters/CloudVmClusterIdQueryParam' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ListApplicationVipsSortByQueryParam' - $ref: '#/components/parameters/ListApplicationVipsFilterByLifecycleStateQueryParam' responses: 200: description: The list of application virtual IP (VIP) addresses on the specified cloud VM cluster. 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/ApplicationVipSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets a list of application virtual IP (VIP) addresses on a cloud VM cluster. tags: - database x-example: 'GET /20160918/applicationVip?limit=100 Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' post: description: 'Creates a new application virtual IP (VIP) address in the specified cloud VM cluster based on the request parameters you provide. ' operationId: CreateApplicationVip parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: The request was successfully received and an application virtual IP (VIP) address is being created. 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/ApplicationVip' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Creates a new application virtual IP (VIP) address. tags: - database x-example: 'POST /20160918/applicationVip Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateApplicationVipDetails' description: Request to create a new application virtual IP (VIP) address. required: true /applicationVip/{applicationVipId}: delete: description: 'Deletes and deregisters the specified application virtual IP (VIP) address. ' operationId: DeleteApplicationVip parameters: - $ref: '#/components/parameters/ApplicationVipIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OptionalRequestId' responses: 204: description: The request to delete the specified application virtual IP (VIP) address was accepted. 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 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: DeleteApplicationVip tags: - database x-example: 'DELETE /20160918/applicationVip/<applicationVipId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/ApplicationVip' get: description: Gets information about a specified application virtual IP (VIP) address. operationId: GetApplicationVip parameters: - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/ApplicationVipIdPathParam' responses: 200: description: The application virtual IP (VIP) address details. 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/ApplicationVip' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetApplicationVip tags: - database x-example: 'GET /20160918/applicationVip/<applicationVipId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' /autonomousContainerDatabaseBackups: get: description: 'Gets a list of Autonomous Container Database backups by using either the ''autonomousDatabaseId'' or ''compartmentId'' as your query parameter. ' operationId: ListAutonomousContainerDatabaseBackups parameters: - $ref: '#/components/parameters/OptionalCompartmentIdQueryParam' - $ref: '#/components/parameters/optionalAutonomousContainerDatabaseIdQueryParam' - $ref: '#/components/parameters/OptionalIsRemoteQueryParam' - $ref: '#/components/parameters/ListAutonomousContainerDatabaseBackupsFilterByInfrastructureTypeQueryParam' - $ref: '#/components/parameters/listAutonomousContainerDatabaseBackupsFilterByLifecycleStateQueryParam' - $ref: '#/components/parameters/listAutonomousContainerDatabaseBackupsSortByQueryParam' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' responses: 200: description: A list of all of the Autonomous Container Database Backups in the specified compartment. 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/AutonomousContainerDatabaseBackupCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListAutonomousContainerDatabaseBackups tags: - database x-example: 'GET /20160918/autonomousContainerDatabaseBackups?compartmentId=<compartmentId>&limit=10 Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/AutonomousContainerDatabaseBackup' /autonomousContainerDatabaseVersions: get: description: Gets a list of supported Autonomous Container Database versions. operationId: ListAutonomousContainerDatabaseVersions parameters: - $ref: '#/components/parameters/CompartmentId' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ServiceComponentQueryParam' responses: 200: description: Supported Autonomous Container Database versions for provisioning new databases. 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/AutonomousContainerDatabaseVersionSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets a list of supported Autonomous Container Database versions. tags: - database x-example: 'GET /20220914/autonomousContainerDatabaseVersions?compartmentId=<compartmentId>&serviceComponent=<serviceComponent>&limit=100 Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-obmcs-authz-declarations: authorizationRequired: false /autonomousContainerDatabases: get: description: 'Gets a list of the Autonomous Container Databases in the specified compartment. ' operationId: ListAutonomousContainerDatabases parameters: - $ref: '#/components/parameters/CompartmentId' - $ref: '#/components/parameters/optionalAutonomousExadataInfrastructureIdQueryParam' - $ref: '#/components/parameters/OptionalAutonomousVmClusterIdQueryParam' - $ref: '#/components/parameters/ListAutonomousContainerDatabasesFilterByInfrastructureTypeQueryParam' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' - $ref: '#/components/parameters/ListAutonomousContainerDatabasesSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ListAutonomousContainerDatabasesFilterByLifecycleStateQueryParam' - $ref: '#/components/parameters/FilterByAvailabilityDomainQueryParam' - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' - $ref: '#/components/parameters/FilterByServiceLevelAgreementTypeQueryParam' - $ref: '#/components/parameters/OptionalCloudAutonomousVmClusterIdQueryParam' responses: 200: description: A list of all of the Autonomous Container Databases in the specified compartment. 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/AutonomousContainerDatabaseSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListAutonomousContainerDatabases tags: - database x-example: 'GET /20160918/autonomousContainerDatabases?compartmentId=<compartmentId>&limit=10 Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/AutonomousContainerDatabase' post: description: 'Creates an Autonomous Container Database in the specified Autonomous Exadata Infrastructure. ' operationId: CreateAutonomousContainerDatabase parameters: - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The request was successfully received and the creation of the Autonomous Container Database is in progress. 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 must contact Oracle about a particular request, then provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AutonomousContainerDatabase' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateAutonomousContainerDatabase tags: - database x-example: "Example I (ADB on Dedicated Infra):\n POST /20160918/autonomousContainerDatabases\n Host: database.us-phoenix-1.oraclecloud.com\n <authorization and other headers>\n {\n \"maintenanceWindowDetails\":{\n \"daysOfWeek\":[\n {\n \"name\":\"SUNDAY\"\n },\n {\n \"name\":\"SATURDAY\"\n }\n ],\n \"months\":[\n {\n \"name\":\"FEBRUARY\"\n },\n {\n \"name\":\"MARCH\"\n },\n {\n \"name\":\"MAY\"\n },\n {\n \"name\":\"JULY\"\n },\n {\n \"name\":\"AUGUST\"\n },\n {\n \"name\":\"SEPTEMBER\"\n },\n {\n \"name\":\"OCTOBER\"\n },\n {\n \"name\":\"NOVEMBER\"\n }\n ],\n \"preference\":\"CUSTOM_PREFERENCE\",\n \"weeksOfMonth\":[\n 1,\n 2,\n 3,\n 4\n ],\n \"hoursOfDay\":[\n 0,\n 20\n ]\n },\n \"serviceLevelAgreementType\":\"AUTONOMOUS_DATAGUARD\",\n \"compartmentId\":\"ocid1.tenancy.oc1..<unique_ID>\",\n \"displayName\":\"containerDatabase2\",\n \"patchModel\":\"RELEASE_UPDATES\",\n \"backupConfig\":{\n \"recoveryWindowInDays\":30\n },\n \"cloudAutonomousVmClusterId\":\"ocid1.cloudautonomousvmcluster.oc1.<unique_ID>\",\n \"peerAutonomousExadataInfrastructureId\":\"ocid1.autonomousexadatainfrastructure.oc1.<unique_ID>\",\n \"protectionMode\":\"MAXIMUM_PERFORMANCE\",\n \"peerAutonomousContainerDatabaseDisplayName\":\"StandbyContainerDatabase2\",\n \"peerAutonomousContainerDatabaseCompartmentId\": \"ocid1.tenancy.oc1..<unique_ID>\",\n \"standbyMaintenanceBufferInDays\":7,\n \"versionPreference\": \"LATEST_RELEASE_UPDATE\",\n \"definedTags\":{\n },\n \"freeformTags\":{\n \"Mytagname\":\"tagValue\"\n },\n \"kmsKeyId\":\"ocid1.key.oc1.<unique_ID>\",\n \"vaultId\":\"ocid1.vault.oc1.<unique_ID>\",\n \"isFipsEnabled\":true\n }\nExample II (ADB on Cloud at Customer):\n POST /20160918/autonomousContainerDatabases\n Host: database.us-phoenix-1.oraclecloud.com\n <authorization and other headers>\n {\n \"definedTags\": {},\n \"freeformTags\": {},\n \"maintenanceWindowDetails\": {\n \"daysOfWeek\": [\n {\n \"name\": \"SUNDAY\"\n }\n ],\n \"months\": [\n {\n \"name\": \"FEBRUARY\"\n },\n {\n \"name\": \"MAY\"\n },\n {\n \"name\": \"AUGUST\"\n },\n {\n \"name\": \"JANUARY\"\n }\n ],\n \"preference\": \"CUSTOM_PREFERENCE\",\n \"weeksOfMonth\": [\n 2\n ],\n \"hoursOfDay\": [\n 0\n ]\n },\n \"autonomousVmClusterId\": \"ocid1.autonomousvmcluster.oc1.phx.<unique_ID>\",\n \"compartmentId\": \"ocid.compartment.oc1..<unique_ID>\",\n \"displayName\": \"ACD-202107131033\",\n \"backupConfig\": {\n \"backupDestinationDetails\": [\n {\n \"id\": \"ocid1.backupdestination.oc1.phx.\",\n \"type\": \"RECOVERY_APPLIANCE\",\n \"vpcUser\": \"vpcUserName\",\n \"vpcPassword\": \"<password>\",\n \"isZeroDataLossEnabled\": true\n }\n ]\n },\n \"dbUniqueName\": \"containerDatabse1\",\n \"patchModel\" : \"RELEASE_UPDATES\",\n \"peerAutonomousContainerDatabaseCompartmentId\": \"ocid1.tenancy.oc1..<unique_ID>\",\n \"peerAutonomousContainerDatabaseDisplayName\": \"Standby ACD-202107131033\",\n \"peerAutonomousVmClusterId\": \"ocid1.autonomousvmcluster.oc1.phx.<unique_ID>\",\n \"protectionMode\": \"MAXIMUM_PERFORMANCE\",\n \"serviceLevelAgreementType\": \"AUTONOMOUS_DATAGUARD\",\n \"peerAutonomousContainerDatabaseBackupConfig\": {\n \"backupDestinationDetails\": [\n {\n \"id\": \"\",\n \"type\": \"OBJECT_STORE\",\n \"internetProxy\": \"http://example.proxy.com:80\"\n }\n ],\n \"recoveryWindowInDays\": \"7\"\n },\n \"keyStoreId\": \"ocid1.dbkeystore.oc1.phx.<unique_ID>\",\n \"standbyMaintenanceBufferInDays\": 7,\n \"versionPreference\": \"LATEST_RELEASE_UPDATE\"\n }\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateAutonomousContainerDatabaseBase' description: Request to create an Autonomous Container Database in a specified Autonomous Exadata Infrastructure or in Autonomous VM Cluster. required: true /autonomousContainerDatabases/{autonomousContainerDatabaseId}: delete: description: Terminates an Autonomous Container Database, which permanently deletes the container database and any databases within the container database. The database data is local to the Autonomous Exadata Infrastructure and will be lost when the container database is terminated. Oracle recommends that you back up any data in the Autonomous Container Database prior to terminating it. operationId: TerminateAutonomousContainerDatabase parameters: - $ref: '#/components/parameters/AutonomousContainerDatabaseIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 204: description: The request to delete the Autonomous Container Database was accepted. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: TerminiateAutonomousContainerDatabase tags: - database x-example: 'DELETE /20160918/autonomousContainerDatabases/<autonomousContainerDatabaseId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/AutonomousContainerDatabase' get: description: Gets information about the specified Autonomous Container Database. operationId: GetAutonomousContainerDatabase parameters: - $ref: '#/components/parameters/AutonomousContainerDatabaseIdPathParam' responses: 200: description: The Autonomous Container Database. 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/AutonomousContainerDatabase' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetAutonomousContainerDatabase tags: - database x-example: 'GET /20160918/autonomousContainerDatabases/<autonomousContainerDatabaseId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' put: description: Updates the properties of an Autonomous Container Database, such as display name, maintenance preference, backup retention, and tags. operationId: UpdateAutonomousContainerDatabase parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/AutonomousContainerDatabaseIdPathParam' responses: 200: description: The request was successfully received and the Autonomous Container Database update is in progress. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AutonomousContainerDatabase' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdateAutonomousContainerDatabase tags: - database x-example: "PUT /latest/autonomousContainerDatabases/<autonomousContainerDatabaseId>\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\" : \"new Display name\"\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateAutonomousContainerDatabaseDetails' description: Request to update the properties of an Autonomous Container Database. required: true /autonomousContainerDatabases/{autonomousContainerDatabaseId}/actions/addStandby: post: description: 'Add a standby Autonomous Container Database. For more information about Autonomous Data Guard,see [Protect Critical Databases from Failures and Disasters Using Autonomous Data Guard](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbau/GUID-C57B9A6E-7471-4CDC-8F10-B8386538E31C). ' operationId: AddStandbyAutonomousContainerDatabase parameters: - $ref: '#/components/parameters/AutonomousContainerDatabaseIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: The request was successfully received and add standby action is being performed. 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 of the work request. schema: type: string content: application/json: schema: $ref: '#/components/schemas/AutonomousContainerDatabase' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: AddStandbyAutonomousContainerDatabase tags: - database x-example: "POST /20160918/autonomousContainerDatabases/<autonomousContainerDatabaseId>/dataguard/action/addStandby\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"role\" : \"PRIMARY<unique_ID>\"\n}\n" x-obmcs-terraform: actionType: MANAGEMENT_RESOURCE x-related-resource: '#/definitions/AutonomousContainerDatabase' requestBody: content: application/json: schema: $ref: '#/components/schemas/AddStandbyAutonomousContainerDatabaseDetails' description: Request to Add Standy Autonomous Container Database Dataguard. required: true /autonomousContainerDatabases/{autonomousContainerDatabaseId}/actions/changeCompartment: post: description: 'Move the Autonomous Container Database and its dependent resources to the specified compartment. For more information about moving Autonomous Container Databases, see [Moving Database Resources to a Different Compartment](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/raqyy/#articletitle.html). ' operationId: ChangeAutonomousContainerDatabaseCompartment parameters: - $ref: '#/components/parameters/AutonomousContainerDatabaseIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: The request was successfully received and the change compartment action is being performed. 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 of the work request. schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ChangeAutonomousContainerDatabaseCompartment tags: - database x-example: "POST /20160918/autonomousContainerDatabases/<autonomousContainerDatabaseId>/action/changeCompartment\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\" : \"ocid.compartment.oc1..<unique_ID>\"\n}\n" x-related-resource: '#/definitions/AutonomousContainerDatabase' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeCompartmentDetails' description: Request to move Autonomous Container Database to a different compartment required: true /autonomousContainerDatabases/{autonomousContainerDatabaseId}/actions/changeDataguardRole: post: description: '**Deprecated.** Use the [ConvertStandbyAutonomousContainerDatabase](#/en/database/latest/AutonomousContainerDatabase/ConvertStandbyAutonomousContainerDatabase) operation to switch the Autonomous Container Database (ACD) role between Standby and Snapshot Standby. For more information about changing ACD Role, see [Convert Physical Standby to Snapshot Standby](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbcl/index.html#ADBCL-GUID-D3B503F1-0032-4B0D-9F00-ACAE8151AB80) and [Convert Snapshot Standby to Physical Standby](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbcl/index.html#ADBCL-GUID-E8D7E0EE-8244-467D-B33A-1BC6F969A0A4). ' operationId: ChangeDataguardRole parameters: - $ref: '#/components/parameters/AutonomousContainerDatabaseIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: The request was successfully received and the dataguard role change action is being performed. 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 of the work request. schema: type: string content: application/json: schema: $ref: '#/components/schemas/AutonomousContainerDatabase' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ChangeAutonomousContainerDatabaseDatagardRole tags: - database x-example: "POST /20160918/autonomousContainerDatabases/<autonomousContainerDatabaseId>/action/changeDataguardRole\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"role\" : \"SNAPSHOT_STANDBY<unique_ID>\"\n}\n" x-related-resource: '#/definitions/AutonomousContainerDatabase' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeDataguardRoleDetails' description: Request to Change the Autonomous Container Database Dataguard role. required: true /autonomousContainerDatabases/{autonomousContainerDatabaseId}/actions/editDataguard: post: description: 'Modify Autonomous Container Database Data Guard settings such as protection mode, automatic failover, and fast start failover lag limit. For more information, see [Update Autonomous Container Database Dataguard](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbcl/index.html#ADBCL-GUID-3A936EC7-7A49-4FD2-9F39-8DB6B22011CE). ' operationId: EditAutonomousContainerDatabaseDataguard parameters: - $ref: '#/components/parameters/AutonomousContainerDatabaseIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: The request was successfully received and convert standby action is being performed. 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 of the work request. schema: type: string content: application/json: schema: $ref: '#/components/schemas/AutonomousContainerDatabase' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: EditAutonomousContainerDatabaseDataguard tags: - database x-example: "POST /20160918/autonomousContainerDatabases/<autonomousContainerDatabaseId>/dataguard/actions/updateDataguard\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"role\" : \"PRIMARY<unique_ID>\"\n}\n" x-obmcs-terraform: actionType: UPDATE_FIELD x-related-resource: '#/definitions/AutonomousContainerDatabase' requestBody: content: application/json: schema: $ref: '#/components/schemas/EditAutonomousContainerDatabaseDataguardDetails' description: Request Edit Autonomous Container Database Dataguard. required: true /autonomousContainerDatabases/{autonomousContainerDatabaseId}/actions/failover: post: description: "Performs failover to a standby Autonomous Container Database (ACD) identified by the autonomousContainerDatabaseId parameter. This standby ACD will become the new primary ACD when the failover completes successfully. For more information, see\n[Fail Over to the Standby in an Autonomous Data Guard Configuration](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbcl/index.html#ADBCL-GUID-C8FFA343-223C-4F41-9656-AEC356AD90A0). \n" operationId: FailoverAutonomousContainerDatabaseDataguard parameters: - $ref: '#/components/parameters/AutonomousContainerDatabaseIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OptionalRequestId' responses: 202: description: The request was accepted for processing. 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 must contact Oracle about a particular request, then provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AutonomousContainerDatabase' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Failover Autonomous Container Database of an Primary Autonomous Data Guard into a standby role. tags: - database x-example: 'POST /20160918/autonomousContainerDatabases/<autonomousContainerDatabaseId>/actions/failover Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/AutonomousContainerDatabase' /autonomousContainerDatabases/{autonomousContainerDatabaseId}/actions/reinstate: post: description: 'Reinstates a disabled standby Autonomous Container Database (ACD), identified by the autonomousContainerDatabaseId parameter to an active standby ACD. For more information, see [Reinstate the Disabled Standby in an Autonomous Data Guard Configuration](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbcl/index.html#ADBCL-GUID-B5C6A90D-72E3-4F32-988D-8AECC0A2D947). ' operationId: ReinstateAutonomousContainerDatabaseDataguard parameters: - $ref: '#/components/parameters/AutonomousContainerDatabaseIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OptionalRequestId' responses: 202: description: The request was accepted for processing. 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 must contact Oracle about a particular request, then provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AutonomousContainerDatabase' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Reinstates the primary Autonomous Container Database of an Autonomous Data Guard Association into a standby role. tags: - database x-example: 'POST /20160918/autonomousContainerDatabases/<autonomousContainerDatabaseId>/actions/reinstate Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/AutonomousContainerDatabase' /autonomousContainerDatabases/{autonomousContainerDatabaseId}/actions/restart: post: description: 'Rolling restarts the specified Autonomous Container Database. ' operationId: RestartAutonomousContainerDatabase parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/AutonomousContainerDatabaseIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: The request was successfully received and the Autonomous Container Database will be restarted. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AutonomousContainerDatabase' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Rolling restarts the specified Autonomous Container Database. tags: - database x-example: 'POST /20160918/autonomousContainerDatabases/<autonomousContainerDatabaseId>/actions/restart Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/AutonomousContainerDatabase' requestBody: content: application/json: schema: $ref: '#/components/schemas/RestartAutonomousContainerDatabaseDetails' description: Request details to restart the Autonomous Container Database with force option. /autonomousContainerDatabases/{autonomousContainerDatabaseId}/actions/rotateKey: post: description: Creates a new version of an existing [Vault service](/iaas/Content/KeyManagement/Concepts/keyoverview.htm) key. operationId: RotateAutonomousContainerDatabaseEncryptionKey parameters: - $ref: '#/components/parameters/AutonomousContainerDatabaseIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' responses: 202: description: 'The request was successfully received and the key is being rotated. ' 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AutonomousContainerDatabase' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Rotate Key tags: - database x-example: 'POST /20160918/autonomousContainerDatabases/<autonomousContainerDatabaseId>/actions/rotateKey Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/AutonomousContainerDatabase' requestBody: content: application/json: schema: $ref: '#/components/schemas/RotateAutonomousContainerDatabaseEncryptionKeyDetails' description: Key details provided by the user for rotate key operation for Autonomous AI Database. /autonomousContainerDatabases/{autonomousContainerDatabaseId}/actions/snapshotStandby: post: description: 'Convert the standby Autonomous Container Database (ACD) between physical standby and snapshot standby ACD. For more information about converting standby ACDs, see [Convert Physical Standby to Snapshot Standby](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbcl/index.html#ADBCL-GUID-D3B503F1-0032-4B0D-9F00-ACAE8151AB80) and [Convert Snapshot Standby to Physical Standby](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbcl/index.html#ADBCL-GUID-E8D7E0EE-8244-467D-B33A-1BC6F969A0A4). ' operationId: ConvertStandbyAutonomousContainerDatabase parameters: - $ref: '#/components/parameters/AutonomousContainerDatabaseIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: The request was successfully received and convert standby action is being performed. 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 of the work request. schema: type: string content: application/json: schema: $ref: '#/components/schemas/AutonomousContainerDatabase' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ConvertStandbyAutonomousContainerDatabase tags: - database x-example: "POST /20160918/autonomousContainerDatabases/<autonomousContainerDatabaseId>/dataguard/actions/snapshotStandby\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"role\" : \"STANDBY<unique_ID>\"\n}\n" x-obmcs-terraform: actionType: MANAGEMENT_RESOURCE x-related-resource: '#/definitions/AutonomousContainerDatabase' requestBody: content: application/json: schema: $ref: '#/components/schemas/ConvertStandbyAutonomousContainerDatabaseDetails' description: Request to Convert Standby Autonomous Container Database . required: true /autonomousContainerDatabases/{autonomousContainerDatabaseId}/actions/switchover: post: description: "Switchover an Autonomous Container Database (ACD), identified by the autonomousContainerDatabaseId parameter, to an active standby ACD. This standby ACD will become the new primary ACD when the switchover completes successfully. For more information, see\n[Switch Roles in an Autonomous Data Guard Configuration](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbcl/index.html#ADBCL-GUID-A2AB31F6-D52D-493C-9BA7-D87A0F17078F). \n" operationId: SwitchoverAutonomousContainerDatabaseDataguard parameters: - $ref: '#/components/parameters/AutonomousContainerDatabaseIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OptionalRequestId' responses: 202: description: The request was accepted for processing. 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 must contact Oracle about a particular request, then provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AutonomousContainerDatabase' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Switchover Autonomous Container Database between Primary and Standby Autonomous Container Database. tags: - database x-example: 'POST /20160918/autonomousContainerDatabases/<autonomousContainerDatabaseId>/actions/switchover Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/AutonomousContainerDatabase' /autonomousContainerDatabases/{autonomousContainerDatabaseId}/autonomousContainerDatabaseDataguardAssociations: get: description: '**Deprecated.** Use the [ListAutonomousContainerDatabases](#/en/database/latest/AutonomousContainerDatabase/ListAutonomousContainerDatabases) operation to get a list of the Autonomous Container Databases (ACDs)with Autonomous Data Guard-enabled associated with the specified ACD. ' operationId: ListAutonomousContainerDatabaseDataguardAssociations parameters: - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' - $ref: '#/components/parameters/AutonomousContainerDatabaseIdPathParam' responses: 200: description: All the Autonomous Container Databases enabled with Autonomous Data Guard associated with the specified Autonomous Container Database. 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/AutonomousContainerDatabaseDataguardAssociation' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListAutonomousContainerDatabaseDataguardAssociations tags: - database x-example: 'GET /20160918/autonomousContainerDatabases/<autonomousContainerDatabaseId>/autonomousContainerDatabaseDataguardAssociations?limit=10 Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/AutonomousContainerDatabaseDataguardAssociation' post: description: "**Deprecated.** Use the [AddStandbyAutonomousContainerDatabase](#/en/database/latest/AutonomousContainerDatabase/AddStandbyAutonomousContainerDatabase) operation to create a new Autonomous Data Guard association. An Autonomous Data Guard association represents the replication relationship between the\nspecified Autonomous Container database and a peer Autonomous Container database. For more information, see [Using Oracle Data Guard](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbau/#articletitle.html). \n" operationId: CreateAutonomousContainerDatabaseDataguardAssociation parameters: - $ref: '#/components/parameters/AutonomousContainerDatabaseIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The request was accepted for processing. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AutonomousContainerDatabaseDataguardAssociation' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Create a Autonomous Data Guard association. tags: - database x-example: "POST /20160918/autonomousContainerDatabases/<autonomousContainerDatabaseId>/autonomousContainerDatabaseDataguardAssociations\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"protectionMode\" : \"MAXIMUM_PERFORMANCE\"\n \"peerAutonomousContainerDatabaseDisplayName\" : \"STANDBY_ACD\",\n \"peerCloudAutonomousVmClusterId\" : \"ocid1.cloudautonomousvmcluster.oc1.\"\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateAutonomousContainerDatabaseDataguardAssociationDetails' description: A request to create an Autonomous Data Guard association. required: true ? /autonomousContainerDatabases/{autonomousContainerDatabaseId}/autonomousContainerDatabaseDataguardAssociations/{autonomousContainerDatabaseDataguardAssociationId} : get: description: '**Deprecated.** Use the [GetAutonomousContainerDatabase](#/en/database/latest/AutonomousContainerDatabase/GetAutonomousContainerDatabase) operation to get the details of an Autonomous Container Database (ACD) enabled with Autonomous Data Guard associated with the specified ACD. ' operationId: GetAutonomousContainerDatabaseDataguardAssociation parameters: - $ref: '#/components/parameters/AutonomousContainerDatabaseIdPathParam' - $ref: '#/components/parameters/AutonomousContainerDatabaseDataguardAssociationIdPathParam' responses: 200: description: The Autonomous Container Database with Autonomous Data Guard enabled association information for the specified Autonomous Data Guard association OCID. 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 must contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AutonomousContainerDatabaseDataguardAssociation' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetAutonomousContainerDatabaseDataguardAssociation tags: - database x-example: 'GET /20160918/autonomousContainerDatabases/<autonomousContainerDatabaseId>/autonomousContainerDatabaseDataguardAssociations/<autonomousContainerDatabaseDataguardAssociationId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/AutonomousContainerDatabaseDataguardAssociation' put: description: '**Deprecated.** Use the [EditAutonomousContainerDatabaseDataguard](#/en/database/latest/AutonomousContainerDatabase/EditAutonomousContainerDatabaseDataguard) operation to update an Autonomous Data Guard association. ' operationId: UpdateAutonomousContainerDatabaseDataguardAssociation parameters: - $ref: '#/components/parameters/AutonomousContainerDatabaseIdPathParam' - $ref: '#/components/parameters/AutonomousContainerDatabaseDataguardAssociationIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: The request was accepted for processing. 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 must contact Oracle about a particular request, then provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AutonomousContainerDatabaseDataguardAssociation' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdateAutonomousContainerDatabaseDataguardAssociation tags: - database x-example: 'PUT /20160918/autonomousContainerDatabases/<autonomousContainerDatabaseId>/autonomousContainerDatabaseDataguardAssociation/<autonomousContainerDatabaseDataguardAssociationIdactions>/update Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/AutonomousContainerDatabaseDataguardAssociation' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateAutonomousContainerDatabaseDataGuardAssociationDetails' description: A request to update Data Guard association of a database. required: true ? /autonomousContainerDatabases/{autonomousContainerDatabaseId}/autonomousContainerDatabaseDataguardAssociations/{autonomousContainerDatabaseDataguardAssociationId}/actions/failover : post: description: '**Deprecated.** Use the [FailoverAutonomousContainerDatabaseDataguard](#/en/database/latest/AutonomousContainerDatabase/FailoverAutonomousContainerDatabaseDataguard) operation to fail over the standby Autonomous Container Database (ACD) to the primary ACD after the existing primary ACD fails or becomes unreachable. A failover can result in data loss, depending on the protection mode in effect at the time the primary Autonomous Container Database fails. ' operationId: FailoverAutonomousContainerDatabaseDataguardAssociation parameters: - $ref: '#/components/parameters/AutonomousContainerDatabaseIdPathParam' - $ref: '#/components/parameters/AutonomousContainerDatabaseDataguardAssociationIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: The request was accepted for processing. 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 must contact Oracle about a particular request, then provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AutonomousContainerDatabaseDataguardAssociation' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Fails over to a standby Autonomous Container Database to the primary Autonomous Container Database role. tags: - database x-example: 'POST /20160918/autonomousContainerDatabases/<autonomousContainerDatabaseId>/autonomousContainerDatabaseDataguardAssociations/<autonomousContainerDatabaseDataguardAssociationIdactions>/actions/failover Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/AutonomousContainerDatabaseDataguardAssociation' ? /autonomousContainerDatabases/{autonomousContainerDatabaseId}/autonomousContainerDatabaseDataguardAssociations/{autonomousContainerDatabaseDataguardAssociationId}/actions/migrate : post: description: 'Migrate Autonomous Container Database, identified by the autonomousContainerDatabaseId parameter. ' operationId: MigrateAutonomousContainerDatabaseDataguardAssociation parameters: - $ref: '#/components/parameters/AutonomousContainerDatabaseIdPathParam' - $ref: '#/components/parameters/AutonomousContainerDatabaseDataguardAssociationIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OptionalRequestId' responses: 202: description: The request was accepted for processing. 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 must contact Oracle about a particular request, then provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AutonomousContainerDatabaseDataguardAssociation' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Migrate the primary Autonomous Container Database of an Autonomous Data Guard Association into a standby role. tags: - database x-example: 'POST /20160918/autonomousContainerDatabases/<autonomousContainerDatabaseId>/autonomousContainerDatabaseDataguardAssociation/<autonomousContainerDatabaseDataguardAssociationIdactions>/actions/reinstate Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/AutonomousContainerDatabaseDataguardAssociation' ? /autonomousContainerDatabases/{autonomousContainerDatabaseId}/autonomousContainerDatabaseDataguardAssociations/{autonomousContainerDatabaseDataguardAssociationId}/actions/reinstate : post: description: '**Deprecated.** Use the [ReinstateAutonomousContainerDatabaseDataguard](#/en/database/latest/AutonomousContainerDatabase/ReinstateAutonomousContainerDatabaseDataguard) operation to reinstate a disabled standby Autonomous Container Database (ACD), identified by the autonomousContainerDatabaseId parameter, to an active standby ACD. ' operationId: ReinstateAutonomousContainerDatabaseDataguardAssociation parameters: - $ref: '#/components/parameters/AutonomousContainerDatabaseIdPathParam' - $ref: '#/components/parameters/AutonomousContainerDatabaseDataguardAssociationIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: The request was accepted for processing. 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 must contact Oracle about a particular request, then provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AutonomousContainerDatabaseDataguardAssociation' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Reinstates the primary Autonomous Container Database of an Autonomous Data Guard Association into a standby role. tags: - database x-example: 'POST /20160918/autonomousContainerDatabases/<autonomousContainerDatabaseId>/autonomousContainerDatabaseDataguardAssociation/<autonomousContainerDatabaseDataguardAssociationIdactions>/actions/reinstate Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/AutonomousContainerDatabaseDataguardAssociation' ? /autonomousContainerDatabases/{autonomousContainerDatabaseId}/autonomousContainerDatabaseDataguardAssociations/{autonomousContainerDatabaseDataguardAssociationId}/actions/switchover : post: description: '**Deprecated.** Use the [SwitchoverAutonomousContainerDatabaseDataguard](#/en/database/latest/AutonomousContainerDatabase/SwitchoverAutonomousContainerDatabaseDataguard) operation to switches over the primary Autonomous Container Database (ACD) of an Autonomous Data Guard peer association to standby role. The standby ACD associated with autonomousContainerDatabaseDataguardAssociationId assumes the primary ACD role. A switchover incurs no data loss. ' operationId: SwitchoverAutonomousContainerDatabaseDataguardAssociation parameters: - $ref: '#/components/parameters/AutonomousContainerDatabaseIdPathParam' - $ref: '#/components/parameters/AutonomousContainerDatabaseDataguardAssociationIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: The request was accepted for processing. 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 must contact Oracle about a particular request, then provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AutonomousContainerDatabaseDataguardAssociation' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Switches the primary Autonomous Container Database of an Autonomous Data Guard association to standby role. tags: - database x-example: 'POST /20160918/autonomousContainerDatabases/<autonomousContainerDatabaseId>/autonomousContainerDatabaseDataguardAssociation/<autonomousContainerDatabaseDataguardAssociationIdactions>/actions/switchover Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/AutonomousContainerDatabaseDataguardAssociation' /autonomousContainerDatabases/{autonomousContainerDatabaseId}/patches: get: description: 'Lists the patches applicable to the requested container database. ' operationId: ListContainerDatabasePatches parameters: - $ref: '#/components/parameters/AutonomousContainerDatabaseIdPathParam' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' - $ref: '#/components/parameters/CompartmentId' - $ref: '#/components/parameters/AutonomousPatchTypeQueryParam' responses: 200: description: A list of the patch packages. 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/AutonomousPatchSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListContainerDatabasePatches tags: - database x-example: 'GET /20160918/autonomousContainerDatabases/<autonomousContainerDatabaseId>/patches?limit=10 Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/AutonomousPatch' /autonomousContainerDatabases/{autonomousContainerDatabaseId}/resourceUsage: get: description: 'Get resource usage details for the specified Autonomous Container Database. ' operationId: GetAutonomousContainerDatabaseResourceUsage parameters: - $ref: '#/components/parameters/AutonomousContainerDatabaseIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: Get the Autonomous Container Database resource usage details. 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/AutonomousContainerDatabaseResourceUsage' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetAutonomousContainerDatabaseResourceUsage tags: - database x-example: 'GET /20160918/autonomousContainerDatabases/<autonomousContainerDatabaseId>/resourceUsage Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/AutonomousContainerDatabase' /autonomousDatabaseBackups: get: description: 'Gets a list of Autonomous AI Database backups based on either the `autonomousDatabaseId` or `compartmentId` specified as a query parameter. ' operationId: ListAutonomousDatabaseBackups parameters: - $ref: '#/components/parameters/optionalautonomousDatabaseIdQueryParam' - $ref: '#/components/parameters/OptionalCompartmentIdQueryParam' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' - $ref: '#/components/parameters/listAutonomousDatabaseBackupsSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/listAutonomousDatabaseBackupsFilterByLifecycleStateQueryParam' - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' - $ref: '#/components/parameters/FilterByBackupTypeQueryParam' - $ref: '#/components/parameters/FilterByBackupDestinationIdQueryParam' - $ref: '#/components/parameters/FilterByKeyStoreIdQueryParam' - $ref: '#/components/parameters/FilterByInfrastructureTypeQueryParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: A list of Autonomous AI Database 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/AutonomousDatabaseBackupSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets a list of Autonomous AI Database backups. tags: - database x-example: 'GET /20160918/autonomousDatabaseBackups?autonomousDatabaseId=<autonomousDatabaseId>&limit=10 Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/AutonomousDatabaseBackup' post: description: 'Creates a new Autonomous AI Database backup for the specified database based on the provided request parameters. ' operationId: CreateAutonomousDatabaseBackup parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: The request was successfully received and the Autonomous AI Database backup operation is in progress. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AutonomousDatabaseBackup' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Creates a new Autonomous AI Database backup for the specified database. tags: - database x-example: "POST /20160918/autonomousDatabaseBackups\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"autonomousDatabaseId\" : \"ocid1.autonomousdatabase.oc1.phx.<unique_ID>\",\n \"displayName\" : \"Monthly Backup\"\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateAutonomousDatabaseBackupDetails' description: Request to create a new Autonomous AI Database backup. required: true /autonomousDatabaseBackups/{autonomousDatabaseBackupId}: delete: description: Deletes a long-term backup. You cannot delete other backups using this API. operationId: DeleteAutonomousDatabaseBackup parameters: - $ref: '#/components/parameters/autonomousDatabaseBackupIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OptionalRequestId' responses: 204: description: The request to delete the backup was accepted. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: DeleteAutonomousDatabaseBackup tags: - database x-example: 'DELETE /20160918/autonomousDatabaseBackups/<autonomousDatabaseBackupId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/AutonomousDatabaseBackup' get: description: Gets information about the specified Autonomous AI Database backup. operationId: GetAutonomousDatabaseBackup parameters: - $ref: '#/components/parameters/autonomousDatabaseBackupIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: The Autonomous AI Database 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/AutonomousDatabaseBackup' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets information about the specified Autonomous AI Database backup. tags: - database x-example: 'GET /20160918/autonomousDatabaseBackups/<autonomousDatabaseBackupId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/AutonomousDatabaseBackup' put: description: 'Updates the Autonomous AI Database backup of the specified database based on the request parameters. ' operationId: UpdateAutonomousDatabaseBackup parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/autonomousDatabaseBackupIdPathParam' responses: 202: description: The backup update request was received and is being performed on the backup schema. 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, provide the request ID. ' schema: type: string opc-work-request-id: description: Unique Oracle-assigned identifier for the work request. schema: type: string content: application/json: schema: $ref: '#/components/schemas/AutonomousDatabaseBackup' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Updates an existing Autonomous AI Database backup of the specified database. tags: - database x-example: "PUT /20160918/autonomousDatabaseBackups/<autonomousDatabaseBackupId>\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"retentionPeriodInDays\" : 365\n}\n" x-related-resource: '#/definitions/AutonomousDatabaseBackup' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateAutonomousDatabaseBackupDetails' description: Request to update an existing Autonomous AI Database backup. required: true /autonomousDatabaseCharacterSets: get: description: Gets a list of supported character sets. operationId: ListAutonomousDatabaseCharacterSets parameters: - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/isSharedQueryParam' - $ref: '#/components/parameters/isDedicatedQueryParam' - $ref: '#/components/parameters/characterSetTypeQueryParam' responses: 200: description: Supported Oracle Autonomous AI Database character sets. 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/AutonomousDatabaseCharacterSets' type: array default: $ref: '#/components/responses/DefaultError' summary: ListAutonomousDatabaseCharacterSets tags: - database x-example: 'GET /20160918/autonomousDatabaseCharacterSets? Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-obmcs-authz-declarations: authorizationRequired: false x-related-resource: '#/definitions/AutonomousDatabaseCharacterSets' /autonomousDatabaseSoftwareImages: get: description: 'Gets a list of the Autonomous AI Database Software Images in the specified compartment. ' operationId: ListAutonomousDatabaseSoftwareImages parameters: - $ref: '#/components/parameters/CompartmentId' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ListAutonomousDatabaseSoftwareImagesSortByQueryParam' - $ref: '#/components/parameters/ListAutonomousDatabaseSoftwareImagesFilterByLifecycleStateQueryParam' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' - $ref: '#/components/parameters/ListAutonomousDatabaseSoftwareImagesFilterByImageShapeFamilyQueryParam' responses: 200: description: Retrieved the list of all the Autonomous AI Database Software Images. 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/AutonomousDatabaseSoftwareImageCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListAutonomousDatabaseSoftwareImages tags: - database x-example: "Example I:\n GET /20160918/autonomousDatabaseSoftwareImages?compartmentId=<compartmentId>&limit=10\n Host: database.us-phoenix-1.oraclecloud.com\n <authorization and other headers>\n" x-related-resource: '#/definitions/AutonomousDatabaseSoftwareImage' post: description: 'create Autonomous AI Database Software Image in the specified compartment. ' operationId: CreateAutonomousDatabaseSoftwareImage parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: The request was successfully received and the Autonomous AI Database Software Image creation is in progress. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AutonomousDatabaseSoftwareImage' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateAutonomousDatabaseSoftwareImage tags: - database x-example: "Example I:\n POST /20160918/autonomousDatabaseSoftwareImages\n Host: database.us-phoenix-1.oraclecloud.com\n <authorization and other headers>\n {\n \"compartmentId\" : \"ocid1.tenancy.oc1..<unique_ID>\",\n \"displayName\" : \"image1\"\n \"sourceCdbId\" : \"ocid1.autonomouscontainerdatabase.oc1.phx.\"\n }\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateAutonomousDatabaseSoftwareImageDetails' description: Request to create Autonomous AI Database Software Image. required: true /autonomousDatabaseSoftwareImages/{autonomousDatabaseSoftwareImageId}: delete: description: Delete an Autonomous AI Database Software Image operationId: DeleteAutonomousDatabaseSoftwareImage parameters: - $ref: '#/components/parameters/AutonomousDatabaseSoftwareImageIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OptionalRequestId' responses: 204: description: The request to delete Autonomous AI Database Software Image was accepted. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: DeleteAutonomousDatabaseSoftwareImage tags: - database x-example: 'DELETE /20160918/autonomousDatabaseSoftwareImages/<autonomousDatabaseSoftwareImageId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/AutonomousDatabaseSoftwareImage' get: description: Gets information about the specified Autonomous AI Database Software Image. operationId: GetAutonomousDatabaseSoftwareImage parameters: - $ref: '#/components/parameters/AutonomousDatabaseSoftwareImageIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: The Autonomous AI Database Software Image. 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/AutonomousDatabaseSoftwareImage' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetAutonomousDatabaseSoftwareImage tags: - database x-example: 'GET /20160918/autonomousDatabaseSoftwareImages/<autonomousDatabaseSoftwareImageId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' put: description: Updates the properties of an Autonomous AI Database Software Image, like add tags operationId: UpdateAutonomousDatabaseSoftwareImage parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/AutonomousDatabaseSoftwareImageIdPathParam' responses: 200: description: The Autonomous AI Database Software Image. 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/AutonomousDatabaseSoftwareImage' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdateAutonomousDatabaseSoftwareImage tags: - database x-example: "PUT /20160918/autonomousDatabaseSoftwareImages/<autonomousDatabaseSoftwareImageId>\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"freeformTags\" : {\"Department\": \"Finance\"}\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateAutonomousDatabaseSoftwareImageDetails' description: Request to update the properties of an Autonomous AI Database Software Image. required: true /autonomousDatabaseSoftwareImages/{autonomousDatabaseSoftwareImageId}/actions/changeCompartment: post: description: 'Move the Autonomous AI Database Software Image and its dependent resources to the specified compartment. ' operationId: ChangeAutonomousDatabaseSoftwareImageCompartment parameters: - $ref: '#/components/parameters/AutonomousDatabaseSoftwareImageIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: The request was successfully received and the change compartment action is being performed. 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 of the work request. schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ChangeAutonomousDatabaseSoftwareImageCompartment tags: - database x-example: "POST /20160918/autonomousDatabaseSoftwareImages/<autonomousDatabaseSoftwareImageId>/actions/changeCompartment\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\" : \"ocid.compartment.oc1..<unique_ID>\"\n}\n" x-related-resource: '#/definitions/AutonomousDatabaseSoftwareImage' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeAutonomousDatabaseSoftwareImageCompartmentDetails' description: Request to move Autonomous AI Database Software Image to a different compartment required: true /autonomousDatabases: get: description: 'Gets a list of Autonomous AI Databases based on the query parameters specified. ' operationId: ListAutonomousDatabases parameters: - $ref: '#/components/parameters/CompartmentId' - $ref: '#/components/parameters/optionalAutonomousContainerDatabaseIdQueryParam' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' - $ref: '#/components/parameters/listAutonomousDatabasesSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ListAutonomousDatabasesFilterByInfrastructureTypeQueryParam' - $ref: '#/components/parameters/listAutonomousDatabasesFilterByLifecycleStateQueryParam' - $ref: '#/components/parameters/listAutonomousDatabasesFilterByLifecycleStateNotEqualToQueryParam' - $ref: '#/components/parameters/listAutonomousDatabasesFilterByDbWorkloadQueryParam' - $ref: '#/components/parameters/listAutonomousDatabasesFilterByDbVersionQueryParam' - $ref: '#/components/parameters/isFreeTierQueryParam' - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/refreshableCloneQueryParam' - $ref: '#/components/parameters/isDataGuardEnabledQueryParam' - $ref: '#/components/parameters/isResourcePoolLeaderParam' - $ref: '#/components/parameters/resourcePoolLeaderIdParam' responses: 200: description: The list of Autonomous AI Databases was retrieved. 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/AutonomousDatabaseSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets a list of Autonomous AI Database. tags: - database x-example: 'GET /20160918/autonomousDatabases?compartmentId=<compartmentId>&limit=10 Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/AutonomousDatabase' post: description: 'Creates a new Autonomous AI Database. ' operationId: CreateAutonomousDatabase parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: The request was successfully received and a database is being provisioned. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AutonomousDatabase' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Creates a new Autonomous AI Database. tags: - database x-example: "Example I - creates a new Autonomous AI Database:\n POST /20160918/autonomousDatabases\n Host: database.us-phoenix-1.oraclecloud.com\n <authorization and other headers>\n {\n \"compartmentId\": \"ocid.compartment.oc1..<unique_ID>\",\n \"displayName\": \"example_autonomous_database\",\n \"dbName\": \"adatabasedb1\",\n \"adminPassword\": \"<password>\",\n \"computeModel\": \"ECPU\",\n \"computeCount\": 2,\n \"dataStorageSizeInTBs\": 1\n }\nExample II - creates an Autonomous AI Database by cloning an existing one:\n POST /20160918/autonomousDatabases\n Host: database.us-phoenix-1.oraclecloud.com\n <authorization and other headers>\n {\n \"compartmentId\" : \"ocid.compartment.oc1..<unique_ID>\",\n \"displayName\" : \"example_autonomous_database\",\n \"dbName\" : \"adatabasedb1\",\n \"adminPassword\" : \"<password>\",\n \"computeModel\" : \"ECPU\",\n \"computeCount\" : 2,\n \"dataStorageSizeInTBs\" : 1,\n \"source\" : \"DATABASE\",\n \"sourceId\" : \"ocid1.autonomousdatabase.oc1.phx..<unique_ID>\",\n \"cloneType\" : \"FULL\"\n }\nExample III - creates an Autonomous AI Database refreshable clone:\n POST /20160918/autonomousDatabases\n Host: database.us-phoenix-1.oraclecloud.com\n <authorization and other headers>\n {\n \"compartmentId\" : \"ocid.compartment.oc1..<unique_ID>\",\n \"displayName\" : \"example_autonomous_database_refreshable_clone\",\n \"dbName\" : \"adatabasedb1\",\n \"computeModel\" : \"ECPU\",\n \"computeCount\" : 2,\n \"source\" : \"CLONE_TO_REFRESHABLE\",\n \"sourceId\" : \"ocid1.autonomousdatabase.oc1.phx..<unique_ID>\",\n }\nExample IV - creates a standby Autonomous AI Database for a cross-region Autonomous Data Guard association:\n POST /20160918/autonomousDatabases\n Host: database.us-phoenix-1.oraclecloud.com\n <authorization and other headers>\n {\n \"compartmentId\" : \"ocid.compartment.oc1..<unique_ID>\",\n \"sourceId\" : \"ocid1.autonomousdatabase.oc1.iad..<unique_ID>\",\n \"source\" : \"CROSS_REGION_DATAGUARD\"\n }\nExample VII - Create a resourcePool while creating Autonomous AI Database:\n POST /20160918/autonomousDatabases\n Host: database.us-phoenix-1.oraclecloud.com\n <authorization and other headers>\n {\n \"compartmentId\": \"ocid.compartment.oc1..<unique_ID>\",\n \"displayName\": \"example_autonomous_database\",\n \"dbName\": \"adatabasedb1\",\n \"adminPassword\": \"<password>\",\n \"computeModel\": \"ECPU\",\n \"computeCount\": 2,\n \"dataStorageSizeInTBs\": 1\n \"resourcePoolSummary\":\n {\n \"poolSize\": 64\n }\n }\nExample VIII - Join a resourcePool while creating Autonomous AI Database:\n POST /20160918/autonomousDatabases\n Host: database.us-phoenix-1.oraclecloud.com\n <authorization and other headers>\n {\n \"compartmentId\": \"ocid.compartment.oc1..<unique_ID>\",\n \"displayName\": \"example_autonomous_database\",\n \"dbName\": \"adatabasedb1\",\n \"adminPassword\": \"<password>\",\n \"computeModel\": \"ECPU\",\n \"computeCount\": 2,\n \"dataStorageSizeInTBs\": 1\n \"resourcePoolLeaderId\": \"ocid1.autonomousdatabase.oc1.phx..<unique_ID>\"\n }\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateAutonomousDatabaseBase' description: Request to create a new Autonomous AI Database. required: true /autonomousDatabases/actions/listResourcePoolShapes: post: description: Lists available resource pools shapes. operationId: ResourcePoolShapes parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: The Autonomous AI Database collections. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/ResourcePoolShapeCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Lists resource pool shapes for Autonomous AI Database Serverless databases. tags: - database x-example: 'POST /20160918/autonomousDatabases/<autonomousDatabaseId>/actions/listResourcePoolShapes Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-obmcs-authz-declarations: authorizationRequired: false x-related-resource: '#/definitions/AutonomousDatabase' /autonomousDatabases/wallet: get: description: 'Gets the Autonomous AI Database regional wallet details. ' operationId: GetAutonomousDatabaseRegionalWallet parameters: - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: The Autonomous AI Database regional wallet details are being retrieved. 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/AutonomousDatabaseWallet' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Get the regional wallet details for Autonomous AI Databases. tags: - database x-example: 'GET /20160918/autonomousDatabases/wallet Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/AutonomousDatabaseWallet' put: description: 'Updates the Autonomous AI Database regional wallet. ' operationId: UpdateAutonomousDatabaseRegionalWallet parameters: - $ref: '#/components/parameters/OptionalRequestId' responses: 202: description: The request was successfully received and the wallet rotation is in progress. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application-json: example: "{\n \"timeWalletRotated\" : \"2019-06-23T00:59:07.032Z\"\n}\n" 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Update the regional wallet for Autonomous AI Database. tags: - database x-example: "PUT /latest/autonomousDatabases/wallet\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"gracePeriod\" : 1,\n \"shouldRotate\" : true\n}\n" x-related-resource: '#/definitions/AutonomousDatabaseWallet' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateAutonomousDatabaseWalletDetails' description: Request to update the properties of Autonomous AI Database regional wallet. required: true /autonomousDatabases/{autonomousDatabaseId}: delete: description: 'Deletes the specified Autonomous AI Database. ' operationId: DeleteAutonomousDatabase parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/autonomousDatabaseIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/mustDeleteAssociatedLongTermBackupsQueryParam' responses: 204: description: The request to delete the Autonomous AI Database was accepted. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Deletes the specified Autonomous AI Database. tags: - database x-example: 'DELETE /20160918/autonomousDatabases/<autonomousDatabaseId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/AutonomousDatabase' get: description: 'Gets the details of the specified Autonomous AI Database. ' operationId: GetAutonomousDatabase parameters: - $ref: '#/components/parameters/autonomousDatabaseIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: Get the details of the specified Autonomous AI Database. 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/AutonomousDatabase' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets the details of the specified Autonomous AI Database. tags: - database x-example: 'GET /20160918/autonomousDatabases/<autonomousDatabaseId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/AutonomousDatabase' put: description: 'Updates one or more attributes of the specified Autonomous AI Database. See the UpdateAutonomousDatabaseDetails resource for a full list of attributes that can be updated. ' operationId: UpdateAutonomousDatabase parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/autonomousDatabaseIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: The request was successfully received and the database update is in progress. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AutonomousDatabase' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Updates the specified Autonomous AI Database with new OCPU core count and size. tags: - database x-example: "PUT /latest/autonomousDatabases/<autonomousDatabaseId>\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"cpuCoreCount\" : 20,\n \"isAutoScalingForStorageEnabled\": true\n}\nExample II - Join a resourcePool through update Autonomous AI Database:\n POST /20160918/autonomousDatabases\n Host: database.us-phoenix-1.oraclecloud.com\n <authorization and other headers>\n {\n \"resourcePoolLeaderId\": \"ocid1.autonomousdatabase.oc1.phx..<unique_ID>\"\n }\nExample III - Depart from a resourcePool through update Autonomous AI Database:\n POST /20160918/autonomousDatabases\n Host: database.us-phoenix-1.oraclecloud.com\n <authorization and other headers>\n {\n \"resourcePoolLeaderId\": \"\"\n }\nExample IV - change compute size of the resource pool:\n POST /20160918/autonomousDatabases\n Host: database.us-phoenix-1.oraclecloud.com\n <authorization and other headers>\n {\n \"resourcePoolSummary\":\n {\n \"poolSize\": 64\n }\n }\n\n Example V - delete resource pool:\n POST /20160918/autonomousDatabases\n Host: database.us-phoenix-1.oraclecloud.com\n <authorization and other headers>\n {\n \"resourcePoolSummary\":\n {\n\n }\n }\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateAutonomousDatabaseDetails' description: Request to update the properties of an Autonomous AI Database. required: true /autonomousDatabases/{autonomousDatabaseId}/actions/changeCompartment: post: description: 'Move the Autonomous AI Database and its dependent resources to the specified compartment. For more information about moving Autonomous AI Databases, see [Moving Database Resources to a Different Compartment](/Content/Database/Concepts/databaseoverview.htm#moveRes). ' operationId: ChangeAutonomousDatabaseCompartment parameters: - $ref: '#/components/parameters/autonomousDatabaseIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: The request was successfully received and the change compartment action is being performed. 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 of the work request. schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ChangeAutonomousDatabaseCompartment tags: - database x-example: "POST /20160918/autonomousDatabases/<autonomousDatabaseId>/action/changeCompartment\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\" : \"ocid.compartment.oc1..<unique_ID>\"\n}\n" x-related-resource: '#/definitions/AutonomousDatabase' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeCompartmentDetails' description: Request to move Autonomous AI Database to a different compartment required: true /autonomousDatabases/{autonomousDatabaseId}/actions/changeDisasterRecoveryConfiguration: put: description: This operation updates the cross-region disaster recovery (DR) details of the standby Autonomous AI Database Serverless database, and must be run on the standby side. operationId: ChangeDisasterRecoveryConfiguration parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/autonomousDatabaseIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 202: description: The request was successfully received, and the database update is in progress. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AutonomousDatabase' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Updates the cross-region disaster recovery (DR) details of the standby Autonomous AI Database Serverless database. tags: - database x-example: "PUT /latest/autonomousDatabases/<autonomousDatabaseId>\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"disasterRecoveryType\" : \"ADG\"\n}\n" x-related-resource: '#/definitions/AutonomousDatabase' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeDisasterRecoveryConfigurationDetails' description: Request to update the cross-region disaster recovery (DR) details of the standby Autonomous AI Database Serverless database. required: true /autonomousDatabases/{autonomousDatabaseId}/actions/changeSubscription: post: description: 'Associate an Autonomous AI Database with a different subscription. ' operationId: ChangeAutonomousDatabaseSubscription parameters: - $ref: '#/components/parameters/autonomousDatabaseIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: The request was successfully received and the update subscription action is being performed. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Associate an Autonomous AI Database with a different subscription. tags: - database x-example: "POST /20160918/autonomousDatabases/<autonomousDatabaseId>/action/changeSubscription\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"subscriptionId\": \"ocid1.subscription.oc1..<unique_ID>\"\n}\n" x-related-resource: '#/definitions/AutonomousDatabase' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeAutonomousDatabaseSubscriptionDetails' description: Associate an Autonomous AI Database with a different subscription. required: true /autonomousDatabases/{autonomousDatabaseId}/actions/configureAutonomousDatabaseVaultKey: post: description: 'Configures the Autonomous AI Database Vault service [key](/Content/KeyManagement/Concepts/keyoverview.htm#concepts). ' operationId: ConfigureAutonomousDatabaseVaultKey parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/autonomousDatabaseIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: 'The request was successfully received and the Autonomous AI Database vault key was successfully configured. ' 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Configure Autonomous AI Database Vault Key. tags: - database x-example: 'POST /20160918/autonomousDatabases/<autonomousDatabaseId>/actions/configureAutonomousDatabaseVaultKey Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/AutonomousDatabase' requestBody: content: application/json: schema: $ref: '#/components/schemas/ConfigureAutonomousDatabaseVaultKeyDetails' description: Configuration details for the Autonomous AI Database Vault service [key](/Content/KeyManagement/Concepts/keyoverview.htm#concepts). required: true /autonomousDatabases/{autonomousDatabaseId}/actions/configureSaasAdminUser: post: description: This operation updates SaaS administrative user configuration of the Autonomous AI Database. operationId: ConfigureSaasAdminUser parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/autonomousDatabaseIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 202: description: Request was successfully received and this Autonomous AI Database will update SaaS administrative user configuration. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AutonomousDatabase' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Updates configuration of SaaS administrative user. tags: - database x-example: "POST /20160918/autonomousDatabases/<autonomousDatabaseId>/actions/configureSaasAdminUser\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"isEnabled\": \"true\",\n \"password\": \"mockPassword\"\n}\n" x-related-resource: '#/definitions/AutonomousDatabase' requestBody: content: application/json: schema: $ref: '#/components/schemas/ConfigureSaasAdminUserDetails' description: Request to update SaaS administrative user configuration of the Autonomous AI Database. required: true /autonomousDatabases/{autonomousDatabaseId}/actions/deregisterDataSafe: post: description: 'Asynchronously deregisters this Autonomous AI Database with Data Safe. ' operationId: DeregisterAutonomousDatabaseDataSafe parameters: - $ref: '#/components/parameters/autonomousDatabaseIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 202: description: 'Request was successfully received and this Autonomous AI Database will be deregistered with Data Safe. ' 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Asynchronously deregisters Data Safe for this Autonomous AI Database. tags: - database x-example: 'POST /20160918/autonomousDatabases/<autonomousDatabaseId>/actions/deregisterDataSafe Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> { "pdbAdminPassword":<password>", } ' x-related-resource: '#/definitions/AutonomousDatabase' requestBody: content: application/json: schema: $ref: '#/components/schemas/DeregisterAutonomousDatabaseDataSafeDetails' description: Details for deregistering an Autonomous AI Database with Data Safe. /autonomousDatabases/{autonomousDatabaseId}/actions/disableDatabaseManagement: post: description: 'Disables Database Management for the Autonomous AI Database resource. ' operationId: DisableAutonomousDatabaseManagement parameters: - $ref: '#/components/parameters/autonomousDatabaseIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 202: description: 'Request successfully received and Database Management will be disabled for this Autonomous AI Database. ' headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Disables DatabaseManagement for the Autonomous AI Database resource. tags: - database x-example: 'POST /20160918/autonomousDatabases/<autonomousDatabaseId>/actions/disableDatabaseManagement Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/AutonomousDatabase' /autonomousDatabases/{autonomousDatabaseId}/actions/disableOperationsInsights: post: description: 'Disables Operations Insights for the Autonomous AI Database resource. ' operationId: DisableAutonomousDatabaseOperationsInsights parameters: - $ref: '#/components/parameters/autonomousDatabaseIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 202: description: 'Request successfully received and Operations is disabled for this Autonomous AI Database. ' headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Disables Operations Insights for the Autonomous AI Database resource. tags: - database x-example: 'POST /20160918/autonomousDatabases/<autonomousDatabaseId>/actions/disableOperationsInsights Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/AutonomousDatabase' /autonomousDatabases/{autonomousDatabaseId}/actions/enableDatabaseManagement: post: description: 'Enables Database Management for Autonomous AI Database. ' operationId: EnableAutonomousDatabaseManagement parameters: - $ref: '#/components/parameters/autonomousDatabaseIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 202: description: 'Request was successfully received and this Autonomous AI Database will enable Database Management. ' 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Enables Database Management for Autonomous AI Database. tags: - database x-example: 'POST /20160918/autonomousDatabases/<autonomousDatabaseId>/actions/enableDatabaseManagement Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/AutonomousDatabase' /autonomousDatabases/{autonomousDatabaseId}/actions/enableOperationsInsights: post: description: 'Enables the specified Autonomous AI Database with Operations Insights. ' operationId: EnableAutonomousDatabaseOperationsInsights parameters: - $ref: '#/components/parameters/autonomousDatabaseIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 202: description: 'Request was successfully received and this Autonomous AI Database will enable Operations Insights. ' 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Enables the specified Autonomous AI Database with Operations Insights. tags: - database x-example: 'POST /20160918/autonomousDatabases/<autonomousDatabaseId>/actions/enableOperationsInsights Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/AutonomousDatabase' /autonomousDatabases/{autonomousDatabaseId}/actions/failover: post: description: "Initiates a failover of the specified Autonomous AI Database to the associated peer database. Applicable only to databases with Disaster Recovery enabled.\nThis API should be called in the remote region where the peer database resides.\nBelow parameter is optional:\n - `peerDbId`\n Use this parameter to specify the database OCID of the Disaster Recovery peer, which is located in a different (remote) region from the current peer database.\n If this parameter is not provided, the failover will happen in the same region.\n" operationId: FailOverAutonomousDatabase parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/autonomousDatabaseIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/OptionalPeerAutonomousDatabaseIdQueryParam' responses: 200: description: The request was successfully received and the Autonomous AI Database will fail over. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AutonomousDatabase' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Fails over AutonomousDatabase to a Standby. tags: - database x-example: "Example I - Local Failover:\n POST /20160918/autonomousDatabases/ocid1.autonomousdatabase.oc1.phx..<unique_ID>/actions/failover\n Host: database.us-phoenix-1.oraclecloud.com\n <authorization and other headers>\nExample II - Cross-Region Failover:\n POST /20160918/autonomousDatabases/ocid1.autonomousdatabase.oc1.phx..<unique_ID>/actions/failover\n Host: database.us-ashburn-1.oraclecloud.com\n <authorization and other headers>\n {\n \"peerDbId\": \"ocid1.autonomousdatabase.oc1.iad..<unique_ID>\"\n }\n" x-related-resource: '#/definitions/AutonomousDatabase' /autonomousDatabases/{autonomousDatabaseId}/actions/generateWallet: post: description: 'Creates and downloads a wallet for the specified Autonomous AI Database. ' operationId: GenerateAutonomousDatabaseWallet parameters: - $ref: '#/components/parameters/autonomousDatabaseIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: A wallet for the specified Autonomous AI Database is being retrieved. headers: content-length: description: Size of the file. schema: type: integer format: int64 etag: description: For optimistic concurrency control. See `if-match`. schema: type: string last-modified: description: The date and time the wallet was created, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. schema: type: string format: date-time 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/octet-stream: schema: format: binary type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Creates and downloads a wallet for the specified Autonomous AI Database. tags: - database x-example: 'POST /20160918/autonomousDatabases/<autonomousDatabaseId>/generateWallet Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/AutonomousDatabase' requestBody: content: application/json: schema: $ref: '#/components/schemas/GenerateAutonomousDatabaseWalletDetails' description: Request to create a new Autonomous AI Database wallet. required: true /autonomousDatabases/{autonomousDatabaseId}/actions/getSaasAdminUserStatus: post: description: This operation gets SaaS administrative user status of the Autonomous AI Database. operationId: SaasAdminUserStatus parameters: - $ref: '#/components/parameters/autonomousDatabaseIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: SaaS administrative user status. 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/SaasAdminUserStatus' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets status of SaaS administrative user. tags: - database x-example: 'POST /20160918/autonomousDatabases/<autonomousDatabaseId>/actions/getSaasAdminUserStatus Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/AutonomousDatabase' /autonomousDatabases/{autonomousDatabaseId}/actions/importTransportableTablespace: post: description: 'Imports transportable tablespace for the specified Autonomous AI Database. ' operationId: ImportTransportableTablespace parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/autonomousDatabaseIdPathParam' responses: 202: description: Request received successfully. Import transportable tablespace for the Autonomous AI Database is in progress. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AutonomousDatabase' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Imports transportable tablespace for the specified Autonomous AI Database. tags: - database x-example: "POST /20160918/autonomousDatabases/<autonomousDatabaseId>/actions/importTransportTablespace\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"ttsBundleUrl\" : \"https://swiftobjectstorage..oraclecloud.com/v1///tts_bundle.tgz\"\n}\n" x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/AutonomousDatabase' requestBody: content: application/json: schema: $ref: '#/components/schemas/ImportTransportableTablespaceDetails' description: Details for importing transportable tablespace for the Autonomous AI Database. required: true /autonomousDatabases/{autonomousDatabaseId}/actions/refresh: post: description: 'Initiates a data refresh for an Autonomous AI Database refreshable clone. Data is refreshed from the source database to the point of a specified timestamp. ' operationId: AutonomousDatabaseManualRefresh parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/autonomousDatabaseIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: The request was successfully received and the refresh operation for the Autonomous AI Database refreshable clone is in progress. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AutonomousDatabase' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Refresh an Autonomous AI Database refreshable clone. tags: - database x-example: 'POST /20160918/autonomousDatabases/<autonomousDatabaseId>/actions/refresh Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/AutonomousDatabase' requestBody: content: application/json: schema: $ref: '#/components/schemas/AutonomousDatabaseManualRefreshDetails' description: Request details for manually refreshing an Autonomous AI Database refreshable clone. required: true /autonomousDatabases/{autonomousDatabaseId}/actions/registerDataSafe: post: description: 'Asynchronously registers this Autonomous AI Database with Data Safe. ' operationId: RegisterAutonomousDatabaseDataSafe parameters: - $ref: '#/components/parameters/autonomousDatabaseIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 202: description: 'Request was successfully received and this Autonomous AI Database is being registered with Data Safe. ' 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Asynchronously registers this Autonomous AI Database with Data Safe. tags: - database x-example: 'POST /20160918/autonomousDatabases/<autonomousDatabaseId>/actions/registerDataSafe Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> { "pdbAdminPassword":<password>", } ' x-related-resource: '#/definitions/AutonomousDatabase' requestBody: content: application/json: schema: $ref: '#/components/schemas/RegisterAutonomousDatabaseDataSafeDetails' description: Request to register an Autonomous AI Database with Data Safe. /autonomousDatabases/{autonomousDatabaseId}/actions/restart: post: description: 'Restarts the specified Autonomous AI Database. ' operationId: RestartAutonomousDatabase parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/autonomousDatabaseIdPathParam' - $ref: '#/components/parameters/OptionalIsOnlineRestartQueryParam' responses: 200: description: The request was successfully received and the Autonomous AI Database will be restarted. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AutonomousDatabase' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Restarts the specified Autonomous AI Database. tags: - database x-example: 'POST /20160918/autonomousDatabases/<autonomousDatabaseId>/actions/restart Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/AutonomousDatabase' requestBody: content: application/json: schema: $ref: '#/components/schemas/RestartAutonomousDatabaseDetails' description: Request details to restart the Autonomous Database with force option. /autonomousDatabases/{autonomousDatabaseId}/actions/restore: post: description: 'Restores an Autonomous AI Database based on the provided request parameters. ' operationId: RestoreAutonomousDatabase parameters: - $ref: '#/components/parameters/autonomousDatabaseIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: The request was successfully received and the Autonomous AI Database restore is in progress. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AutonomousDatabase' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Restores an Autonomous AI Database based on the provided request parameters. tags: - database x-example: "POST /20160918/autonomousDatabases/<autonomousDatabaseId>/actions/restore\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"timestamp\" : \"2018-04-11T01:59:07.032Z\"\n}\n" x-related-resource: '#/definitions/AutonomousDatabase' requestBody: content: application/json: schema: $ref: '#/components/schemas/RestoreAutonomousDatabaseDetails' description: Request to perform an Autonomous AI Database restore. required: true /autonomousDatabases/{autonomousDatabaseId}/actions/rotateKey: post: description: Rotate existing AutonomousDatabase [Vault service](/iaas/Content/KeyManagement/Concepts/keyoverview.htm) key. operationId: RotateAutonomousDatabaseEncryptionKey parameters: - $ref: '#/components/parameters/autonomousDatabaseIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' responses: 202: description: 'The request was successfully received and the key is being rotated. ' 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AutonomousDatabase' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Rotate Key tags: - database x-example: 'POST /20160918/autonomousDatabases/<autonomousDatabaseId>/actions/rotateKey Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/AutonomousDatabase' requestBody: content: application/json: schema: $ref: '#/components/schemas/RotateAutonomousDatabaseEncryptionKeyDetails' description: Key details provided by the user for rotate key operation for Autonomous AI Database. /autonomousDatabases/{autonomousDatabaseId}/actions/shrink: post: description: 'This operation shrinks the current allocated storage down to the current actual used data storage (actualUsedDataStorageSizeInTBs). The if the base storage value for the database (dataStorageSizeInTBs) is larger than the actualUsedDataStorageSizeInTBs value, you are billed for the base storage value. ' operationId: ShrinkAutonomousDatabase parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/autonomousDatabaseIdPathParam' responses: 202: description: The request was successfully received and the storage shrink operation for the Autonomous AI Database is in progress. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AutonomousDatabase' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Shrinks the current allocated storage down to the current actual used storage. tags: - database x-example: 'POST /20160918/autonomousDatabases/<autonomousDatabaseId>/actions/shrink Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/AutonomousDatabase' /autonomousDatabases/{autonomousDatabaseId}/actions/start: post: description: 'Starts the specified Autonomous AI Database. ' operationId: StartAutonomousDatabase parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/autonomousDatabaseIdPathParam' responses: 200: description: The request was successfully received and the Autonomous AI Database will be started. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AutonomousDatabase' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Starts the specified Autonomous AI Database. tags: - database x-example: 'POST /20160918/autonomousDatabases/<autonomousDatabaseId>/actions/start Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/AutonomousDatabase' /autonomousDatabases/{autonomousDatabaseId}/actions/stop: post: description: 'Stops the specified Autonomous AI Database. ' operationId: StopAutonomousDatabase parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/autonomousDatabaseIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: The request was successfully received and the Autonomous AI Database will be stopped. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AutonomousDatabase' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Stops the specified Autonomous AI Database. tags: - database x-example: 'POST /20160918/autonomousDatabases/<autonomousDatabaseId>/actions/stop Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/AutonomousDatabase' requestBody: content: application/json: schema: $ref: '#/components/schemas/StopAutonomousDatabaseDetails' description: Request details to stop the Autonomous Database with force option. /autonomousDatabases/{autonomousDatabaseId}/actions/switchover: post: description: "Initiates a switchover of the specified Autonomous AI Database to the associated peer database. Applicable only to databases with Disaster Recovery enabled.\nThis API should be called in the remote region where the peer database resides.\nBelow parameter is optional:\n - `peerDbId`\n Use this parameter to specify the database OCID of the Disaster Recovery peer, which is located in a different (remote) region from the current peer database.\n If this parameter is not provided, the switchover will happen in the same region.\n" operationId: SwitchoverAutonomousDatabase parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/autonomousDatabaseIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/OptionalPeerAutonomousDatabaseIdQueryParam' responses: 200: description: The request was successfully received and the Autonomous AI Database switchover operation is in progress. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AutonomousDatabase' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Switches over AutonomousDatabase to a Standby. tags: - database x-example: "Example I - Local Switchover:\n POST /20160918/autonomousDatabases/ocid1.autonomousdatabase.oc1.phx..<unique_ID>/actions/switchover\n Host: database.us-phoenix-1.oraclecloud.com\n <authorization and other headers>\nExample II - Cross-Region Switchover:\n POST /20160918/autonomousDatabases/ocid1.autonomousdatabase.oc1.phx..<unique_ID>/actions/switchover\n Host: database.us-ashburn-1.oraclecloud.com\n <authorization and other headers>\n {\n \"peerDbId\": \"ocid1.autonomousdatabase.oc1.iad..<unique_ID>\" \n }\n" x-related-resource: '#/definitions/AutonomousDatabase' /autonomousDatabases/{autonomousDatabaseId}/autonomousDatabaseDataguardAssociations: get: description: '*Deprecated.* Use the [GetAutonomousContainerDatabase](#/en/database/latest/AutonomousContainerDatabase/GetAutonomousContainerDatabase) operation to get a list of the Autonomous Data Guard-enabled databases associated with the specified Autonomous AI Database. ' operationId: ListAutonomousDatabaseDataguardAssociations parameters: - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' - $ref: '#/components/parameters/autonomousDatabaseIdPathParam' responses: 200: description: All the Autonomous Data Guard-enabled databases associated with the specified Autonomous AI Database. 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/AutonomousDatabaseDataguardAssociation' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListAutonomousDatabaseDataguardAssociations tags: - database x-example: 'GET /20160918/autonomousDatabases/<autonomousDatabaseId>/autonomousDatabaseDataguardAssociations?limit=10 Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/AutonomousDatabaseDataguardAssociation' ? /autonomousDatabases/{autonomousDatabaseId}/autonomousDatabaseDataguardAssociations/{autonomousDatabaseDataguardAssociationId} : get: description: '*Deprecated.* Use the [GetAutonomousContainerDatabase](#/en/database/latest/AutonomousContainerDatabase/GetAutonomousContainerDatabase) operation to gets an Autonomous Data Guard-enabled database associated with the specified Autonomous AI Database. ' operationId: GetAutonomousDatabaseDataguardAssociation parameters: - $ref: '#/components/parameters/autonomousDatabaseIdPathParam' - $ref: '#/components/parameters/AutonomousDatabaseDataguardAssociationIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: The Autonomous Data Guard-enabled database associated with the specified Autonomous Data Guard association OCID. 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 must contact Oracle about a particular request, then provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AutonomousDatabaseDataguardAssociation' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListAutonomousDatabaseDataguardAssociation tags: - database x-example: 'GET /20160918/autonomousDatabases/<autonomousDatabaseId>/autonomousDatabaseDataguardAssociations/<autonomousDatabaseDataguardAssociationId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/AutonomousDatabaseDataguardAssociation' /autonomousDatabases/{autonomousDatabaseId}/clones: get: description: 'Lists the Autonomous AI Database clones for the specified Autonomous AI Database. ' operationId: ListAutonomousDatabaseClones parameters: - $ref: '#/components/parameters/CompartmentId' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' - $ref: '#/components/parameters/autonomousDatabaseIdPathParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' - $ref: '#/components/parameters/listAutonomousDatabasesFilterByLifecycleStateQueryParam' - $ref: '#/components/parameters/listAutonomousDatabasesRefreshableClonesSortByQueryParam' - $ref: '#/components/parameters/listAutonomousDatabasesFilterByCloneTypeQueryParam' responses: 200: description: The list of Autonomous AI Database clones for the specified Autonomous AI Database was retrieved. 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/AutonomousDatabaseSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets a list of Autonomous AI Database clones. tags: - database x-example: 'GET /20160918/autonomousDatabases/<autonomousDatabaseId>/clones Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/AutonomousDatabase' /autonomousDatabases/{autonomousDatabaseId}/estimateCostSavings: get: description: Gets the estimate cost savings of the Autonomous AI Database. operationId: ListEstimateCostSavings parameters: - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' - $ref: '#/components/parameters/IsCpuAutoScaleQueryParam' - $ref: '#/components/parameters/autonomousDatabaseIdPathParam' responses: 200: description: List of Cost Estimates. 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/EstimateCostSavingsSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets estimate cost savings of the Autonomous AI Database. tags: - database x-example: 'GET /20160918/autonomousDatabases/<autonomousDatabaseId>/estimateCostSavings Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/AutonomousDatabase' /autonomousDatabases/{autonomousDatabaseId}/peers: get: description: 'Lists the Autonomous AI Database peers for the specified Autonomous AI Database. ' operationId: ListAutonomousDatabasePeers parameters: - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' - $ref: '#/components/parameters/autonomousDatabaseIdPathParam' responses: 200: description: The list of Autonomous AI Database peers for the specified Autonomous AI Database was retrieved. 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/AutonomousDatabasePeerCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets a list of Autonomous AI Database peers. tags: - database x-example: 'GET /20160918/autonomousDatabases/<autonomousDatabaseId>/peers Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/AutonomousDatabase' /autonomousDatabases/{autonomousDatabaseId}/refreshableClones: get: description: 'Lists the OCIDs of the Autonomous AI Database local and connected remote refreshable clones with the region where they exist for the specified source database. ' operationId: ListAutonomousDatabaseRefreshableClones parameters: - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' - $ref: '#/components/parameters/autonomousDatabaseIdPathParam' responses: 200: description: A list of Autonomous AI Database clone OCIDs and the region where they exist was retrieved for the specified source database. 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/RefreshableCloneCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets the list of Autonomous AI Database refreshable clone OCIDs and the region they exist. tags: - database x-example: 'GET /20160918/autonomousDatabases/<autonomousDatabaseId>/listRefreshableClones Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/AutonomousDatabase' /autonomousDatabases/{autonomousDatabaseId}/resourcePoolMembers: get: description: 'Lists the OCIDs of the Autonomous AI Database resource pool members for the specified Autonomous AI Database leader. ' operationId: ListResourcePoolMembers parameters: - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' - $ref: '#/components/parameters/autonomousDatabaseIdPathParam' responses: 200: description: A list of Autonomous AI Database resource pool member OCIDs was retrieved for the specified Autonomous AI Database leader. 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/ResourcePoolMemberCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Lists the OCIDs of the Autonomous AI Database resource pool members for the specified Autonomous AI Database leader. tags: - database x-example: 'GET /20160918/autonomousDatabases/<autonomousDatabaseId>/resourcePoolMembers Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/AutonomousDatabase' /autonomousDatabases/{autonomousDatabaseId}/wallet: get: description: 'Gets the wallet details for the specified Autonomous AI Database. ' operationId: GetAutonomousDatabaseWallet parameters: - $ref: '#/components/parameters/autonomousDatabaseIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: The wallet details for the specified Autonomous AI Database are being retrieved. 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/AutonomousDatabaseWallet' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Get the wallet for the specified Autonomous AI Database. tags: - database x-example: 'GET /20160918/autonomousDatabases/<autonomousDatabaseId>/wallet Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/AutonomousDatabaseWallet' put: description: 'Updates the wallet for the specified Autonomous AI Database. ' operationId: UpdateAutonomousDatabaseWallet parameters: - $ref: '#/components/parameters/autonomousDatabaseIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 202: description: The request was successfully received and the wallet rotation is in progress. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application-json: example: "{\n \"timeWalletRotated\" : \"2019-06-23T00:59:07.032Z\"\n}\n" 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Updates the wallet for the specified Autonomous AI Database. tags: - database x-example: "PUT /latest/autonomousDatabases/<autonomousDatabaseId>/wallet\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"gracePeriod\" : 1,\n \"shouldRotate\" : true\n}\n" x-related-resource: '#/definitions/AutonomousDatabaseWallet' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateAutonomousDatabaseWalletDetails' description: Request to update the properties of an Autonomous AI Database wallet. required: true /autonomousDbPreviewVersions: get: description: 'Gets a list of supported Autonomous AI Database versions. Note that preview version software is only available for Autonomous AI Database Serverless (https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html) databases. ' operationId: ListAutonomousDbPreviewVersions parameters: - $ref: '#/components/parameters/CompartmentId' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/listAutonomousDbPreviewVersionSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' responses: 200: description: Supported Autonomous AI Database versions. 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/AutonomousDbPreviewVersionSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets a list of supported Autonomous AI Database versions. tags: - database x-example: 'GET /20160918/autonomousDbPreviewVersions?compartmentId=<compartmentId>&limit=100 Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-obmcs-authz-declarations: authorizationRequired: false /autonomousDbVersions: get: description: Gets a list of supported Autonomous AI Database versions. operationId: ListAutonomousDbVersions parameters: - $ref: '#/components/parameters/CompartmentId' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/listAutonomousDatabasesFilterByDbWorkloadQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' responses: 200: description: Supported Autonomous AI Database versions. 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/AutonomousDbVersionSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets a list of supported Autonomous AI Database versions. tags: - database x-example: 'GET /20160918/autonomousDbVersions?compartmentId=<compartmentId>&limit=100 Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-obmcs-authz-declarations: authorizationRequired: false /autonomousExadataInfrastructureShapes: get: description: '**Deprecated.** ' operationId: ListAutonomousExadataInfrastructureShapes parameters: - $ref: '#/components/parameters/AvailabilityDomainQueryParam' - $ref: '#/components/parameters/CompartmentId' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: Supported Autonomous Exadata Infrastructure system shapes. 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/AutonomousExadataInfrastructureShapeSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListAutonomousExadataInfrastructureShapes tags: - database x-example: 'GET /20160918/autonomousExadataInfrastructureShapes?availabilityDomain=<availabilityDomain>&compartmentId=<compartmentId>&limit=100 Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-obmcs-authz-declarations: authorizationRequired: false /autonomousExadataInfrastructures: get: description: '**Deprecated.** Use the [ListCloudExadataInfrastructures](#/en/database/latest/CloudExadataInfrastructure/ListCloudExadataInfrastructures) operation to list Exadata Infrastructures in the Oracle cloud and the [ListCloudAutonomousVmClusters](#/en/database/latest/CloudAutonomousVmCluster/ListCloudAutonomousVmClusters) operation to list Autonomous Exadata VM clusters. ' operationId: ListAutonomousExadataInfrastructures parameters: - $ref: '#/components/parameters/CompartmentId' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' - $ref: '#/components/parameters/ListAutonomousExadataInfrastructuresSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ListAutonomousExadataInfrastructuresFilterByLifecycleStateQueryParam' - $ref: '#/components/parameters/FilterByAvailabilityDomainQueryParam' - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' responses: 200: description: A list of all the Autonomous Exadata Infrastructure resources. 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/AutonomousExadataInfrastructureSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListAutonomousExadataInfrastructures tags: - database x-example: 'GET /20160918/autonomousExadataInfrastructure?compartmentId=<compartmentId>&limit=10 Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/AutonomousExadataInfrastructure' post: description: '**Deprecated** To create a new Autonomous AI Database system on dedicated Exadata Infrastructure, use the [CreateCloudExadataInfrastructure](#/en/database/latest/CloudExadataInfrastructure/CreateCloudExadataInfrastructure) and [CreateCloudAutonomousVmCluster](#/en/database/latest/CloudAutonomousVmCluster/CreateCloudAutonomousVmCluster) operations instead. Note that to create an Autonomous VM cluster, you must have an existing Exadata Infrastructure resource to contain the VM cluster. ' operationId: LaunchAutonomousExadataInfrastructure parameters: - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The request was successfully received and the Autonomous Exadata Infrastructure launch is in progress. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AutonomousExadataInfrastructure' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: LaunchAutonomousExadataInfrastructure tags: - database x-example: "POST /20160918/autonomousExadataInfrastructure\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"availabilityDomain\" : \"OXET:PHX-AD-1\",\n \"compartmentId\" : \"ocid1.tenancy.oc1.<unique_ID>\",\n \"displayName\" : \"tst3dbsys\",\n \"domain\" : \"my.company.com\",\n \"shape\" : \"Exadata.Half1.168\",\n \"subnetId\" : \"ocid1.subnet.oc1.<unique_ID>\"\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/LaunchAutonomousExadataInfrastructureDetails' description: '**Deprecated.** Use the [CreateCloudExadataInfrastructure](#/en/database/latest/CloudExadataInfrastructure/CreateCloudExadataInfrastructure) or [CreateCloudAutonomousVmCluster](#/en/database/latest/CloudAutonomousVmCluster/CreateCloudAutonomousVmCluster) operations instead. ' required: true /autonomousExadataInfrastructures/{autonomousExadataInfrastructureId}: delete: description: '**Deprecated.** To terminate an Exadata Infrastructure resource in the Oracle cloud, use the [DeleteCloudExadataInfrastructure](#/en/database/latest/CloudExadataInfrastructure/DeleteCloudExadataInfrastructure) operation. To delete an Autonomous Exadata VM cluster in the Oracle cloud, use the [DeleteCloudAutonomousVmCluster](#/en/database/latest/CloudAutonomousVmCluster/DeleteCloudAutonomousVmCluster) operation. ' operationId: TerminateAutonomousExadataInfrastructure parameters: - $ref: '#/components/parameters/AutonomousExadataInfrastructureIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 204: description: The request to terminate the Autonomous Exadata Infrastructure was accepted. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: TerminateAutonomousExadataInfrastructure tags: - database x-example: 'DELETE /20160918/autonomousExadataInfrastructure/<autonomousExadataInfrastructureId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/AutonomousExadataInfrastructure' get: description: '**Deprecated.** Use the [GetCloudExadataInfrastructure](#/en/database/latest/CloudExadataInfrastructure/GetCloudExadataInfrastructure) operation to get details of an Exadata Infrastructure resource and the [GetCloudAutonomousVmCluster](#/en/database/latest/CloudAutonomousVmCluster/GetCloudAutonomousVmCluster) operation to get details of an Autonomous Exadata VM cluster. ' operationId: GetAutonomousExadataInfrastructure parameters: - $ref: '#/components/parameters/AutonomousExadataInfrastructureIdPathParam' responses: 200: description: The Autonomous Exadata Infrastructure details. 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/AutonomousExadataInfrastructure' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetAutonomousExadataInfrastructure tags: - database x-example: 'GET /20160918/autonomousExadataInfrastructure/<autonomousExadataInfrastructureId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' put: description: '**Deprecated.** Use the [UpdateCloudExadataInfrastructure](#/en/database/latest/CloudExadataInfrastructure/UpdateCloudExadataInfrastructure) operation to update an Exadata Infrastructure resource and [UpdateCloudAutonomousVmCluster](#/en/database/latest/CloudAutonomousVmCluster/UpdateCloudAutonomousVmCluster) operation to update an Autonomous Exadata VM cluster. ' operationId: UpdateAutonomousExadataInfrastructure parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/AutonomousExadataInfrastructureIdPathParam' responses: 200: description: The request was successfully received and the Autonomous Exadata Infrastructure update is in-progress. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AutonomousExadataInfrastructure' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdateAutonomousExadataInfrastructure tags: - database x-example: "PUT /latest/autonomousExadataInfrastructures/<autonomousExadataInfrastructureId>\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\" : \"new displayname\"\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateAutonomousExadataInfrastructureDetails' description: Request to update the properties of a Autonomous Exadata Infrastructure. required: true /autonomousExadataInfrastructures/{autonomousExadataInfrastructureId}/actions/changeCompartment: post: description: '**Deprecated.** Use the [ChangeCloudExadataInfrastructureCompartment](#/en/database/latest/CloudExadataInfrastructure/ChangeCloudExadataInfrastructureCompartment) operation to move an Exadata infrastructure resource to a different compartment and [ChangeCloudAutonomousVmClusterCompartment](#/en/database/latest/CloudAutonomousVmCluster/ChangeCloudAutonomousVmClusterCompartment) operation to move an Autonomous Exadata VM cluster to a different compartment. For more information, see [Moving Database Resources to a Different Compartment](/Content/Database/Concepts/databaseoverview.htm#moveRes). ' operationId: ChangeAutonomousExadataInfrastructureCompartment parameters: - $ref: '#/components/parameters/AutonomousExadataInfrastructureIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: The request was successfully received and the change compartment action is being performed. 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 of the work request. schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ChangeAutonomousExadataInfrastructureCompartment tags: - database x-example: "POST /20160918/autonomousExadataInfrastructure/<autonomousExadataInfrastructureId>/action/changeCompartment\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\" : \"ocid.compartment.oc1..<unique_ID>\"\n}\n" x-related-resource: '#/definitions/AutonomousExadataInfrastructure' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeCompartmentDetails' description: Request to move an Autonomous Exadata Infrastructure resource to a different compartment. required: true /autonomousExadataInfrastructures/{autonomousExadataInfrastructureId}/actions/rotateOrdsCerts: post: description: '**Deprecated.** Use the [RotateCloudAutonomousVmClusterOrdsCerts](#/en/database/latest/CloudAutonomousVmCluster/RotateCloudAutonomousVmClusterOrdsCerts) to rotate Oracle REST Data Services (ORDS) certs for an Autonomous Exadata VM cluster instead. ' operationId: RotateOrdsCerts parameters: - $ref: '#/components/parameters/AutonomousExadataInfrastructureIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: The request was successfully received and the ORDS cert rotation is in progress. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Rotate ORDS certs for Autonomous Exadata Infrastructure. tags: - database x-example: 'POST /20160918/autonomousExadataInfrastructure/<autonomousExadataInfrastructureId>/actions/rotateOrdsCerts Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/AutonomousExadataInfrastructure' /autonomousExadataInfrastructures/{autonomousExadataInfrastructureId}/actions/rotateSslCerts: post: description: '**Deprecated.** Use the [RotateCloudAutonomousVmClusterSslCerts](#/en/database/latest/CloudAutonomousVmCluster/RotateCloudAutonomousVmClusterSslCerts) to rotate SSL certs for an Autonomous Exadata VM cluster instead. ' operationId: RotateSslCerts parameters: - $ref: '#/components/parameters/AutonomousExadataInfrastructureIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: The request was successfully received and the SSL cert rotation is in progress. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Rotate SSL certs for Autonomous Exadata Infrastructure. tags: - database x-example: 'POST /20160918/autonomousExadataInfrastructure/<autonomousExadataInfrastructureId>/actions/rotateSslCerts Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/AutonomousExadataInfrastructure' /autonomousExadataInfrastructures/{autonomousExadataInfrastructureId}/ocpus: get: description: 'Gets details of the available and consumed OCPUs for the specified Autonomous Exadata Infrastructure resource. ' operationId: GetExadataInfrastructureOcpus parameters: - $ref: '#/components/parameters/AutonomousExadataInfrastructureIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: Details of the available and consumed OCPUs for the specified Autonomous Exadata Infrastructure instance. 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/OCPUs' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' tags: - database x-example: 'GET /20160918/autonomousExadataInfrastructure/<autonomousExadataInfrastructureId>/ocpus Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/OCPUs' /autonomousPatches/{autonomousPatchId}: get: description: Gets information about a specific autonomous patch. operationId: GetAutonomousPatch parameters: - $ref: '#/components/parameters/AutonomousPatchIdPathParam' responses: 200: description: The autonomous patch details. 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 contact Oracle about a particular request, then you must provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AutonomousPatch' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetAutonomousPatch tags: - database x-example: 'GET /20160918/autonomousPatch/<autonomousPatch> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/AutonomousPatch' /autonomousVirtualMachines: get: description: 'Lists the Autonomous Virtual Machines in the specified Autonomous VM Cluster and Compartment. ' operationId: ListAutonomousVirtualMachines parameters: - $ref: '#/components/parameters/CompartmentId' - $ref: '#/components/parameters/AutonomousVmClusterIdQueryParam' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/ListAutonomousVirtualMachinesFilterByLifecycleStateQueryParam' responses: 200: description: The list of autonomous virtual machines. 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/AutonomousVirtualMachineSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets the list of the Autonomous Virtual Machines. tags: - database x-example: 'GET /20160918/autonomousVirtualMachines?compartmentId=<compartmentId>&autonomousVmClusterId=< autonomousVmClusterId>limit=10 Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/AutonomousVirtualMachine' /autonomousVirtualMachines/{autonomousVirtualMachineId}: get: description: 'Gets the details of specific Autonomous Virtual Machine. ' operationId: GetAutonomousVirtualMachine parameters: - $ref: '#/components/parameters/AutonomousVirtualMachineIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: Autonomous Virtual Machine details. 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/AutonomousVirtualMachine' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets the details of the specified Autonomous Virtual Machine. tags: - database x-example: 'GET /20160918/autonomousVirtualMachines/<autonomousVirtualMachineId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' /autonomousVmClusters: get: description: 'Gets a list of Exadata Cloud@Customer Autonomous VM clusters in the specified compartment. To list Autonomous VM Clusters in the Oracle Cloud, see [ListCloudAutonomousVmClusters](#/en/database/latest/CloudAutonomousVmCluster/ListCloudAutonomousVmClusters). ' operationId: ListAutonomousVmClusters parameters: - $ref: '#/components/parameters/CompartmentId' - $ref: '#/components/parameters/OptionalExadataInfrastructureIdQueryParam' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' - $ref: '#/components/parameters/ListAutonomousVmClustersSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ListAutonomousVmClustersFilterByLifecycleStateQueryParam' - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: The list of Autonomous VM clusters. 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/AutonomousVmClusterSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListAutonomousVmClusters tags: - database x-example: 'GET /20160918/autonomousVmClusters?compartmentId=<compartmentId>&limit=10 Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/AutonomousVmCluster' post: description: 'Creates an Autonomous VM cluster for Exadata Cloud@Customer. To create an Autonomous VM Cluster in the Oracle cloud, see [CreateCloudAutonomousVmCluster](#/en/database/latest/CloudAutonomousVmCluster/CreateCloudAutonomousVmCluster). ' operationId: CreateAutonomousVmCluster parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: The request was successfully received and the create Autonomous VM cluster operation is in progress. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AutonomousVmCluster' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateAutonomousVmCluster tags: - database x-example: "POST /20160918/autonomousVmClusters\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\" : \"autonomousVmCluster\",\n \"compartmentId\" : \"ocid1.tenancy.oc1.<unique_ID>\",\n \"exadataInfrastructureId\" : \"ocid1.exadataInfrastructure.oc1.<unique_ID>\",\n \"vmClusterNetworkId\" : \"ocid1.vmclusternetwork.oc1.<unique_ID>\",\n \"licenseModel\" : \"LICENSE_INCLUDED\"\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateAutonomousVmClusterDetails' description: Request to create an Autonomous VM cluster. required: true /autonomousVmClusters/{autonomousVmClusterId}: delete: description: 'Deletes the specified Autonomous VM cluster in an Exadata Cloud@Customer system. To delete an Autonomous VM Cluster in the Oracle cloud, see [DeleteCloudAutonomousVmCluster](#/en/database/latest/CloudAutonomousVmCluster/DeleteCloudAutonomousVmCluster). ' operationId: DeleteAutonomousVmCluster parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/AutonomousVmClusterIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 204: description: The request to delete the Autonomous VM cluster was accepted. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Deletes the specified Autonomous VM cluster. tags: - database x-related-resource: '#/definitions/AutonomousVmCluster' get: description: 'Gets information about the specified Autonomous VM cluster for an Exadata Cloud@Customer system. To get information about an Autonomous VM Cluster in the Oracle cloud, see [GetCloudAutonomousVmCluster](#/en/database/latest/CloudAutonomousVmCluster/GetCloudAutonomousVmCluster). ' operationId: GetAutonomousVmCluster parameters: - $ref: '#/components/parameters/AutonomousVmClusterIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: Information about the Autonomous VM cluster. 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/AutonomousVmCluster' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetAutonomousVmCluster tags: - database x-example: 'GET /20160918/AutonomousVmClusters/<autonomousVmClusterId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' put: description: 'Updates the specified Autonomous VM cluster for the Exadata Cloud@Customer system.To update an Autonomous VM Cluster in the Oracle cloud, see [UpdateCloudAutonomousVmCluster](#/en/database/latest/CloudAutonomousVmCluster/UpdateCloudAutonomousVmCluster). ' operationId: UpdateAutonomousVmCluster parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/AutonomousVmClusterIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: The request was successfully received and the Autonomous VM cluster update is in progress. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AutonomousVmCluster' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Updates the specified Autonomous VM cluster. tags: - database x-example: "PUT /latest/autonomousVmClusters/<autonomousVmClusterId>\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"licenseModel\" : \"BRING_YOUR_OWN_LICENSE\"\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateAutonomousVmClusterDetails' description: Request to update the attributes of an Autonomous VM cluster. required: true /autonomousVmClusters/{autonomousVmClusterId}/acdResourceUsage: get: description: 'Gets the list of resource usage details for all the Autonomous Container Database in the specified Autonomous Exadata VM cluster. ' operationId: ListAutonomousVmClusterAcdResourceUsage parameters: - $ref: '#/components/parameters/OptionalCompartmentIdQueryParam' - $ref: '#/components/parameters/AutonomousVmClusterIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' responses: 200: description: Gets the list of resource usage details for all the Autonomous Container Database in the specified Autonomous Exadata VM cluster. 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/AutonomousContainerDatabaseResourceUsage' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListAutonomousVmClusterAcdResourceUsage tags: - database x-example: "GET /20160918/AutonomousVmClusters/<autonomousVmClusterId>/acdResourceUsage\n Host: database.us-phoenix-1.oraclecloud.com\n <authorization and other headers>\n" x-related-resource: '#/definitions/AutonomousVmCluster' /autonomousVmClusters/{autonomousVmClusterId}/actions/changeCompartment: post: description: 'Moves an Autonomous VM cluster and its dependent resources to another compartment. Applies to Exadata Cloud@Customer only. For systems in the Oracle cloud, see [ChangeAutonomousVmClusterCompartment](#/en/database/latest/AutonomousVmCluster/ChangeAutonomousVmClusterCompartment). ' operationId: ChangeAutonomousVmClusterCompartment parameters: - $ref: '#/components/parameters/AutonomousVmClusterIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: The request was successfully received and the change compartment action is being performed. 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 of the work request. schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ChangeAutonomousVmClusterCompartment tags: - database x-related-resource: '#/definitions/AutonomousVmCluster' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeAutonomousVmClusterCompartmentDetails' description: Request to move Autonomous VM cluster to a different compartment required: true /autonomousVmClusters/{autonomousVmClusterId}/actions/restartOrds: post: description: 'Restarts Oracle REST Data Services (ORDS) for Autonomous Exadata VM cluster. ' operationId: RestartAutonomousVmClusterOrds parameters: - $ref: '#/components/parameters/AutonomousVmClusterIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: The request was successfully received and the ORDS restart action is being performed. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: RestartAutonomousVmClusterOrds tags: - database x-related-resource: '#/definitions/AutonomousVmCluster' /autonomousVmClusters/{autonomousVmClusterId}/actions/rotateOrdsCerts: post: description: 'Rotates the Oracle REST Data Services (ORDS) certificates for Autonomous Exadata VM cluster. ' operationId: RotateAutonomousVmClusterOrdsCerts parameters: - $ref: '#/components/parameters/AutonomousVmClusterIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: The request was successfully received and the ORDS certificate rotation action is being performed. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: RotateAutonomousVmClusterOrdsCerts tags: - database x-example: "POST /20160918/AutonomousVmClusters/<autonomousVmClusterId>/action/rotateOrdsCerts\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"certificateGenerationType\": \"BYOC\",\n \"certificateId\" : \"ocid1.certificate.oc1.\",\n \"certificateAuthorityId\" : \"ocid1.certificateauthority.oc1.\",\n \"caBundleId\": \"ocid1.cabundle.oc1.\"\n}\n" x-obmcs-terraform: actionType: MANAGEMENT_RESOURCE x-related-resource: '#/definitions/AutonomousVmCluster' requestBody: content: application/json: schema: $ref: '#/components/schemas/RotateAutonomousVmClusterOrdsCertsDetails' description: Request to rotate the Oracle REST Data Services (ORDS) certificates on Autonomous Exadata VM cluster. required: true /autonomousVmClusters/{autonomousVmClusterId}/actions/rotateSslCerts: post: description: 'Rotates the SSL certificates for Autonomous Exadata VM cluster. ' operationId: RotateAutonomousVmClusterSslCerts parameters: - $ref: '#/components/parameters/AutonomousVmClusterIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: The request was successfully received and the SSL certificate rotation action is being performed. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: RotateAutonomousVmClusterSslCerts tags: - database x-example: "POST /20160918/AutonomousVmClusters/<autonomousVmClusterId>/action/rotateSslCerts\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"certificateGenerationType\": \"BYOC\",\n \"certificateId\" : \"ocid1.certificate.oc1.\",\n \"certificateAuthorityId\" : \"ocid1.certificateauthority.oc1.\",\n \"caBundleId\": \"ocid1.cabundle.oc1.\"\n}\n" x-obmcs-terraform: actionType: MANAGEMENT_RESOURCE x-related-resource: '#/definitions/AutonomousVmCluster' requestBody: content: application/json: schema: $ref: '#/components/schemas/RotateAutonomousVmClusterSslCertsDetails' description: Request to rotate the SSL certificates on Autonomous Exadata VM cluster. required: true /autonomousVmClusters/{autonomousVmClusterId}/resourceUsage: get: description: 'Get the resource usage details for the specified Autonomous Exadata VM cluster. ' operationId: GetAutonomousVmClusterResourceUsage parameters: - $ref: '#/components/parameters/AutonomousVmClusterIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: Get the Autonomous VM cluster resource usage details. 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/AutonomousVmClusterResourceUsage' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetAutonomousVmClusterResourceUsage tags: - database x-example: "GET /20160918/AutonomousVmClusters/<autonomousVmClusterId>/resourceUsage\n Host: database.us-phoenix-1.oraclecloud.com\n <authorization and other headers>\n" x-related-resource: '#/definitions/AutonomousVmCluster' /backupDestinations: get: description: 'Gets a list of backup destinations in the specified compartment. ' operationId: ListBackupDestination parameters: - $ref: '#/components/parameters/CompartmentId' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/FilterByDestinationTypeQueryParam' responses: 200: description: 'List of backup destinations. ' headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/BackupDestinationSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListBackupDestination tags: - database x-example: 'GET /20160918/backupDestinations?compartmentId=<compartmentId>&limit=10 Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/BackupDestinationSummary' post: description: 'Creates a backup destination in an Exadata Cloud@Customer system. ' operationId: CreateBackupDestination parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: 'The request was successfully received and the backup destination is being created. ' 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/BackupDestination' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateBackupDestination tags: - database x-example: "POST /20160918/backupDestinations\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\":\"Recovery Appliance1\",\n \"compartmentId\":\"ocid1.tenancy.oc1.<unique_ID>\",\n \"type\":\"RECOVERY_APPLIANCE\",\n \"vpcusers\":[\n \"bkupUser1\",\n \"bkupUser2\"\n ],\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateBackupDestinationDetails' description: 'Request to create a new backup destination. ' required: true /backupDestinations/{backupDestinationId}: delete: description: 'Deletes a backup destination in an Exadata Cloud@Customer system. ' operationId: DeleteBackupDestination parameters: - $ref: '#/components/parameters/BackupDestinationIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OptionalRequestId' responses: 204: description: 'The request to delete the backup destination was accepted. ' 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 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: DeleteBackupDestination tags: - database x-example: 'DELETE /20160918/backupDestinations/<backupDestinationId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/BackupDestination' get: description: 'Gets information about the specified backup destination in an Exadata Cloud@Customer system. ' operationId: GetBackupDestination parameters: - $ref: '#/components/parameters/BackupDestinationIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: 'The backup destination. ' 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/BackupDestination' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetBackupDestination tags: - database x-example: 'GET /20160918/backupDestinations/<backupDestinationId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' put: description: 'If no database is associated with the backup destination: - For a RECOVERY_APPLIANCE backup destination, updates the connection string and/or the list of VPC users. - For an NFS backup destination, updates the NFS location. ' operationId: UpdateBackupDestination parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/BackupDestinationIdPathParam' responses: 200: description: 'The request was successfully received and the backup destination update is in-progress. ' 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/BackupDestination' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Updates the specified backup destination. tags: - database requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateBackupDestinationDetails' description: 'For a RECOVERY_APPLIANCE backup destination, request to update the connection string and/or the list of VPC users. For an NFS backup destination, request to update the NFS location. ' required: true /backupDestinations/{backupDestinationId}/actions/changeCompartment: post: description: 'Move the backup destination and its dependent resources to the specified compartment. For more information, see [Moving Database Resources to a Different Compartment](/Content/Database/Concepts/databaseoverview.htm#moveRes). ' operationId: ChangeBackupDestinationCompartment parameters: - $ref: '#/components/parameters/BackupDestinationIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: 'The request was successfully received and the change compartment action is being performed. ' 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 of the work request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ChangeBackupDestinationCompartment tags: - database x-example: "POST /20160918/backupDestinations/<backupDestinationId>/actions/changeCompartment\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\" : \"ocid.compartment.oc1..<unique_ID>\"\n}\n" x-related-resource: '#/definitions/BackupDestination' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeCompartmentDetails' description: 'Request to move backup destination to a different compartment. ' required: true /backups: get: description: 'Gets a list of backups based on the `databaseId` or `compartmentId` specified. Either one of these query parameters must be provided. ' operationId: ListBackups parameters: - $ref: '#/components/parameters/OptionalDatabaseIdQueryParam' - $ref: '#/components/parameters/OptionalCompartmentIdQueryParam' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' - $ref: '#/components/parameters/OptionalShapeFamilyQueryParam' - $ref: '#/components/parameters/FilterByDatabaseVersionQueryParam' - $ref: '#/components/parameters/FilterByBackupTypeQueryParam' - $ref: '#/components/parameters/ListBackupsFilterByLifecycleStateQueryParam' - $ref: '#/components/parameters/TimeExpiryScheduledGreaterThanOrEqualTo' - $ref: '#/components/parameters/TimeExpiryScheduledLessThan' - $ref: '#/components/parameters/FilterByBackupDestinationType' responses: 200: description: The list of backups was retrieved. 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListBackups tags: - database x-example: 'GET /20160918/databases/backups?databaseId=<databaseId>&limit=10 Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/Backup' post: description: 'Creates a new backup in the specified database based on the request parameters you provide. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work. ' operationId: CreateBackup parameters: - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The request was successfully received and the backup operation is in progress. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Backup' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateBackup tags: - database x-examples: example1: "POST /20160918/backups\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"databaseId\" : \"ocid1.database.oc1.phx.<unique_ID>\",\n \"displayName\" : \"Monthly Backup\"\n}\n" example2: "POST /20160918/backups\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"databaseId\" : \"ocid1.database.oc1.phx.<unique_ID>\",\n \"displayName\" : \"LongTermBackup1\"\n \"retentionPeriodInDays\" : 100 \n}\n" example3: "POST /20160918/backups\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"databaseId\" : \"ocid1.database.oc1.phx.<unique_ID>\",\n \"displayName\" : \"LongTermBackup2\"\n \"retentionPeriodInYears\" : 5\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateBackupDetails' description: Request to create a new database backup. required: true /backups/{backupId}: delete: description: Deletes a full backup. You cannot delete automatic backups using this API. operationId: DeleteBackup parameters: - $ref: '#/components/parameters/BackupIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 204: description: The request to delete the backup was accepted. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: DeleteBackup tags: - database x-example: 'DELETE /20160918/backups/<backupId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/Backup' get: description: Gets information about the specified backup. operationId: GetBackup parameters: - $ref: '#/components/parameters/BackupIdPathParam' responses: 200: description: The database backup information was retrieved. 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' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetBackup tags: - database x-example: 'GET /20160918/backups/<backupId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' put: description: Updates database backup details. operationId: UpdateBackup parameters: - $ref: '#/components/parameters/BackupIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: Request to update database backup details is successful. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Backup' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdateBackup tags: - database x-example: "Example I:\nPUT /20160918/backups/<backupId>\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"retentionPeriodInDays\" : 100 \n}\n" x-related-resource: '#/definitions/Backup' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateBackupDetails' description: Request to update the properties of a Backup. required: true /cloudAutonomousVmClusters: get: description: 'Lists Autonomous Exadata VM clusters in the Oracle cloud. For Exadata Cloud@Customer systems, see [ListAutonomousVmClusters](#/en/database/latest/AutonomousVmCluster/ListAutonomousVmClusters). ' operationId: ListCloudAutonomousVmClusters parameters: - $ref: '#/components/parameters/CompartmentId' - $ref: '#/components/parameters/OptionalCloudExadataInfrastructureIdQueryParam' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' - $ref: '#/components/parameters/ListCloudAutonomousVmClustersSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ListCloudAutonomousVmClustersFilterByLifecycleStateQueryParam' - $ref: '#/components/parameters/FilterByAvailabilityDomainQueryParam' - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: List of the Autonomous Cloud VM clusters. 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/CloudAutonomousVmClusterSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListCloudAutonomousVmClusters tags: - database x-example: 'GET /20160918/cloudAutonomousVmClusters?compartmentId=<compartmentId>&limit=10 Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/CloudAutonomousVmCluster' post: description: 'Creates an Autonomous Exadata VM cluster in the Oracle cloud. For Exadata Cloud@Customer systems, see [CreateAutonomousVmCluster](#/en/database/latest/AutonomousVmCluster/CreateAutonomousVmCluster). ' operationId: CreateCloudAutonomousVmCluster parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: The request to create cloud Autonomous VM cluster was received. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/CloudAutonomousVmCluster' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateCloudAutonomousVmCluster tags: - database x-example: "POST /20160918/cloudAutonomousVmClusters\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n autonomousDataStorageSizeInTBs: 2,\n cloudExadataInfrastructureId: \"ocid1.cloudexadatainfrastructure.phx.\",\n clusterTimeZone: \"UTC\",\n compartmentId: \"ocid1.tenancy.phx..\",\n computeModel: \"ECPU\",\n cpuCoreCountPerNode: 20,\n dbServers: [\"ocid1.dbserver.phx.\",…],\n definedTags: {},\n displayName: \"VMCluster-dk\",\n freeformTags: {},\n isMtlsEnabledVmCluster: false,\n licenseModel: \"BRING_YOUR_OWN_LICENSE\",\n maintenanceWindowDetails: null,\n memoryPerOracleComputeUnitInGBs: 2,\n scanListenerPortNonTls: 1521,\n scanListenerPortTls: 2484,\n subnetId: \"ocid1.subnet.phx.\",\n totalContainerDatabases: 1\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateCloudAutonomousVmClusterDetails' description: Request to create a cloud Autonomous VM cluster. required: true /cloudAutonomousVmClusters/{cloudAutonomousVmClusterId}: delete: description: 'Deletes the specified Autonomous Exadata VM cluster in the Oracle cloud. For Exadata Cloud@Customer systems, see [DeleteAutonomousVmCluster](#/en/database/latest/AutonomousVmCluster/DeleteAutonomousVmCluster). ' operationId: DeleteCloudAutonomousVmCluster parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/CloudAutonomousVmClusterIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 204: description: Request to delete cloud Autonomous VM cluster was accepted. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Deletes the specified cloud VM cluster. tags: - database x-related-resource: '#/definitions/CloudAutonomousVmCluster' get: description: 'Gets information about the specified Autonomous Exadata VM cluster in the Oracle cloud. For Exadata Cloud@Custustomer systems, see [GetAutonomousVmCluster ](#/en/database/latest/AutonomousVmCluster/GetAutonomousVmCluster). ' operationId: GetCloudAutonomousVmCluster parameters: - $ref: '#/components/parameters/CloudAutonomousVmClusterIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: Information about the cloud VM cluster. 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/CloudAutonomousVmCluster' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetCloudAutonomousVmCluster tags: - database x-example: 'GET /20160918/cloudAutonomousVmClusters/<cloudAutonomousVmClusterId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' put: description: 'Updates the specified Autonomous Exadata VM cluster in the Oracle cloud. For Exadata Cloud@Customer systems, see [UpdateAutonomousVmCluster](#/en/database/latest/AutonomousVmCluster/UpdateAutonomousVmCluster). ' operationId: UpdateCloudAutonomousVmCluster parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/CloudAutonomousVmClusterIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: The request was successfully received and the cloud VM cluster update is in progress. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/CloudAutonomousVmCluster' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Updates the specified cloud Autonomous VM cluster. tags: - database x-example: "PUT /latest/cloudAutonomousVmClusters/<cloudAutonomousVmClusterId>\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"nodeCount\" : 10,\n \"licenseModel\" : \"LICENSE_INCLUDED\"\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateCloudAutonomousVmClusterDetails' description: Request to update the attributes of a cloud VM cluster. required: true /cloudAutonomousVmClusters/{cloudAutonomousVmClusterId}/acdResourceUsage: get: description: 'Gets the list of resource usage details for all the Cloud Autonomous Container Database in the specified Cloud Autonomous Exadata VM cluster. ' operationId: ListCloudAutonomousVmClusterAcdResourceUsage parameters: - $ref: '#/components/parameters/OptionalCompartmentIdQueryParam' - $ref: '#/components/parameters/CloudAutonomousVmClusterIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' responses: 200: description: 'Gets the list of resource usage details for all the Autonomous Container Database in the specified Cloud Autonomous Exadata VM cluster. ' 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/AutonomousContainerDatabaseResourceUsage' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListCloudAutonomousVmClusterAcdResourceUsage tags: - database x-example: "GET /20160918/cloudAutonomousVmClusters/<cloudAutonomousVmClusterId>/acdResourceUsage\n Host: database.us-phoenix-1.oraclecloud.com\n <authorization and other headers>\n" x-related-resource: '#/definitions/CloudAutonomousVmCluster' /cloudAutonomousVmClusters/{cloudAutonomousVmClusterId}/actions/changeCompartment: post: description: 'Moves an Autonomous Exadata VM cluster in the Oracle cloud and its dependent resources to another compartment. For Exadata Cloud@Customer systems, see [ChangeAutonomousVmClusterCompartment](#/en/database/latest/AutonomousVmCluster/ChangeAutonomousVmClusterCompartment). ' operationId: ChangeCloudAutonomousVmClusterCompartment parameters: - $ref: '#/components/parameters/CloudAutonomousVmClusterIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: The request was successfully received and the change compartment action is being performed. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ChangeCloudAutonomousVmClusterCompartment tags: - database x-related-resource: '#/definitions/CloudAutonomousVmCluster' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeCloudAutonomousVmClusterCompartmentDetails' description: Request to move cloud Autonomous VM cluster to a different compartment required: true /cloudAutonomousVmClusters/{cloudAutonomousVmClusterId}/actions/restartOrds: post: description: 'Restarts Oracle REST Data Services (ORDS) for a cloud Autonomous Exadata VM cluster. ' operationId: RestartCloudAutonomousVmClusterOrds parameters: - $ref: '#/components/parameters/CloudAutonomousVmClusterIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: The request was successfully received and the ORDS restart action is being performed. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: RestartCloudAutonomousVmClusterOrds tags: - database x-related-resource: '#/definitions/CloudAutonomousVmCluster' /cloudAutonomousVmClusters/{cloudAutonomousVmClusterId}/actions/rotateOrdsCerts: post: description: 'Rotates the Oracle REST Data Services (ORDS) certificates for a cloud Autonomous Exadata VM cluster. ' operationId: RotateCloudAutonomousVmClusterOrdsCerts parameters: - $ref: '#/components/parameters/CloudAutonomousVmClusterIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: The request was successfully received and the ORDS cert rotation action is being performed. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: RotateCloudAutonomousVmClusterOrdsCerts tags: - database x-related-resource: '#/definitions/CloudAutonomousVmCluster' requestBody: content: application/json: schema: $ref: '#/components/schemas/RotateCloudAutonomousVmClusterOrdsCertsDetails' description: Request to rotate the Oracle REST Data Services (ORDS) certificates on Cloud Autonomous Exadata VM cluster. /cloudAutonomousVmClusters/{cloudAutonomousVmClusterId}/actions/rotateSslCerts: post: description: 'Rotates the SSL certficates for a cloud Autonomous Exadata VM cluster. ' operationId: RotateCloudAutonomousVmClusterSslCerts parameters: - $ref: '#/components/parameters/CloudAutonomousVmClusterIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: The request was successfully received and the SSL cert rotation action is being performed. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: RotateCloudAutonomousVmClusterSslCerts tags: - database x-related-resource: '#/definitions/CloudAutonomousVmCluster' requestBody: content: application/json: schema: $ref: '#/components/schemas/RotateCloudAutonomousVmClusterSslCertsDetails' description: Request to rotate the SSL certificates on Cloud Autonomous Exadata VM cluster. /cloudAutonomousVmClusters/{cloudAutonomousVmClusterId}/resourceUsage: get: description: 'Get the resource usage details for the specified Cloud Autonomous Exadata VM cluster. ' operationId: GetCloudAutonomousVmClusterResourceUsage parameters: - $ref: '#/components/parameters/CloudAutonomousVmClusterIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: Get the Autonomous Cloud VM cluster resource usage details. 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/CloudAutonomousVmClusterResourceUsage' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetCloudAutonomousVmClusterResourceUsage tags: - database x-example: 'GET /20160918/cloudAutonomousVmClusters/<cloudAutonomousVmClusterId>/resourceUsage Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/CloudAutonomousVmCluster' /cloudExadataInfrastructures: get: description: 'Gets a list of the cloud Exadata infrastructure resources in the specified compartment. Applies to Exadata Cloud Service instances and Autonomous AI Database on dedicated Exadata infrastructure only. ' operationId: ListCloudExadataInfrastructures parameters: - $ref: '#/components/parameters/CompartmentId' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/ListCloudExadataInfrastructuresSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ListCloudExadataInfrastructuresFilterByLifecycleStateQueryParam' - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' - $ref: '#/components/parameters/ListCloudExadataInfrastructuresFilterByClusterPlacementGroupIdQueryParam' responses: 200: description: 'A list of the cloud Exadata infrastructure resources in the specified compartment. ' 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/CloudExadataInfrastructureSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListCloudExadataInfrastructures tags: - database x-example: 'GET /20160918/cloudExadataInfrastructures?compartmentId=<compartmentId>&limit=10 Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/CloudExadataInfrastructure' post: description: 'Creates a cloud Exadata infrastructure resource. This resource is used to create either an [Exadata Cloud Service](/Content/Database/Concepts/exaoverview.htm) instance or an Autonomous AI Database on dedicated Exadata infrastructure. ' operationId: CreateCloudExadataInfrastructure parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: 'The request was successfully received and the create cloud Exadata infrastructure operation is in progress. ' 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/CloudExadataInfrastructure' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateCloudExadataInfrastructure tags: - database x-example: "POST /20160918/cloudExadataInfrastructures\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\" : \"ocid1.tenancy.oc1.<unique_ID>\",\n \"displayName\" : \"tstExaInfra\",\n \"shape\" : \"Exadata.X8M\",\n \"availabilityDomain\" : \"OXET:PHX-AD-1\",\n \"databaseServerType\" : \"X11M\",\n \"storageServerType\": \"X11M-HC-XRMEM\",\n \"computeCount\" : 2,\n \"storageCount\" : 3\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateCloudExadataInfrastructureDetails' description: 'Request to create a cloud Exadata infrastructure resource in an [Exadata Cloud Service](/Content/Database/Concepts/exaoverview.htm) instance. ' required: true /cloudExadataInfrastructures/{cloudExadataInfrastructureId}: delete: description: 'Deletes the cloud Exadata infrastructure resource. Applies to Exadata Cloud Service instances and Autonomous AI Database on dedicated Exadata infrastructure only. ' operationId: DeleteCloudExadataInfrastructure parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/CloudExadataInfrastructureIdPathParam' - $ref: '#/components/parameters/isDeleteVmClustersQueryParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 204: description: The request to delete the cloud Exadata infrastructure resource was accepted. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Deletes the specified cloud Exadata infrastructure. tags: - database x-related-resource: '#/definitions/CloudExadataInfrastructure' get: description: 'Gets information about the specified cloud Exadata infrastructure resource. Applies to Exadata Cloud Service instances and Autonomous AI Database on dedicated Exadata infrastructure only. ' operationId: GetCloudExadataInfrastructure parameters: - $ref: '#/components/parameters/CloudExadataInfrastructureIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: The cloud Exadata infrastructure details. 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/CloudExadataInfrastructure' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetCloudExadataInfrastructure tags: - database x-example: 'GET /20160918/cloudExadataInfrastructures/<cloudExadataInfrastructureId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' put: description: 'Updates the Cloud Exadata infrastructure resource. Applies to Exadata Cloud Service instances and Autonomous AI Database on dedicated Exadata infrastructure only. ' operationId: UpdateCloudExadataInfrastructure parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/CloudExadataInfrastructureIdPathParam' responses: 200: description: 'The request was successfully received and the cloud Exadata infrastructure update is in progress. ' 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/CloudExadataInfrastructure' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Updates the specified cloud Exadata Infrastructure resource. tags: - database x-example: "PUT /20160918/cloudExadataInfrastructures/<cloudExadataInfrastructureId>\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"computeCount\" : 3,\n \"storageCount\" : 4,\n \"displayName\" : \"displayName\"\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateCloudExadataInfrastructureDetails' description: Request to update the properties of an cloud Exadata infrastructure resource. required: true /cloudExadataInfrastructures/{cloudExadataInfrastructureId}/actions/addStorageCapacity: post: description: 'Makes the storage capacity from additional storage servers available for Cloud VM Cluster consumption. Applies to Exadata Cloud Service instances and Autonomous AI Database on dedicated Exadata infrastructure only. ' operationId: AddStorageCapacityCloudExadataInfrastructure parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/CloudExadataInfrastructureIdPathParam' responses: 200: description: 'The request was successfully received and the Exadata Cloud infrastructure update is in progress. ' 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/CloudExadataInfrastructure' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Makes the storage capacity from additional storage servers available for Cloud VM Cluster consumption. Applies to Exadata Cloud instances only. tags: - database x-related-resource: '#/definitions/CloudExadataInfrastructure' /cloudExadataInfrastructures/{cloudExadataInfrastructureId}/actions/changeCompartment: post: description: 'Moves a cloud Exadata infrastructure resource and its dependent resources to another compartment. Applies to Exadata Cloud Service instances and Autonomous AI Database on dedicated Exadata infrastructure only.For more information about moving resources to a different compartment, see [Moving Database Resources to a Different Compartment](/Content/Database/Concepts/databaseoverview.htm#moveRes). ' operationId: ChangeCloudExadataInfrastructureCompartment parameters: - $ref: '#/components/parameters/CloudExadataInfrastructureIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: The request was successfully received and the change compartment action is being performed. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ChangeCloudExadataInfrastructureCompartment tags: - database x-related-resource: '#/definitions/CloudExadataInfrastructure' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeCloudExadataInfrastructureCompartmentDetails' description: Request to move cloud Exadata infrastructure resource to a different compartment. required: true /cloudExadataInfrastructures/{cloudExadataInfrastructureId}/actions/changeSubscription: post: description: 'Associate a cloud Exadata infrastructure with a different subscription. ' operationId: ChangeCloudExadataInfrastructureSubscription parameters: - $ref: '#/components/parameters/CloudExadataInfrastructureIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: The request was successfully received and the update subscription action is being performed. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ChangeCloudExadataInfrastructureSubscription tags: - database x-related-resource: '#/definitions/CloudExadataInfrastructure' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeCloudExadataInfrastructureSubscriptionDetails' description: Associate a cloud Exadata infrastructure with a different subscription. required: true /cloudExadataInfrastructures/{cloudExadataInfrastructureId}/actions/configureExascale: post: description: 'Configures Exascale on Cloud exadata infrastructure resource. Applies to Exadata Cloud Service instances only. ' operationId: ConfigureExascaleCloudExadataInfrastructure parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/CloudExadataInfrastructureIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The Exadata Cloud Infrastructure. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/CloudExadataInfrastructure' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Configure exascale on Cloud ExadataInfrastructure. tags: - database x-example: "POST /20160918/cloudExadataInfrastructures/<cloudExadataInfrastructureId>/actions/configureExascale\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"totalStorageInGBs\" : 300\n}\n" x-obmcs-terraform: actionType: MANAGEMENT_RESOURCE x-related-resource: '#/definitions/CloudExadataInfrastructure' requestBody: content: application/json: schema: $ref: '#/components/schemas/ConfigureExascaleCloudExadataInfrastructureDetails' description: The exascale config details for the Exadata infrastructure with the total storage needed. required: true /cloudExadataInfrastructures/{cloudExadataInfrastructureId}/unAllocatedResources: get: description: 'Gets unallocated resources information for the specified Cloud Exadata infrastructure. ' operationId: GetCloudExadataInfrastructureUnallocatedResources parameters: - $ref: '#/components/parameters/CloudExadataInfrastructureIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/OptionalDbServersQueryParam' responses: 200: description: The Cloud Exadata infrastructure unallocated resources details. 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/CloudExadataInfrastructureUnallocatedResources' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetCloudExadataInfrastructureUnallocatedResources tags: - database x-example: 'GET /20160918/cloudExadataInfrastructures/<cloudexadataInfrastructureId>/unallocatedResources Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/CloudExadataInfrastructure' /cloudVmClusters: get: description: 'Gets a list of the cloud VM clusters in the specified compartment. Applies to Exadata Cloud Service instances and Autonomous Database on dedicated Exadata infrastructure only. ' operationId: ListCloudVmClusters parameters: - $ref: '#/components/parameters/CompartmentId' - $ref: '#/components/parameters/OptionalCloudExadataInfrastructureIdQueryParam' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' - $ref: '#/components/parameters/ListCloudVmClustersSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ListCloudVmClustersFilterByLifecycleStateQueryParam' - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: List of the Cloud VM clusters. 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/CloudVmClusterSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListCloudVmClusters tags: - database x-example: 'GET /20160918/cloudVmClusters?compartmentId=<compartmentId>&limit=10 Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/CloudVmCluster' post: description: 'Creates a cloud VM cluster. ' operationId: CreateCloudVmCluster parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: The request was successfully received and the create cloud VM cluster operation is in progress. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/CloudVmCluster' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateCloudVmCluster tags: - database x-example: "POST /20160918/cloudVmClusters\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\" : \"cloudVmCluster\",\n \"compartmentId\" : \"ocid1.tenancy.oc1.<unique_ID>\",\n \"cloudExadataInfrastructureId\" : \"ocid1.cloudExadataInfrastructure.oc1.<unique_ID>\",\n \"cpuCoreCount\" : 4,\n \"sshPublicKeys\" : [ \"ssh-rsa <public_SSH_key> name@example.com\" ],\n \"licenseModel\" : \"LICENSE_INCLUDED\",\n \"domain\" : \"example.com\",\n \"hostname\" : \"apollo\",\n \"isSparseDiskgroupEnabled\" : false,\n \"isLocalBackupEnabled\" : true,\n \"privateZoneId\" : \"ocid1.dns-zone.oc1.<unique_ID>\",\n \"exascaleDbStorageVaultId\": \"ocid1.exascaleDbstoragevault.oc1.\",\n \"storageManagementType\": \"EXASCALE\",\n \"timeZone\" : \"PST\",\n \"subnetId\" : \"ocid1.subnet.oc1.phx.<unique_ID>\",\n \"backupSubnetId\" : \"ocid1.subnet.oc1.phx.<backup_subnet_unique_ID>\",\n \"giVersion\" : \"19.0.0.0\"\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateCloudVmClusterDetails' description: 'Request to create a cloud VM cluster. Applies to Exadata Cloud Service instances only. See [The New Exadata Cloud Service Resource Model](/iaas/Content/Database/iaas/Content/Database/Concepts/exaflexsystem.htm#exaflexsystem_topic-resource_model) for information on this resource type. ' required: true /cloudVmClusters/{cloudVmClusterId}: delete: description: 'Deletes the specified cloud VM cluster. Applies to Exadata Cloud Service instances and Autonomous Database on dedicated Exadata infrastructure only. ' operationId: DeleteCloudVmCluster parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/CloudVmClusterIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 204: description: The request to delete the cloud VM cluster was accepted. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Deletes the specified cloud VM cluster. tags: - database x-related-resource: '#/definitions/CloudVmCluster' get: description: 'Gets information about the specified cloud VM cluster. Applies to Exadata Cloud Service instances and Autonomous Database on dedicated Exadata infrastructure only. ' operationId: GetCloudVmCluster parameters: - $ref: '#/components/parameters/CloudVmClusterIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: Information about the cloud VM cluster. 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/CloudVmCluster' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetCloudVmCluster tags: - database x-example: 'GET /20160918/cloudVmClusters/<cloudVmClusterId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' put: description: 'Updates the specified cloud VM cluster. Applies to Exadata Cloud Service instances and Autonomous Database on dedicated Exadata infrastructure only. ' operationId: UpdateCloudVmCluster parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/CloudVmClusterIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: The request was successfully received and the cloud VM cluster update is in progress. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/CloudVmCluster' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Updates the specified cloud VM cluster. tags: - database x-example: "PUT /20160918/cloudVmClusters/<cloudVmClusterId>\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"cpuCoreCount\" : 10,\n \"licenseModel\" : \"LICENSE_INCLUDED\"\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateCloudVmClusterDetails' description: Request to update the attributes of a cloud VM cluster. required: true /cloudVmClusters/{cloudVmClusterId}/CloudVmClusterIormConfig: get: description: 'Gets the IORM configuration for the specified cloud VM cluster in an Exadata Cloud Service instance. If you have not specified an IORM configuration, the default configuration is returned. ' operationId: GetCloudVmClusterIormConfig parameters: - $ref: '#/components/parameters/CloudVmClusterIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: An object containing the list of databases in the specified cloud VM cluster and their IORM settings. 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/ExadataIormConfig' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' tags: - database x-example: 'GET /20160918/cloudVmClusters/<cloudVmClusterId>/CloudVmClusterIormConfig Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/CloudVmCluster' put: description: 'Updates the IORM settings for the specified cloud VM cluster in an Exadata Cloud Service instance. ' operationId: UpdateCloudVmClusterIormConfig parameters: - $ref: '#/components/parameters/CloudVmClusterIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: An object containing the list of databases and their IORM settings. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ExadataIormConfig' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' tags: - database x-example: 'PUT /20160918/cloudVmClusters/<cloudVmClusterId>/CloudVmClusterIormConfig Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/CloudVmCluster' requestBody: content: application/json: schema: $ref: '#/components/schemas/ExadataIormConfigUpdateDetails' description: Request to perform database update. required: true /cloudVmClusters/{cloudVmClusterId}/actions/addVirtualMachine: post: description: 'Add Virtual Machines to the Cloud VM cluster. Applies to Exadata Cloud instances only. ' operationId: AddVirtualMachineToCloudVmCluster parameters: - $ref: '#/components/parameters/CloudVmClusterIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: The request was successfully received and the adding Virtual Machines action is being performed. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/CloudVmCluster' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: AddVirtualMachineToCloudVmCluster tags: - database x-example: "POST /20160918/cloudVmClusters/<cloudVmClusterId>/actions/addVirtualMachine\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"dbServers\" : [\n {\n \"dbServerId\" : \"ocid1.dbserver.oc1.\"\n },\n {\n \"dbServerId\" : \"ocid1.dbserver.oc1.\"\n }\n ]\n}\n" x-related-resource: '#/definitions/CloudVmCluster' requestBody: content: application/json: schema: $ref: '#/components/schemas/AddVirtualMachineToCloudVmClusterDetails' description: Request to add Virtual Machines to the Cloud VM cluster. required: true /cloudVmClusters/{cloudVmClusterId}/actions/changeCompartment: post: description: 'Moves a cloud VM cluster and its dependent resources to another compartment. Applies to Exadata Cloud Service instances and Autonomous Database on dedicated Exadata infrastructure only. ' operationId: ChangeCloudVmClusterCompartment parameters: - $ref: '#/components/parameters/CloudVmClusterIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: The request was successfully received and the change compartment action is being performed. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ChangeCloudVmClusterCompartment tags: - database x-related-resource: '#/definitions/CloudVmCluster' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeCloudVmClusterCompartmentDetails' description: Request to move cloud VM cluster to a different compartment required: true /cloudVmClusters/{cloudVmClusterId}/actions/changeSubscription: post: description: 'Associate a cloud VM cluster with a different subscription. ' operationId: ChangeCloudVmClusterSubscription parameters: - $ref: '#/components/parameters/CloudVmClusterIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: The request was successfully received and the update subscription action is being performed. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ChangeCloudVmClusterSubscription tags: - database x-related-resource: '#/definitions/CloudVmCluster' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeCloudVmClusterSubscriptionDetails' description: Associate a cloud VM cluster with a different subscription. required: true /cloudVmClusters/{cloudVmClusterId}/actions/registerPkcs: post: description: 'Install the PKCS11 driver for given keystore type ' operationId: RegisterCloudVmClusterPkcs parameters: - $ref: '#/components/parameters/CloudVmClusterIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: The request was successfully received and registering pkcs rpm action is being performed. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: RegisterCloudVmClusterPkcs tags: - database x-example: "POST /20160918/cloudVmClusters/<cloudVmClusterId>/actions/registerPkcs\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"tdeKeyStoreType\" : \"AZURE\"\n}\n" x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/CloudVmCluster' requestBody: content: application/json: schema: $ref: '#/components/schemas/RegisterCloudVmClusterPkcsDetails' description: Details of registering PKCS11 driver. required: true /cloudVmClusters/{cloudVmClusterId}/actions/removeVirtualMachine: post: description: 'Remove Virtual Machines from the Cloud VM cluster. Applies to Exadata Cloud instances only. ' operationId: RemoveVirtualMachineFromCloudVmCluster parameters: - $ref: '#/components/parameters/CloudVmClusterIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: The request was successfully received and the removing Virtual Machines action is being performed. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/CloudVmCluster' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: RemoveVirtualMachineFromCloudVmCluster tags: - database x-example: "POST /20160918/cloudVmClusters/<cloudVmClusterId>/actions/removeVirtualMachine\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"dbServers\" : [\n {\n \"dbServerId\" : \"ocid1.dbserver.oc1.\"\n },\n {\n \"dbServerId\" : \"ocid1.dbserver.oc1.\"\n }\n ]\n}\n" x-related-resource: '#/definitions/CloudVmCluster' requestBody: content: application/json: schema: $ref: '#/components/schemas/RemoveVirtualMachineFromCloudVmClusterDetails' description: Request to remove Virtual Machines from the Cloud VM cluster. required: true /cloudVmClusters/{cloudVmClusterId}/actions/unregisterPkcs: post: description: 'Uninstall the PKCS11 driver for given keystore type ' operationId: UnregisterCloudVmClusterPkcs parameters: - $ref: '#/components/parameters/CloudVmClusterIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: The request was successfully received and unregistering pkcs rpm action is being performed. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UnregisterCloudVmClusterPkcs tags: - database x-example: "POST /20160918/cloudVmClusters/<cloudVmClusterId>/actions/unregisterPkcs\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"tdeKeyStoreType\" : \"AZURE\"\n}\n" x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/CloudVmCluster' requestBody: content: application/json: schema: $ref: '#/components/schemas/UnregisterCloudVmClusterPkcsDetails' description: Details of registering PKCS11 driver. required: true /cloudVmClusters/{cloudVmClusterId}/updateHistoryEntries: get: description: 'Gets the history of the maintenance update actions performed on the specified cloud VM cluster. Applies to Exadata Cloud Service instances only. ' operationId: ListCloudVmClusterUpdateHistoryEntries parameters: - $ref: '#/components/parameters/CloudVmClusterIdPathParam' - $ref: '#/components/parameters/FilterByCloudVmClusterUpdateTypeQueryParam' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: The maintenance update history for the specified cloud VM cluster. 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/UpdateHistoryEntrySummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListCloudVmClusterUpdateHistoryEntries tags: - database x-example: 'GET /20160918/cloudVmClusters/<cloudVmClusterId>/updateHistoryEntries?limit=100 Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/UpdateHistoryEntry' /cloudVmClusters/{cloudVmClusterId}/updateHistoryEntries/{updateHistoryEntryId}: get: description: 'Gets the maintenance update history details for the specified update history entry. Applies to Exadata Cloud Service instances only. ' operationId: GetCloudVmClusterUpdateHistoryEntry parameters: - $ref: '#/components/parameters/CloudVmClusterIdPathParam' - $ref: '#/components/parameters/UpdateHistoryEntryIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: The maintenance update history details for the specified update history entry. 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/UpdateHistoryEntry' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetCloudVmClusterUpdateHistoryEntry tags: - database x-example: 'GET /20160918/cloudVmClusters/<cloudVmClusterId>/updateHistoryEntries/<updateHistoryEntryId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/UpdateHistoryEntry' /cloudVmClusters/{cloudVmClusterId}/updates: get: description: 'Lists the maintenance updates that can be applied to the specified cloud VM cluster. Applies to Exadata Cloud Service instances only. ' operationId: ListCloudVmClusterUpdates parameters: - $ref: '#/components/parameters/CloudVmClusterIdPathParam' - $ref: '#/components/parameters/FilterByCloudVmClusterUpdateTypeQueryParam' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: A list of the maintenance update packages. 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/UpdateSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListCloudVmClusterUpdates tags: - database x-example: 'GET /20160918/cloudVmClusters/<cloudVmClusterId>/updates?limit=10 Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/Update' /cloudVmClusters/{cloudVmClusterId}/updates/{updateId}: get: description: 'Gets information about a specified maintenance update package for a cloud VM cluster. Applies to Exadata Cloud Service instances only. ' operationId: GetCloudVmClusterUpdate parameters: - $ref: '#/components/parameters/CloudVmClusterIdPathParam' - $ref: '#/components/parameters/UpdateIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: The maintenance update package. 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/Update' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetCloudVmClusterUpdate tags: - database x-example: 'GET /20160918/cloudVmClusters/<cloudVmClusterId>/updates/<updateId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/Update' /databaseSoftwareImages: get: description: 'Gets a list of the database software images in the specified compartment. ' operationId: ListDatabaseSoftwareImages parameters: - $ref: '#/components/parameters/CompartmentId' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' - $ref: '#/components/parameters/ListDatabaseSoftwareImagesSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ListDatabaseSoftwareImagesFilterByLifecycleStateQueryParam' - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' - $ref: '#/components/parameters/ListDatabaseSoftwareImagesFilterByImageTypeQueryParam' - $ref: '#/components/parameters/ListDatabaseSoftwareImagesFilterByImageShapeFamilyQueryParam' - $ref: '#/components/parameters/PatchSetGreaterThanOrEqualToQueryParam' - $ref: '#/components/parameters/OptionalDatabaseUpgradeSupportedQueryParam' responses: 200: description: Retrieved the list of all the Database software images. 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/DatabaseSoftwareImageSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListDatabaseSoftwareImages tags: - database x-example: "Example I:\n GET /20160918/databaseSoftwareImages?compartmentId=<compartmentId>&limit=10\n Host: database.us-phoenix-1.oraclecloud.com\n <authorization and other headers>\n" x-related-resource: '#/definitions/DatabaseSoftwareImage' post: description: 'create database software image in the specified compartment. ' operationId: CreateDatabaseSoftwareImage parameters: - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The request was successfully received and the database software image creation is in progress. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DatabaseSoftwareImage' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateDatabaseSoftwareImage tags: - database x-example: "Example I:\n POST /20160918/databaseSoftwareImages\n Host: database.us-phoenix-1.oraclecloud.com\n <authorization and other headers>\n {\n \"compartmentId\" : \"ocid1.tenancy.oc1..<unique_ID>\",\n \"databaseVersion\" : \"19c\",\n \"displayName\" : \"image1\"\n \"patchSet\" : \"19.6.0.0.0\"\n \"databaseSoftwareImageOneoffPatches\": \"123456, 987654, 246802\"\n }\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateDatabaseSoftwareImageDetails' description: Request to create database software image. required: true /databaseSoftwareImages/{databaseSoftwareImageId}: delete: description: Delete a database software image operationId: DeleteDatabaseSoftwareImage parameters: - $ref: '#/components/parameters/DatabaseSoftwareImageIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 204: description: The request to delete database software image was accepted. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: DeleteDatabaseSoftwareImage tags: - database x-example: 'DELETE /20160918/databaseSoftwareImages/<databaseSoftwareImageId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/DatabaseSoftwareImage' get: description: Gets information about the specified database software image. operationId: GetDatabaseSoftwareImage parameters: - $ref: '#/components/parameters/DatabaseSoftwareImageIdPathParam' responses: 200: description: The Database Software Image. 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/DatabaseSoftwareImage' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetDatabaseSoftwareImage tags: - database x-example: 'GET /20160918/dbSystems/<databaseSoftwareImageId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' put: description: Updates the properties of a Database Software Image, like Display Nmae operationId: UpdateDatabaseSoftwareImage parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/DatabaseSoftwareImageIdPathParam' responses: 200: description: The Database Software Image. 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/DatabaseSoftwareImage' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdateDatabaseSoftwareImage tags: - database x-example: "Example I:\n PUT /latest/databaseSoftwareImages/<databaseSoftwareImageId>\n Host: database.us-phoenix-1.oraclecloud.com\n <authorization and other headers>\n {\n \"displayName\" : \"image2\"\n }\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateDatabaseSoftwareImageDetails' description: Request to update the properties of a DB system. required: true /databaseSoftwareImages/{databaseSoftwareImageId}/actions/changeCompartment: post: description: 'Move the Database Software Image and its dependent resources to the specified compartment. For more information about moving Databse Software Images, see [Moving Database Resources to a Different Compartment](/Content/Database/Concepts/databaseoverview.htm#moveRes). ' operationId: ChangeDatabaseSoftwareImageCompartment parameters: - $ref: '#/components/parameters/DatabaseSoftwareImageIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: The request was successfully received and the change compartment action is being performed. 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 of the work request. schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ChangeDatabaseSoftwareImageCompartment tags: - database x-example: "POST /20160918/databaseSoftwareImages/<dbSystemId>/actions/changeCompartment\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\" : \"ocid.compartment.oc1..<unique_ID>\"\n}\n" x-related-resource: '#/definitions/DatabaseSoftwareImage' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeCompartmentDetails' description: Request to move Database Software Image to a different compartment required: true /databases: get: description: 'Gets a list of the databases in the specified Database Home. ' operationId: ListDatabases parameters: - $ref: '#/components/parameters/CompartmentId' - $ref: '#/components/parameters/DbHomeIdQueryParam' - $ref: '#/components/parameters/SystemIdQueryParam' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' - $ref: '#/components/parameters/ListDatabasesSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ListDatabasesFilterByLifecycleStateQueryParam' - $ref: '#/components/parameters/FilterByDbNameQueryParam' responses: 200: description: The list of the databases was retrieved. 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/DatabaseSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListDatabases tags: - database x-example: 'GET /20160918/databases?compartmentId=<compartmentId>&systemId=<systemId>&dbHomeId=<dbHomeId>&limit=10 Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/Database' post: description: 'Creates a new database in the specified Database Home. If the database version is provided, it must match the version of the Database Home. Applies to Exadata and Exadata Cloud@Customer systems. ' operationId: CreateDatabase parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: The request was successfully received and the database create is in-progress. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Database' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateDatabase tags: - database x-example: "Example I:\n POST /20160918/databases\n Host: database.us-phoenix-1.oraclecloud.com\n <authorization and other headers>\n {\n \"dbHomeId\" : \"ocid1.dbhome.oc1.phx.<unique_ID>\",\n \"source\": \"NONE\",\n \"database\" : {\n \"adminPassword\" : \"<password>\",\n \"dbName\" : \"myTestDb\",\n \"dbBackupConfig\" : {\n \"recoveryWindowInDays\" : 30,\n \"autoBackupEnabled\" : true\n }\n }\n ,\n \"kmsKeyId\" : \"ocid1.key.oc1..<unique_ID>\",\n \"kmsKeyVersionId\" : \"ocid1.keyversion.oc1..<unique_ID>\"\n }\nExample II:\n POST /20160918/databases\n Host: database.us-phoenix-1.oraclecloud.com\n <authorization and other headers>\n {\n \"dbHomeId\" : \"ocid1.dbhome.oc1.phx.<unique_ID>\",\n \"source\": \"DB_BACKUP\",\n \"database\" : {\n \"backupId\" : \"ocid1.backup.oc1.phx.<unique_ID>\",\n \"backupTDEPassword\" : \"<password>\",\n \"adminPassword\" : \"<password>\"\n }\n }\nExample III:\n POST /20160918/databases\n Host: database.us-phoenix-1.oraclecloud.com\n <authorization and other headers>\n {\n \"dbHomeId\" : \"ocid1.dbhome.oc1.phx.<unique_ID>\",\n \"source\": \"DATAGUARD\",\n \"database\" : {\n \"databaseAdminPassword\": \"<password>\",\n \"dbUniqueName\": \"testUniqueName\",\n \"protectionMode\": \"MAXIMUM_PERFORMANCE\",\n \"sourceTdeWalletPassword\": \"<password>\",\n \"isActiveDataGuardEnabled\": \"TRUE\",\n \"sidPrefix\": \"testSidPrefix\",\n \"sourceDatabaseId\": \"ocid1.database.oc1.phx.<unique_ID>\",\n \"transportType\": \"ASYNC\"\n }\n }\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateDatabaseBase' description: Request to create a new database. required: true /databases/{databaseId}: delete: description: 'Deletes the specified database. Applies only to Exadata systems. The data in this database is local to the Exadata system and will be lost when the database is deleted. Oracle recommends that you back up any data in the Exadata system prior to deleting it. You can use the `performFinalBackup` parameter to have the Exadata system database backed up before it is deleted. ' operationId: DeleteDatabase parameters: - $ref: '#/components/parameters/DatabaseIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/PerformFinalBackupParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 204: description: The request to delete the database was received. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: DeleteDatabase tags: - database x-example: 'DELETE /20160918/databases/<databaseId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/Database' get: description: Gets information about the specified database. operationId: GetDatabase parameters: - $ref: '#/components/parameters/DatabaseIdPathParam' responses: 200: description: The database information was retrieved. 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/Database' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetDatabase tags: - database x-example: 'GET /20160918/databases/<databaseId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' put: description: 'Update the specified database based on the request parameters provided. ' operationId: UpdateDatabase parameters: - $ref: '#/components/parameters/DatabaseIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: The request was successfully received and the database update is in progress. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Database' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdateDatabase tags: - database x-example: "PUT /latest/databases/<databaseId>\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"dbBackupConfig\" :\n {\n \"recoveryWindowInDays\" : 30,\n \"autoBackupEnabled\" : true\n }\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateDatabaseDetails' description: Request to perform database update. required: true /databases/{databaseId}/actions/changeEncryptionKeyLocation: post: description: Update the encryption key management location for the database operationId: ChangeEncryptionKeyLocation parameters: - $ref: '#/components/parameters/DatabaseIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' responses: 202: description: 'The request was successfully received and the migrate key action is being performed. ' 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Change encryption key location tags: - database x-example: "POST /20160918/databases/<databaseId>/actions/changeEncryptionKeyLocation\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"hsmPassword\" : \"<hsm password>\"\n}\n" x-obmcs-terraform: actionType: UPDATE_FIELD x-related-resource: '#/definitions/Database' requestBody: content: application/json: schema: $ref: '#/components/schemas/EncryptionKeyLocationDetails' description: Request to change the source of the encryption key for the database. required: true /databases/{databaseId}/actions/convertToPdb: post: description: 'Converts a non-container database to a pluggable database. ' operationId: ConvertToPdb parameters: - $ref: '#/components/parameters/DatabaseIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: The request was successfully received and the action is being performed. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Database' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ConvertToPdb tags: - database x-example: "POST /20160918/databases/<databaseId>/actions/convertToPdb\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n {\n \"convertToPdbTargetDetails\" : {\n \"source\" : \"NEW_DATABASE\",\n \"cdbName\" : \"myTestDb\",\n \"cdbAdminPassword\" : \"<password>\",\n \"nonCdbTdeWalletPassword\" : \"<password>\"\n },\n \"action\" : \"PRECHECK\"\n }\n" x-related-resource: '#/definitions/Database' requestBody: content: application/json: schema: $ref: '#/components/schemas/ConvertToPdbDetails' description: 'Request to convert a non-container database to a pluggable database. ' required: true /databases/{databaseId}/actions/disableDatabaseManagement: post: description: 'Disables the Database Management service for the database. ' operationId: DisableDatabaseManagement parameters: - $ref: '#/components/parameters/DatabaseIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: The request was successfully received and Database Management service is being disabled. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Database' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Disables the Database Management service for the database. tags: - database x-example: 'POST /20160918/databases/<databaseId>/actions/disableDatabaseManagement Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/Database' /databases/{databaseId}/actions/enableDatabaseManagement: post: description: Enables the Database Management service for an Oracle Database located in Oracle Cloud Infrastructure. This service allows the database to access tools including Metrics and Performance hub. Database Management is enabled at the container database (CDB) level. operationId: EnableDatabaseManagement parameters: - $ref: '#/components/parameters/DatabaseIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: The request was successfully received and Database Management is being enabled. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Database' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Enables the Database Management service for an Oracle Database located in Oracle Cloud Infrastructure. tags: - database x-example: "Example I - Enable Database Management with TCP protocol:\n POST /20160918/databases/<databaseId>/actions/enableDatabaseManagement\n Host: database.us-phoenix-1.oraclecloud.com\n <authorization and other headers>\n {\n \"credentialDetails\" :\n {\n \"userName\" : \"dbUser_1\",\n \"passwordSecretId\" : \"ocid1.vaultsecret.oc1.phx.amaaaaaaqn2gl2iahl4b5q4u6ux3nhvnznyvjkuu6p7vlgpxt2bnmmmmmmmm\"\n },\n \"privateEndPointId\" : \"ocid1.dbmanagementprivateendpoint.oc1.phx.amaaaaaaet6wzjya46nhydueyc3p3vtvqg4ubsrpfd4q26wvrjsicqunnnnn\",\n \"managementType\" : \"BASIC\",\n \"serviceName\" : \"DB0510_phx23p.sub04302048065.abcd123.oraclevcn.com\"\n }\n" x-related-resource: '#/definitions/Database' requestBody: content: application/json: schema: $ref: '#/components/schemas/EnableDatabaseManagementDetails' description: Request to enable the Database Management service for an Oracle Database located in Oracle Cloud Infrastructure. required: true /databases/{databaseId}/actions/migrateKey: post: description: Changes encryption key management from customer-managed, using the [Vault service](/iaas/Content/KeyManagement/Concepts/keyoverview.htm), to Oracle-managed. operationId: MigrateVaultKey parameters: - $ref: '#/components/parameters/DatabaseIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' responses: 202: description: 'The request was successfully received and the migrate key action is being performed. ' 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Database' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Migrate Key tags: - database x-example: "POST /20160918/databases/<databaseId>/actions/migrateKey\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"primaryKey\" : \"ocid1.key.oc1.phx.<unique_ID>\",\n}\n" x-related-resource: '#/definitions/Database' requestBody: content: application/json: schema: $ref: '#/components/schemas/MigrateVaultKeyDetails' description: Request to change the source of the encryption key for the database. required: true /databases/{databaseId}/actions/modifyDatabaseManagement: post: description: Updates one or more attributes of the Database Management service for the database. operationId: ModifyDatabaseManagement parameters: - $ref: '#/components/parameters/DatabaseIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: The request was successfully received and Database Management configuration is being 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 opc-work-request-id: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Database' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Updates one or more attributes of the Database Management service for the database. tags: - database x-example: "POST /20160918/databases/<databaseId>/actions/updateDatabaseManagement\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"credentialDetails\" :\n {\n \"userName\" : \"dbUser_2\",\n \"passwordSecretId\" : \"ocid1.vaultsecret.oc1.phx.amaaaaaaqn2gl2iahl4b5q4u6ux3nhvnznyvjkuu6p7vlgpxt2bnmmmmmmmm\"\n },\n \"privateEndPointId\" : \"ocid1.dbmanagementprivateendpoint.oc1.phx.amaaaaaaet6wzjya46nhydueyc3p3vtvqg4ubsrpfd4q26wvrjsicqunnnnn\",\n \"managementType\" : \"ADVANCED\",\n \"serviceName\" : \"DB0630_phx23p.sub04302048065.abcd123.oraclevcn.com\"\n}\n" x-related-resource: '#/definitions/Database' requestBody: content: application/json: schema: $ref: '#/components/schemas/ModifyDatabaseManagementDetails' description: The data to update one or more attributes of the Database Management Service for the database. required: true /databases/{databaseId}/actions/rescheduleManagedDbSoftwareUpdate: post: description: 'Reschedule the Managed Database Software Update ' operationId: RescheduleManagedDbSoftwareUpdate parameters: - $ref: '#/components/parameters/DatabaseIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: The request was successfully received and the managed database software update reschedule operation is in progress. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Database' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: RescheduleManagedDbSoftwareUpdate tags: - database x-example: 'POST /20160918/databases/<databaseId>/actions/reschedule Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-obmcs-terraform: actionType: MANAGEMENT_RESOURCE x-related-resource: '#/definitions/Database' /databases/{databaseId}/actions/restore: post: description: 'Restore a Database based on the request parameters you provide. ' operationId: RestoreDatabase parameters: - $ref: '#/components/parameters/DatabaseIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: The request was successfully received and the Database restore is in-progress. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Database' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: RestoreDatabase tags: - database x-example: "POST /20160918/databases/<databaseId>/actions/restore\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"restoreDetails\" :\n {\n \"databaseSCN\" : null,\n \"timestamp\" : null,\n \"latest\" : true\n }\n}\n" x-related-resource: '#/definitions/Database' requestBody: content: application/json: schema: $ref: '#/components/schemas/RestoreDatabaseDetails' description: Request to perform database restore. required: true /databases/{databaseId}/actions/rotateKey: post: description: Creates a new version of an existing [Vault service](/iaas/Content/KeyManagement/Concepts/keyoverview.htm) key. operationId: RotateVaultKey parameters: - $ref: '#/components/parameters/DatabaseIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' responses: 202: description: 'The request was successfully received and the key is being rotated. ' 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Database' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Rotate Key tags: - database x-example: 'POST /20160918/databases/<databaseId>/actions/rotateKey Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/Database' /databases/{databaseId}/actions/upgrade: post: description: 'Upgrades the specified Oracle Database instance. ' operationId: UpgradeDatabase parameters: - $ref: '#/components/parameters/DatabaseIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: The request was successfully received and the action is being performed. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Database' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpgradeDatabase tags: - database x-example: "POST /20160918/databases/<databaseId>/actions/upgrade\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n {\n \"databaseUpgradeSourceDetails\" : {\n \"dbVersion\" : \"19.7.0.0\",\n \"source\" : \"DB_VERSION\"\n },\n \"action\" : \"PRECHECK\"\n }\n" x-related-resource: '#/definitions/Database' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpgradeDatabaseDetails' description: Request to perform a database upgrade. required: true /databases/{databaseId}/dataGuard/actions/convertToStandalone: post: description: "Disassociate the standby database identified by the `databaseId` parameter from existing Data Guard group. \n\nConvert the standby to a standalone database. \n\nThis operation should be performed on respective standby database.\n" operationId: ConvertToStandalone parameters: - $ref: '#/components/parameters/DatabaseIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: The request was accepted for processing. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Database' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Convert a standby database to a standalone database. tags: - database x-example: "POST /20160918/databases/<databaseId>/dataGuard/actions/convertToStandalone\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"databaseAdminPassword\" : \"<password>\"\n}\n" x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/Database' requestBody: content: application/json: schema: $ref: '#/components/schemas/ConvertToStandaloneDetails' description: A request to update an existing Data Guard member. required: true /databases/{databaseId}/dataGuard/actions/failover: post: description: 'Performs a failover to transition the standby database identified by the `databaseId` path parameter into the primary role after the existing primary database fails or becomes unreachable. A failover might result in data loss depending on the protection mode in effect at the time of the primary database failure. This operation should be performed on respective standby database. ' operationId: FailoverDataGuard parameters: - $ref: '#/components/parameters/DatabaseIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: The request was accepted for processing. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Database' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Performs a failover to transition a standby database into the primary database role. tags: - database x-example: "POST /20160918/databases/<databaseId>/dataGuard/actions/failover\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"databaseAdminPassword\" : \"<password>\"\n}\n" x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/Database' requestBody: content: application/json: schema: $ref: '#/components/schemas/FailoverDataGuardDetails' description: A request to update an existing Data Guard member. required: true /databases/{databaseId}/dataGuard/actions/reinstate: post: description: "Reinstates the database identified by the `databaseId` parameter into the standby role in a Data Guard association. \n\nThis operation should be performed on disabled standby database.\n" operationId: ReinstateDataGuard parameters: - $ref: '#/components/parameters/DatabaseIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: The request was accepted for processing. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Database' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Reinstates a database to a Data Guard association standby role. tags: - database x-example: "POST /20160918/databases/<databaseId>/dataGuard/actions/reinstate\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"databaseAdminPassword\" : \"<password>\",\n \"sourceDatabaseId\" : \"ocid1.dbsystem.oc1.phx.<unique_ID>\"\n}\n" x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/Database' requestBody: content: application/json: schema: $ref: '#/components/schemas/ReinstateDataGuardDetails' description: A request to update an existing Data Guard member. required: true /databases/{databaseId}/dataGuard/actions/switchover: post: description: 'Performs a switchover to transition primary database of this Data Guard association into a standby role. The standby database associated with the `dataGuardAssociationId` assumes the primary database role. A switchover guarantees no data loss. This operation should be performed on respective standby database. ' operationId: SwitchOverDataGuard parameters: - $ref: '#/components/parameters/DatabaseIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: The request was accepted for processing. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Database' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Performs a switchover to transition the primary database of a Data Guard association into a standby role. tags: - database x-example: "POST /20160918/databases/<databaseId>/dataGuard/actions/switchover\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"databaseAdminPassword\" : \"<password>\"\n}\n" x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/Database' requestBody: content: application/json: schema: $ref: '#/components/schemas/SwitchOverDataGuardDetails' description: A request to update an existing Data Guard member. required: true /databases/{databaseId}/dataGuard/actions/updateDataGuard: post: description: 'Update an existing Data Guard member. A Data Guard member represents the replication relationship between the specified database and a standby database. For more information, see [Using Oracle Data Guard](/Content/Database/Tasks/usingdataguard.htm). ' operationId: UpdateDataGuard parameters: - $ref: '#/components/parameters/DatabaseIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: The request was accepted for processing. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Database' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Updates an existing Data Guard member. tags: - database x-example: "POST /20160918/databases/<databaseId>/dataGuard/actions/updateDataGuard\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"databaseAdminPassword\" : \"<password>\",\n \"isActiveDataGuardEnabled\" : true,\n \"protectionMode\" : \"MAXIMUM_PERFORMANCE\",\n \"transportType\" : \"ASYNC\"\n}\n" x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/Database' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateDataGuardDetails' description: A request to update an existing Data Guard member. required: true /databases/{databaseId}/dataGuardAssociations: get: description: 'Lists all Data Guard associations for the specified database. ' operationId: ListDataGuardAssociations parameters: - $ref: '#/components/parameters/DatabaseIdPathParam' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' responses: 200: description: The list is being retrieved. 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/DataGuardAssociationSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Lists all Data Guard associations for the specified database. tags: - database x-example: 'GET /20160918/databases/<databaseId>/dataguardassociations?limit=100 Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/DataGuardAssociation' post: description: 'Creates a new Data Guard association. A Data Guard association represents the replication relationship between the specified database and a peer database. For more information, see [Using Oracle Data Guard](/Content/Database/Tasks/usingdataguard.htm). All Oracle Cloud Infrastructure resources, including Data Guard associations, get an Oracle-assigned, unique ID called an Oracle Cloud Identifier (OCID). When you create a resource, you can find its OCID in the response. You can also retrieve a resource''s OCID by using a List API operation on that resource type, or by viewing the resource in the Console. For more information, see [Resource Identifiers](/Content/General/Concepts/identifiers.htm). ' operationId: CreateDataGuardAssociation parameters: - $ref: '#/components/parameters/DatabaseIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The request was accepted for processing. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DataGuardAssociation' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Creates a Data Guard association. tags: - database x-example: "POST /20160918/databases/<databaseId>/dataguardassociations\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"databaseAdminPassword\" : \"<password>\"\n \"protectionMode\" : \"MAXIMUM_PERFORMANCE\"\n \"creationType\" : \"ExistingDbSystem\"\n \"transportType\" : \"ASYNC\",\n \"peerDbSystemId\" : \"ocid1.dbsystem.oc1.phx.<unique_ID>\"\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateDataGuardAssociationDetails' description: A request to create a Data Guard association. required: true /databases/{databaseId}/dataGuardAssociations/{dataGuardAssociationId}: get: description: 'Gets the specified Data Guard association''s configuration information. ' operationId: GetDataGuardAssociation parameters: - $ref: '#/components/parameters/DatabaseIdPathParam' - $ref: '#/components/parameters/DataGuardAssociationIdPathParam' responses: 200: description: The configuration information is being retrieved. 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/DataGuardAssociation' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets configuration information for the specified database and Data Guard association. tags: - database x-example: 'GET /20160918/databases/<databaseId>/dataguardassociations/<dataguardAssociationId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' put: description: 'Updates the Data Guard association the specified database. This API can be used to change the `protectionMode` and `transportType` of the Data Guard association. ' operationId: UpdateDataGuardAssociation parameters: - $ref: '#/components/parameters/DatabaseIdPathParam' - $ref: '#/components/parameters/DataGuardAssociationIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: The request was accepted for processing. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DataGuardAssociation' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Update Data Guard association of a database. tags: - database x-example: 'PUT /20160918/databases/<databaseId>/update Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/DataGuardAssociation' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateDataGuardAssociationDetails' description: A request to update Data Guard association of a database. required: true /databases/{databaseId}/dataGuardAssociations/{dataGuardAssociationId}/actions/failover: post: description: 'Performs a failover to transition the standby database identified by the `databaseId` parameter into the specified Data Guard association''s primary role after the existing primary database fails or becomes unreachable. A failover might result in data loss depending on the protection mode in effect at the time of the primary database failure. ' operationId: FailoverDataGuardAssociation parameters: - $ref: '#/components/parameters/DatabaseIdPathParam' - $ref: '#/components/parameters/DataGuardAssociationIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: The request was accepted for processing. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DataGuardAssociation' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Performs a failover to transition a standby database into the primary database role. tags: - database x-example: 'POST /20160918/databases/<databaseId>/actions/failover Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/DataGuardAssociation' requestBody: content: application/json: schema: $ref: '#/components/schemas/FailoverDataGuardAssociationDetails' description: A request to perform a failover, transitioning a standby database into a primary database. required: true /databases/{databaseId}/dataGuardAssociations/{dataGuardAssociationId}/actions/migrate: post: description: "Migrates the existing Data Guard association to new Data Guard model to support multiple standby databases functionality. \n\nThis operation should always be performed on primary.\n" operationId: MigrateDataGuardAssociationToMultiDataGuards parameters: - $ref: '#/components/parameters/DatabaseIdPathParam' - $ref: '#/components/parameters/DataGuardAssociationIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: The request was accepted for processing. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Database' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Enables existing Data Guard to support multiple standby databases. tags: - database x-example: 'POST /20160918/databases/<databaseId>/dataGuardAssociations/<dataGuardAssociationId>/actions/migrate Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/DataGuardAssociation' /databases/{databaseId}/dataGuardAssociations/{dataGuardAssociationId}/actions/reinstate: post: description: 'Reinstates the database identified by the `databaseId` parameter into the standby role in a Data Guard association. ' operationId: ReinstateDataGuardAssociation parameters: - $ref: '#/components/parameters/DatabaseIdPathParam' - $ref: '#/components/parameters/DataGuardAssociationIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: The request was accepted for processing. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DataGuardAssociation' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Reinstates a database to a Data Guard association standby role. tags: - database x-example: 'POST /20160918/databases/<databaseId>/actions/reinstate Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/DataGuardAssociation' requestBody: content: application/json: schema: $ref: '#/components/schemas/ReinstateDataGuardAssociationDetails' description: A request to reinstate a database in a standby role. required: true /databases/{databaseId}/dataGuardAssociations/{dataGuardAssociationId}/actions/switchover: post: description: 'Performs a switchover to transition the primary database of a Data Guard association into a standby role. The standby database associated with the `dataGuardAssociationId` assumes the primary database role. A switchover guarantees no data loss. ' operationId: SwitchoverDataGuardAssociation parameters: - $ref: '#/components/parameters/DatabaseIdPathParam' - $ref: '#/components/parameters/DataGuardAssociationIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: The request was accepted for processing. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DataGuardAssociation' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Performs a switchover to transition the primary database of a Data Guard association into a standby role. tags: - database x-example: 'POST /20160918/databases/<databaseId>/actions/switchover Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/DataGuardAssociation' requestBody: content: application/json: schema: $ref: '#/components/schemas/SwitchoverDataGuardAssociationDetails' description: Request to swtichover a primary to a standby. required: true /databases/{databaseId}/pdbConversionHistoryEntries: get: description: 'Gets the pluggable database conversion history for a specified database in a bare metal or virtual machine DB system. ' operationId: ListPdbConversionHistoryEntries parameters: - $ref: '#/components/parameters/DatabaseIdPathParam' - $ref: '#/components/parameters/FilterByPdbConversionActionQueryParam' - $ref: '#/components/parameters/FilterByPdbConversionLifecycleStateQueryParam' - $ref: '#/components/parameters/ListPdbConversionHistoryEntriesSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' responses: 200: description: The conversion history entries for the specified pluggable database. 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/PdbConversionHistoryEntrySummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListPdbConversionHistoryEntries tags: - database x-example: 'GET /20160918/databases/<databaseId>/pdbConversionHistoryEntries Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/Database' /databases/{databaseId}/pdbConversionHistoryEntries/{pdbConversionHistoryEntryId}: get: description: 'Gets the details of operations performed to convert the specified database from non-container (non-CDB) to pluggable (PDB). ' operationId: GetPdbConversionHistoryEntry parameters: - $ref: '#/components/parameters/DatabaseIdPathParam' - $ref: '#/components/parameters/PdbConversionHistoryEntryIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: The pluggable database conversion history. 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/PdbConversionHistoryEntry' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetPdbConversionHistoryEntry tags: - database x-example: 'GET /20160918/databases/<databaseId>/pdbConversionHistoryEntries/<pdbConversionHistoryEntryId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/PdbConversionHistoryEntry' /databases/{databaseId}/upgradeHistoryEntries: get: description: 'Gets the upgrade history for a specified database in a bare metal or virtual machine DB system. ' operationId: ListDatabaseUpgradeHistoryEntries parameters: - $ref: '#/components/parameters/DatabaseIdPathParam' - $ref: '#/components/parameters/FilterByUpgradeActionQueryParam' - $ref: '#/components/parameters/FilterByUpgradeLifecycleStateQueryParam' - $ref: '#/components/parameters/ListUpgradeHistoryEntriesSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' responses: 200: description: The upgrade history for the specified Database. 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/DatabaseUpgradeHistoryEntrySummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListDatabaseUpgradeHistoryEntries tags: - database x-example: 'GET /20160918/databases/<databaseId>/upgradeHistory Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/Database' /databases/{databaseId}/upgradeHistoryEntries/{upgradeHistoryEntryId}: get: description: 'gets the upgrade history for a specified database. ' operationId: GetDatabaseUpgradeHistoryEntry parameters: - $ref: '#/components/parameters/DatabaseIdPathParam' - $ref: '#/components/parameters/UpgradeHistoryEntryIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: The database upgrade history. 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/DatabaseUpgradeHistoryEntry' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetDatabaseUpgradeHistoryEntry tags: - database x-example: 'GET /20160918/databases/<databaseId>/upgradeHistory/<upgradeHistoryId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/DatabaseUpgradeHistoryEntry' /dbConnectionBundles: get: description: 'Lists all database connection bundles that match the query parameters. ' operationId: ListDbConnectionBundles parameters: - $ref: '#/components/parameters/CompartmentId' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ListDbConnectionBundlesSortByQueryParam' - $ref: '#/components/parameters/ListDbConnectionBundlesFilterByLifecycleStateQueryParam' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' - $ref: '#/components/parameters/ListDbConnectionBundlesFilterByTypeQueryParam' - $ref: '#/components/parameters/OptionalAssociatedResourceIdQueryParam' responses: 200: description: Retrieved the list of all the database connection bundles. 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/DbConnectionBundleSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets a list of Database Connection Bundles in the specified compartment tags: - database x-example: 'GET /20160918/dbConnectionBundles?compartmentId=<compartmentId>&limit=10 Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/DbConnectionBundle' /dbConnectionBundles/{dbConnectionBundleId}: get: description: Gets information about the specified database connection bundle. operationId: GetDbConnectionBundle parameters: - $ref: '#/components/parameters/DbConnectionBundleIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: The specified database connection bundle object. 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/DbConnectionBundle' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets a database connection bundle. tags: - database x-example: 'GET /20160918/dbConnectionBundles/<dbConnectionBundleId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' /dbConnectionBundles/{dbConnectionBundleId}/actions/download: post: description: 'Downloads the specified database connection bundle content. The bundle is returned as a binary file containing the connection details. ' operationId: DownloadDbConnectionBundle parameters: - $ref: '#/components/parameters/DbConnectionBundleIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The database connection bundle content. headers: content-disposition: description: Specifies presentational information for the file attachment. schema: type: string content-length: description: Size of the content, in bytes. schema: type: integer format: int64 content-type: description: The content type of the body. schema: type: string etag: description: For optimistic concurrency control. See `if-match`. schema: type: string last-modified: description: The date and time the bundle was created, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. schema: type: string format: date-time 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/octet-stream: schema: format: binary type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Downloads a database connection bundle. tags: - database x-example: 'POST /20160918/dbConnectionBundles/<dbConnectionBundleId>/download Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/DbConnectionBundle' requestBody: content: application/json: schema: $ref: '#/components/schemas/DownloadDbConnectionBundleDetails' description: Request to download a database connection bundle. required: true /dbHomes: get: description: 'Lists the Database Homes in the specified DB system and compartment. A Database Home is a directory where Oracle Database software is installed. ' operationId: ListDbHomes parameters: - $ref: '#/components/parameters/CompartmentId' - $ref: '#/components/parameters/OptionalDbSystemIdQueryParam' - $ref: '#/components/parameters/OptionalVmClusterIdQueryParam' - $ref: '#/components/parameters/BackupIdQueryParam' - $ref: '#/components/parameters/DbVersionQueryParam' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' - $ref: '#/components/parameters/ListDbHomesSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ListDbHomesFilterByLifecycleStateQueryParam' - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' responses: 200: description: The list of Database Homes was retrieved. 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/DbHomeSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListDbHomes tags: - database x-example: 'GET /20160918/dbHomes?compartmentId=<compartmentId>&dbSystemId=<dbSystemId>&backupId=<backupId>&limit=10 Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/DbHome' post: description: 'Creates a new Database Home in the specified database system based on the request parameters you provide. Applies to bare metal DB systems, Exadata systems, and Exadata Cloud@Customer systems. ' operationId: CreateDbHome parameters: - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The request was successfully received and the Database Home creation is in progress. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DbHome' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateDbHome tags: - database x-example: "Example I: (Database Home with database details)\n POST /20160918/dbHomes\n Host: database.us-phoenix-1.oraclecloud.com\n <authorization and other headers>\n {\n \"dbSystemId\" : \"ocid1.dbsystem.oc1.phx.<unique_ID>\",\n \"displayName\" : \"createdDbHome\",\n \"source\": \"NONE\",\n \"dbVersion\" : \"12.1.0.2\",\n \"database\" : {\n \"adminPassword\" : \"<password>\",\n \"dbName\" : \"myTestDb\",\n \"dbUniqueName\" : \"myTestDb_phx1cs\",\n \"kmsKeyId\" : \"ocid1.key.oc1..<unique_ID>\",\n \"kmsKeyVersionId\" : \"ocid1.keyversion.oc1..<unique_ID>\",\n \"vaultId\" : \"ocid1.vault.oc1.phx.\",\n \"dbBackupConfig\" : {\n \"recoveryWindowInDays\" : 30,\n \"autoBackupEnabled\" : true\n }\n }\n }\nExample II: (With database details when the source is a backup)\n POST /20160918/dbHomes\n Host: database.us-phoenix-1.oraclecloud.com\n <authorization and other headers>\n {\n \"dbSystemId\" : \"ocid1.dbsystem.oc1.phx.<unique_ID>\",\n \"displayName\" : \"restoredDbHome\",\n \"source\": \"DB_BACKUP\",\n \"kmsKeyId\": \"ocid1.key.oc1..<unique_ID>\",\n \"kmsKeyVersionId\": \"ocid1.keyversion.oc1..<unique_ID>\"\n \"database\" : {\n \"backupId\" : \"ocid1.backup.oc1.phx.<unique_ID>\",\n \"backupTDEPassword\" : \"<password>\",\n \"adminPassword\" : \"<password>\"\n }\n }\nExample III (Without database details. Creates an empty Database Home.):\n POST /20160918/dbHomes\n Host: database.us-phoenix-1.oraclecloud.com\n <authorization and other headers>\n {\n \"dbSystemId\" : \"ocid1.dbsystem.oc1.phx.<unique_ID>\",\n \"displayName\" : \"createdDbHome\",\n \"source\": \"NONE\",\n \"dbVersion\" : \"12.1.0.2\",\n }\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateDbHomeBase' description: Request to create a new Database Home. required: true /dbHomes/{dbHomeId}: delete: description: 'Deletes a Database Home. Applies to bare metal DB systems, Exadata Cloud Service, and Exadata Cloud@Customer systems. Oracle recommends that you use the `performFinalBackup` parameter to back up any data on a bare metal DB system before you delete a Database Home. On an Exadata Cloud@Customer system or an Exadata Cloud Service system, you can delete a Database Home only when there are no databases in it and therefore you cannot use the `performFinalBackup` parameter to back up data. ' operationId: DeleteDbHome parameters: - $ref: '#/components/parameters/DbHomeIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/PerformFinalBackupParam' responses: 204: description: The request to delete the Database Home was received. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: DeleteDbHome tags: - database x-example: 'DELETE /20160918/dbHomes/<dbHomeId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/DbHome' get: description: Gets information about the specified Database Home. operationId: GetDbHome parameters: - $ref: '#/components/parameters/DbHomeIdPathParam' responses: 200: description: The Database Home. 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/DbHome' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetDbHome tags: - database x-example: 'GET /20160918/dbHomes/<dbHomeId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' put: description: Patches the specified Database Home. operationId: UpdateDbHome parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/DbHomeIdPathParam' responses: 200: description: The request was successfully received and the Database Home update is in progress. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DbHome' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdateDbHome tags: - database x-example: "Example I:\n PUT /latest/dbHomes/<dbHomeId>\n Host: database.us-phoenix-1.oraclecloud.com\n <authorization and other headers>\n {\n \"dbVersion\" : {\n \"patchId\" : \"ocid1.dbpatch.oc1.phx.<unique_ID>\",\n \"action\" : \"APPLY\"\n }\n }\nExample II:\n PUT /latest/dbHomes/<dbHomeId>\n Host: database.us-phoenix-1.oraclecloud.com\n <authorization and other headers>\n {\n \"dbVersion\" : {\n \"databaseSoftwareImageId\" : \"ocid1.databasesoftwareimage.oc1.phx.<unique_ID>\",\n \"action\" : \"APPLY\"\n }\n }\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateDbHomeDetails' description: Request to update the properties of a Database Home. required: true /dbHomes/{dbHomeId}/patchHistoryEntries: get: description: 'Lists the history of patch operations on the specified Database Home. ' operationId: ListDbHomePatchHistoryEntries parameters: - $ref: '#/components/parameters/DbHomeIdPathParam' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' responses: 200: description: The patch history for the specified Database Home was retrieved. 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/PatchHistoryEntrySummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListDbHomePatchHistoryEntries tags: - database x-example: 'GET /20160918/dbHomes/<dbHomeId>/patchHistoryEntries?limit=100 Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/PatchHistoryEntry' /dbHomes/{dbHomeId}/patchHistoryEntries/{patchHistoryEntryId}: get: description: 'Gets the patch history details for the specified patchHistoryEntryId ' operationId: GetDbHomePatchHistoryEntry parameters: - $ref: '#/components/parameters/DbHomeIdPathParam' - $ref: '#/components/parameters/PatchHistoryEntryIdPathParam' responses: 200: description: The patch history details for the specified patchHistoryEntryId. 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/PatchHistoryEntry' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetDbHomePatchHistoryEntry tags: - database x-example: 'GET /20160918/patchHistoryEntries/<patchHistoryEntryId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/PatchHistoryEntry' /dbHomes/{dbHomeId}/patches: get: description: 'Lists patches applicable to the requested Database Home. ' operationId: ListDbHomePatches parameters: - $ref: '#/components/parameters/DbHomeIdPathParam' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' responses: 200: description: A list of the patch packages. 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/PatchSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListDbHomePatches tags: - database x-example: 'GET /20160918/dbHomes/<dbHomeId>/patches?limit=10 Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/Patch' /dbHomes/{dbHomeId}/patches/{patchId}: get: description: 'Gets information about a specified patch package. ' operationId: GetDbHomePatch parameters: - $ref: '#/components/parameters/DbHomeIdPathParam' - $ref: '#/components/parameters/PatchIdPathParam' responses: 200: description: The patch package. 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/Patch' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetDbHomePatch tags: - database x-example: 'GET /20160918/dbHomes/<dbHomeId>/patches/<patchId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/Patch' /dbNodes: get: description: 'Lists the database nodes in the specified DB system and compartment. In addition to the other required parameters, either ''--db-system-id'' or ''--vm-cluster-id'' also must be provided, depending on the service being accessed. ' operationId: ListDbNodes parameters: - $ref: '#/components/parameters/CompartmentId' - $ref: '#/components/parameters/OptionalDbSystemIdQueryParam' - $ref: '#/components/parameters/OptionalVmClusterIdQueryParam' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' - $ref: '#/components/parameters/ListDbNodesSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ListDbNodesFilterByLifecycleStateQueryParam' - $ref: '#/components/parameters/OptionalDbServerIdQueryParam' responses: 200: description: The list of database nodes is retrieved. 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/DbNodeSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListDbNodes tags: - database x-example: 'GET /20160918/dbNodes?compartmentId=<compartmentId>&dbSystemId=<dbSystemId>&limit=10 Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/DbNode' /dbNodes/{dbNodeId}: get: description: Gets information about the specified database node. operationId: GetDbNode parameters: - $ref: '#/components/parameters/DbNodeIdPathParam' responses: 200: description: The database node information is retrieved. 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/DbNode' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetDbNode tags: - database x-example: 'GET /20160918/dbNodes/<dbNodeId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' post: description: 'Performs one of the following power actions on the specified DB node: - start - power on - stop - power off gracefully - forcestop - power off forcefully - forcereset - ACPI shutdown and power on forcefully - softreset - ACPI shutdown and power on - reset - power off and power on **Note:** Stopping a node affects billing differently, depending on the type of DB system: *Bare metal and Exadata systems* - The _stop_ state has no effect on the resources you consume. Billing continues for DB nodes that you stop, and related resources continue to apply against any relevant quotas. You must terminate the DB system ([TerminateDbSystem](#/en/database/latest/DbSystem/TerminateDbSystem)) to remove its resources from billing and quotas. *Virtual machine DB systems* - Stopping a node stops billing for all OCPUs associated with that node, and billing resumes when you restart the node. ' operationId: DbNodeAction parameters: - $ref: '#/components/parameters/DbNodeIdPathParam' - $ref: '#/components/parameters/DbNodeActionQueryParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: The request was successfully received and the action is being performed. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DbNode' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: DbNodeAction tags: - database x-example: 'POST /20160918/dbNodes/<dbNodeId>?action=stop Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/DbNode' /dbNodes/{dbNodeId}/consoleConnections: get: description: 'Lists the console connections for the specified database node. ' operationId: ListConsoleConnections parameters: - $ref: '#/components/parameters/DbNodeIdPathParam' responses: 200: description: The list of console connections was retrieved. 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/ConsoleConnectionSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListConsoleConnections tags: - database x-example: 'GET /20160918/dbNodes/<dbNodeId>/consoleConnections ' x-related-resource: '#/definitions/ConsoleConnection' post: description: 'Creates a new console connection to the specified database node. After the console connection has been created and is available, you connect to the console using SSH. ' operationId: CreateConsoleConnection parameters: - $ref: '#/components/parameters/DbNodeIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The instance console connection is being configured. 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/ConsoleConnection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateConsoleConnection tags: - database x-example: "POST /20160918/dbNodes/<dbNodeId>/consoleConnections\n{\n \"publicKey\":\"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAACAQCZ06fccNTQfq+xubFlJ5ZR3kt+uzspdH9tXL+lAejSM1NXM+CFZev7MIxfEjas06y80ZBZ7DUTQO0GsampleVorF8M4xuLwrmzRtkoZzU16umt4y1W0Q4ifdp3IiiU0U8/WxczSXcUVZOLqkz5dc6oMHdMVpkimietWzGZ4LBBsH/LjEVY7E0V+a0sNchlVDIZcm7ErReBLcdTGDq0uLBiuChyl6RUkX1PNhusquTGwK7zc8OBXkRuubn5UKXhI3Ul9Nyk4XESkVWIGNKmw8mSpoJSjR8P9ZjRmcZVo8S+x4KVPMZKQEor== name@example.com 8GnoV/6Ox6TNoh9BiifqGKC9VGYuC89RvUajRBTZSK2TK4DPfaT+2R+slPsFrwiT/oPEhhEK1S5Q== rsa-key-20160227\"\n}\n" x-related-resource: '#/definitions/ConsoleConnection' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateConsoleConnectionDetails' description: Request object for creating an CreateConsoleConnection required: true /dbNodes/{dbNodeId}/consoleConnections/{consoleConnectionId}: delete: description: Deletes the specified database node console connection. operationId: DeleteConsoleConnection parameters: - $ref: '#/components/parameters/DbNodeIdPathParam' - $ref: '#/components/parameters/ConsoleConnectionIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 204: description: The instance console connection is being deleted. 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 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: DeleteConsoleConnection tags: - database x-example: 'DELETE /20160918/dbNodes/<dbNodeId>/consoleConnections/<instanceConsoleConnectionId> ' x-related-resource: '#/definitions/ConsoleConnection' get: description: Gets the specified database node console connection's information. operationId: GetConsoleConnection parameters: - $ref: '#/components/parameters/DbNodeIdPathParam' - $ref: '#/components/parameters/ConsoleConnectionIdPathParam' responses: 200: description: The console connection information was retrieved. 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/ConsoleConnection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetConsoleConnection tags: - database x-example: 'GET /20160918/dbNodes/<dbNodeId>/consoleConnections/<instanceConsoleConnectionId> ' x-related-resource: '#/definitions/ConsoleConnection' /dbNodes/{dbNodeId}/consoleHistories: get: description: 'Lists the console histories for the specified database node. ' operationId: ListConsoleHistories parameters: - $ref: '#/components/parameters/DbNodeIdPathParam' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/ListConsoleHistoriesSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ListConsoleHistoriesFilterByLifecycleStateQueryParam' - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' responses: 200: description: The list of console histories was retrieved. 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/ConsoleHistoryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListConsoleHistories tags: - database x-example: 'GET /20160918/dbNodes/<dbNodeId>/consoleHistories Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/ConsoleHistory' post: description: 'Captures the most recent serial console data (up to a megabyte) for the specified database node. ' operationId: CreateConsoleHistory parameters: - $ref: '#/components/parameters/DbNodeIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: The console history is being captured. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ConsoleHistory' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateConsoleHistory tags: - database x-example: "POST /20160918/dbNodes/<dbNodeId>/consoleHistories\n{\n \"displayName\" : \"console-history-20221202-1943\",\n \"definedTags\" : {},\n \"freeformTags\" : {}\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateConsoleHistoryDetails' description: 'Request object for creating a console history. ' required: true /dbNodes/{dbNodeId}/consoleHistories/{consoleHistoryId}: delete: description: 'Deletes the specified database node console history. ' operationId: DeleteConsoleHistory parameters: - $ref: '#/components/parameters/DbNodeIdPathParam' - $ref: '#/components/parameters/ConsoleHistoryIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OptionalRequestId' responses: 204: description: The instance console history is being deleted. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: DeleteConsoleHistory tags: - database x-related-resource: '#/definitions/ConsoleHistory' get: description: 'Gets information about the specified database node console history. ' operationId: GetConsoleHistory parameters: - $ref: '#/components/parameters/DbNodeIdPathParam' - $ref: '#/components/parameters/ConsoleHistoryIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: The console history information was retrieved. 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/ConsoleHistory' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetConsoleHistory tags: - database x-example: 'GET /20160918/dbNodes/<dbNodeId>/consoleHistories/<consoleHistoryId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' put: description: 'Updates the specified database node console history. ' operationId: UpdateConsoleHistory parameters: - $ref: '#/components/parameters/DbNodeIdPathParam' - $ref: '#/components/parameters/ConsoleHistoryIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: The instance console history is being 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 opc-work-request-id: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ConsoleHistory' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdateConsoleHistory tags: - database x-example: "PUT /latest//consoleHistories//<consoleHistoryId>\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\" : \"console-history-20221202-1944\",\n \"freeformTags\" : {\"Department\": \"Finance\"},\n \"definedTags\": {\"Operations\": {\"CostCenter\": \"42\"}}\n}\n" x-related-resource: '#/definitions/ConsoleHistory' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateConsoleHistoryDetails' description: Request to update the specified database node console history. required: true /dbNodes/{dbNodeId}/consoleHistories/{consoleHistoryId}/content: get: description: 'Retrieves the specified database node console history contents upto a megabyte. ' operationId: GetConsoleHistoryContent parameters: - $ref: '#/components/parameters/DbNodeIdPathParam' - $ref: '#/components/parameters/ConsoleHistoryIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: The console history content was retrieved. 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/octet-stream: schema: format: binary type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetConsoleHistoryContent tags: - database x-example: 'GET /20160918/dbNodes/<dbNodeId>/consoleHistories/<consoleHistoryId>/content Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/ConsoleHistory' /dbServers: get: description: 'Lists the Exadata DB servers in the ExadataInfrastructureId and specified compartment. ' operationId: ListDbServers parameters: - $ref: '#/components/parameters/CompartmentId' - $ref: '#/components/parameters/ExadataInfrastructureIdQueryParam' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/ListDbServersSortByQueryParam' - $ref: '#/components/parameters/ListDbServersFilterByLifecycleStateQueryParam' - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' responses: 200: description: The list of Exadata Db Servers. 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/DbServerSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListDbServers tags: - database x-example: 'GET /20160918/dbServers?compartmentId=<compartmentId>&exadataInfrastructureId=<exadataInfrastructureId>limit=10 Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/DbServer' /dbServers/{dbServerId}: get: description: 'Gets information about the Exadata Db server. ' operationId: GetDbServer parameters: - $ref: '#/components/parameters/ExadataInfrastructureIdQueryParam' - $ref: '#/components/parameters/DbServerIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: Information about the Exadata Db server. 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/DbServer' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetDbServer tags: - database x-example: 'GET /20160918/dbServers/<dbServerId>&exadataInfrastructureId=<exadataInfrastructureId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' /dbSystemComputePerformance: get: description: 'Gets a list of expected compute performance parameters for a virtual machine DB system based on system configuration. Adding compartmentId does not affect results. ' operationId: ListDbSystemComputePerformances parameters: - $ref: '#/components/parameters/DbSystemShapeParam' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/OptionalCompartmentIdQueryParam' responses: 200: description: list of possible expected compute performance parameters of a VMDB System . 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/DbSystemComputePerformanceSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: List of DbSystemComputePerformance params tags: - database x-example: "Example:\n GET /20160918/dbSystemPerformance?shapeType=<AMD>&compartmentId=<compartmentId>\n Host: database.us-phoenix-1.oraclecloud.com\n <authorization and other headers>\n" x-obmcs-authz-declarations: authorizationRequired: false x-related-resource: '#/definitions/DbSystem' /dbSystemShapes: get: description: Gets a list of the shapes that can be used to launch a new DB system. The shape determines resources to allocate to the DB system - CPU cores and memory for VM shapes; CPU cores, memory and storage for non-VM (or bare metal) shapes. operationId: ListDbSystemShapes parameters: - $ref: '#/components/parameters/OptionalAvailabilityDomainQueryParam' - $ref: '#/components/parameters/CompartmentId' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' - $ref: '#/components/parameters/ShapeAttributeQueryParam' responses: 200: description: Supported DB system shapes. 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/DbSystemShapeSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListDbSystemShapes tags: - database x-example: 'GET /20160918/dbSystemShapes?availabilityDomain=<availabilityDomain>&compartmentId=<compartmentId>&limit=100 Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-obmcs-authz-declarations: authorizationRequired: false /dbSystemShapes/flexComponents: get: description: Gets a list of the flex components that can be used to launch a new DB system. The flex component determines resources to allocate to the DB system - Database Servers and Storage Servers. operationId: ListFlexComponents parameters: - $ref: '#/components/parameters/CompartmentId' - $ref: '#/components/parameters/FilterByNameQueryParam' - $ref: '#/components/parameters/FilterByShapeQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ListFlexComponentsSortByQueryParam' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' responses: 200: description: Supported DB system flex Components for a given DB System shape. 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/FlexComponentCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListFlexComponents tags: - database x-example: 'GET /20160918/dbSystemShapes/flexComponents?limit=100 Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-obmcs-authz-declarations: authorizationRequired: false /dbSystemStoragePerformance: get: description: 'Gets a list of possible expected storage performance parameters of a VMDB System based on Configuration. ' operationId: ListDbSystemStoragePerformances parameters: - $ref: '#/components/parameters/StorageManagementQueryParam' - $ref: '#/components/parameters/ShapeTypeParam' - $ref: '#/components/parameters/DatabaseEditionQueryParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: list of possible storage performance parameters of a VMDB System . 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/DbSystemStoragePerformanceSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: List of DbSystemStoragePerformance params tags: - database x-example: "Example:\n GET /20160918/dbSystemPerformance?shapeType=<AMD>\n Host: database.us-phoenix-1.oraclecloud.com\n <authorization and other headers>\nExample with databaseEdition:\n GET /20160918/dbSystemPerformance?shapeType=<AMPERE_FLEX_A1>&databaseEdition=<ENTERPRISE_EDITION_DEVELOPER>\n Host: database.us-phoenix-1.oraclecloud.com\n <authorization and other headers>\n" x-obmcs-authz-declarations: authorizationRequired: false x-related-resource: '#/definitions/DbSystem' /dbSystems: get: description: 'Lists the DB systems in the specified compartment. You can specify a `backupId` to list only the DB systems that support creating a database using this backup in this compartment. **Note:** Deprecated for Exadata Cloud Service systems. Use the [new resource model APIs](/iaas/Content/Database/Concepts/exaflexsystem.htm#exaflexsystem_topic-resource_model) instead. For Exadata Cloud Service instances, support for this API will end on May 15th, 2021. See [Switching an Exadata DB System to the New Resource Model and APIs](/iaas/Content/Database/Concepts/exaflexsystem_topic-resource_model_conversion.htm) for details on converting existing Exadata DB systems to the new resource model. ' operationId: ListDbSystems parameters: - $ref: '#/components/parameters/CompartmentId' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' - $ref: '#/components/parameters/BackupIdQueryParam' - $ref: '#/components/parameters/ListDbSystemsSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ListDbSystemsFilterByLifecycleStateQueryParam' - $ref: '#/components/parameters/FilterByAvailabilityDomainQueryParam' - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' responses: 200: description: All the DB systems. 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/DbSystemSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListDbSystems tags: - database x-example: "Example I:\n GET /20160918/dbSystems?compartmentId=<compartmentId>&limit=10\n Host: database.us-phoenix-1.oraclecloud.com\n <authorization and other headers>\n\nExample II:\n GET /20160918/dbSystems?compartmentId=<compartmentId>&backupId=<backupId>&limit=10\n Host: database.us-phoenix-1.oraclecloud.com\n <authorization and other headers>\n" x-related-resource: '#/definitions/DbSystem' post: description: 'Creates a new DB system in the specified compartment and availability domain. The Oracle Database edition that you specify applies to all the databases on that DB system. The selected edition cannot be changed. An initial database is created on the DB system based on the request parameters you provide and some default options. For detailed information about default options, see [Bare metal and virtual machine DB system default options.](/Content/Database/Tasks/creatingDBsystem.htm#Default) **Note:** Deprecated for Exadata Cloud Service systems. Use the [new resource model APIs](/iaas/Content/Database/Concepts/exaflexsystem.htm#exaflexsystem_topic-resource_model) instead. For Exadata Cloud Service instances, support for this API will end on May 15th, 2021. See [Switching an Exadata DB System to the New Resource Model and APIs](/iaas/Content/Database/Concepts/exaflexsystem_topic-resource_model_conversion.htm) for details on converting existing Exadata DB systems to the new resource model. Use the [CreateCloudExadataInfrastructure](#/en/database/latest/CloudExadataInfrastructure/CreateCloudExadataInfrastructure/) and [CreateCloudVmCluster](#/en/database/latest/CloudVmCluster/CreateCloudVmCluster/) APIs to provision a new Exadata Cloud Service instance. ' operationId: LaunchDbSystem parameters: - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The request was successfully received and the DB system launch is in progress. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DbSystem' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: LaunchDbSystem tags: - database x-example: "Example I:\n POST /20160918/dbSystems\n Host: database.us-phoenix-1.oraclecloud.com\n <authorization and other headers>\n {\n \"availabilityDomain\" : \"OXET:PHX-AD-1\",\n \"compartmentId\" : \"ocid1.tenancy.oc1..<unique_ID>\",\n \"cpuCoreCount\" : 8,\n \"databaseEdition\" : \"ENTERPRISE_EDITION\",\n \"dbHome\" : {\n \"database\" : {\n \"adminPassword\" : \"<password>\",\n \"dbName\" : \"myTestDb\",\n \"kmsKeyId\" : \"ocid1.key.oc1..<unique_ID>\",\n \"kmsKeyVersionId\" : \"ocid1.keyversion.oc1..<unique_ID>\",\n \"vaultId\" : \"ocid1.vault.oc1.phx.\",\n \"dbBackupConfig\" : {\n \"backupDestinationDetails\" : [{\n \"type\": \"RECOVERY_APPLIANCE\",\n \"id\": \"ocid1.bkupdest.oc1.phx.<unique_ID>\",\n \"vpcUser\": \"vpcUser1\",\n \"vpcPassword\": \"<password>\"\n }],\n \"recoveryWindowInDays\" : 30,\n \"autoBackupEnabled\" : true\n }\n },\n \"dbVersion\" : \"12.1.0.2\",\n \"displayName\" : null\n },\n \"dbSystemOptions\" : {\n \"storageManagement\" : \"LVM\"\n },\n \"diskRedundancy\" : null,\n \"displayName\" : \"tst3dbsys\",\n \"domain\" : \"<example.com>\",\n \"hostname\" : \"athena\",\n \"shape\" : \"BM.DenseIO1.36\",\n \"source\" : \"NONE\",\n \"sshPublicKeys\" : [ \"ssh-rsa <public_SSH_key> name@example.com\" ],\n \"subnetId\" : \"ocid1.subnet.oc1.phx.<unique_ID>\"\n }\nExample II (Launch from Backup):\n POST /20160918/dbSystems\n Host: database.us-phoenix-1.oraclecloud.com\n <authorization and other headers>\n {\n \"availabilityDomain\" : \"OXET:PHX-AD-1\",\n \"compartmentId\" : \"ocid1.tenancy.oc1..<unique_ID>\",\n \"cpuCoreCount\" : 8,\n \"databaseEdition\" : \"ENTERPRISE_EDITION\",\n \"dbHome\":{\n \"database\" : {\n \"backupId\" : \"ocid1.backup.oc1.phx.<unique_ID>\",\n \"backupTDEPassword\" : \"<TDE_password>\",\n \"adminPassword\" : \"<password>\"\n }\n }\n \"diskRedundancy\" : null,\n \"displayName\" : \"tst3dbsys\",\n \"domain\" : \"<example.com>\",\n \"hostname\" : \"athena\",\n \"kmsKeyId\" : \"ocid1.key.oc1..<unique_ID>\",\n \"kmsKeyVersionId\" : \"ocid1.keyversion.oc1..<unique_ID>\",\n \"shape\" : \"BM.DenseIO1.36\",\n \"source\" : \"DB_BACKUP\",\n \"sshPublicKeys\" : [ \"ssh-rsa <public_SSH_key> name@example.com\" ],\n \"subnetId\" : \"ocid1.subnet.oc1.phx.<unique_ID>\"\n }\nExample III:\n POST /20160918/dbSystems\n Host: database.us-phoenix-1.oraclecloud.com\n <authorization and other headers>\n {\n \"availabilityDomain\": \"OXET:PHX-AD-1\",\n \"compartmentId\": \"ocid1.tenancy.oc1..<unique_ID>\",\n \"cpuCoreCount\": 8,\n \"databaseEdition\": \"ENTERPRISE_EDITION\",\n \"dbHome\": {\n \"database\": {\n \"adminPassword\": \"<password>\",\n \"dbName\": \"myTestDb\",\n \"kmsKeyId\": \"ocid1.key.oc1.phx.<unique_ID>\",\n \"kmsKeyVersionId\" : \"ocid1.keyversion.oc1..<unique_ID>\",\n \"vaultId\": \"ocid1.vault.oc1.phx.\",\n \"dbBackupConfig\": {\n \"recoveryWindowInDays\": 30,\n \"autoBackupEnabled\": true,\n \"autoBackupWindow\": \"SLOT_TWO\"\n\n }\n },\n \"dbVersion\": \"12.1.0.2\",\n \"displayName\": null\n },\n \"diskRedundancy\": null,\n \"displayName\": \"tst3dbsys\",\n \"domain\": \"<example.com>\",\n \"hostname\": \"athena\",\n \"kmsKeyId\": \"ocid1.key.oc1.phx.<unique_ID>\",\n \"shape\": \"BM.DenseIO1.36\",\n \"source\": \"NONE\",\n \"sshPublicKeys\": [ \"ssh-rsa <public_SSH_key> name@example.com\" ],\n \"subnetId\": \"ocid1.subnet.oc1.phx.<unique_ID>\"\n }\nExample IV (Launch Standby DbSystem):\n POST /20160918/dbSystems\n Host: database.us-phoenix-1.oraclecloud.com\n <authorization and other headers>\n {\n \"availabilityDomain\": \"OXET:PHX-AD-1\",\n \"compartmentId\": \"ocid1.tenancy.oc1..<unique_ID>\",\n \"cpuCoreCount\": 8,\n \"databaseEdition\": \"ENTERPRISE_EDITION\",\n \"dbHome\": {\n \"database\": {\n \"adminPassword\": \"<password>\",\n \"protectionMode\": \"MAXIMUM_AVAILABILITY\",\n \"transportType\": \"SYNC\",\n \"databaseSoftwareImageId\": \"ocid1.softwareImage\",\n \"isActiveDataGuardEnabled\": true,\n \"dbUniqueName\": \"UniqueName1\",\n },\n \"displayName\": null\n },\n \"diskRedundancy\": null,\n \"displayName\": \"tst3dbsys\",\n \"domain\": \"<example.com>\",\n \"hostname\": \"athena\",\n \"kmsKeyId\": \"ocid1.key.oc1.phx.<unique_ID>\",\n \"shape\": \"VM.Standard2.4\",\n \"source\": \"DATAGUARD\",\n \"sshPublicKeys\": [ \"ssh-rsa <public_SSH_key> name@example.com\" ],\n \"subnetId\": \"ocid1.subnet.oc1.phx.<unique_ID>\",\n \"primaryDbSystemId\": \"ocid1.dbsystem.oc1...<unique_ID>\",\n \"licenseModel\": \"LICENSE_INCLUDED\"\n }\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/LaunchDbSystemBase' description: 'Request to launch a DB system. **Note:** Deprecated for Exadata Cloud Service systems. Use the [new resource model APIs](/iaas/Content/Database/Concepts/exaflexsystem.htm#exaflexsystem_topic-resource_model) instead. For Exadata Cloud Service instances, support for this API will end on May 15th, 2021. See [Switching an Exadata DB System to the New Resource Model and APIs](/iaas/Content/Database/Concepts/exaflexsystem_topic-resource_model_conversion.htm) for details on converting existing Exadata DB systems to the new resource model. ' required: true /dbSystems/{dbSystemId}: delete: description: 'Terminates a DB system and permanently deletes it and any databases running on it, and any storage volumes attached to it. The database data is local to the DB system and will be lost when the system is terminated. Oracle recommends that you back up any data in the DB system prior to terminating it. **Note:** Deprecated for Exadata Cloud Service systems. Use the [new resource model APIs](/iaas/Content/Database/Concepts/exaflexsystem.htm#exaflexsystem_topic-resource_model) instead. For Exadata Cloud Service instances, support for this API will end on May 15th, 2021. See [Switching an Exadata DB System to the New Resource Model and APIs](/iaas/Content/Database/Concepts/exaflexsystem_topic-resource_model_conversion.htm) for details on converting existing Exadata DB systems to the new resource model. ' operationId: TerminateDbSystem parameters: - $ref: '#/components/parameters/DbSystemIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 204: description: The request to terminate the DB system was accepted. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: TerminateDbSystem tags: - database x-example: 'DELETE /20160918/dbSystems/<dbSystemId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/DbSystem' get: description: 'Gets information about the specified DB system. **Note:** Deprecated for Exadata Cloud Service systems. Use the [new resource model APIs](/iaas/Content/Database/Concepts/exaflexsystem.htm#exaflexsystem_topic-resource_model) instead. For Exadata Cloud Service instances, support for this API will end on May 15th, 2021. See [Switching an Exadata DB System to the New Resource Model and APIs](/iaas/Content/Database/Concepts/exaflexsystem_topic-resource_model_conversion.htm) for details on converting existing Exadata DB systems to the new resource model. ' operationId: GetDbSystem parameters: - $ref: '#/components/parameters/DbSystemIdPathParam' responses: 200: description: The DB system information was retrieved. 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/DbSystem' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetDbSystem tags: - database x-example: 'GET /20160918/dbSystems/<dbSystemId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' put: description: 'Updates the properties of the specified DB system. **Note:** Deprecated for Exadata Cloud Service systems. Use the [new resource model APIs](/iaas/Content/Database/Concepts/exaflexsystem.htm#exaflexsystem_topic-resource_model) instead. For Exadata Cloud Service instances, support for this API will end on May 15th, 2021. See [Switching an Exadata DB System to the New Resource Model and APIs](/iaas/Content/Database/Concepts/exaflexsystem_topic-resource_model_conversion.htm) for details on converting existing Exadata DB systems to the new resource model. ' operationId: UpdateDbSystem parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/DbSystemIdPathParam' responses: 200: description: The request was successfully received and the DB system update is in progress. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DbSystem' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdateDbSystem tags: - database x-example: "Example I:\n PUT /latest/dbSystems/<dbSystemId>\n Host: database.us-phoenix-1.oraclecloud.com\n <authorization and other headers>\n {\n \"cpuCoreCount\" : 10\n }\n\nExample II:\n PUT /latest/dbSystems/<dbSystemId>\n Host: database.us-phoenix-1.oraclecloud.com\n <authorization and other headers>\n {\n \"version\" : {\n \"patchId\" : \"ocid1.patch.oc1.phx.<unique_ID>\",\n \"action\" : \"APPLY\"\n }\n }\n\nExample III:\n PUT /latest/dbSystems/<dbSystemId>\n Host: database.us-phoenix-1.oraclecloud.com\n <authorization and other headers>\n {\n \"sshPublicKeys\" : [ \"ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAQEA...BOk70tWmJHF== rsa-key-20170408\" ]\n }\n\nExample IV:\n PUT /latest/dbSystems/<dbSystemId>\n Host: database.us-phoenix-1.oraclecloud.com\n <authorization and other headers>\n {\n \"cpuCoreCount\" : 10,\n \"version\" : {\n \"patchId\" : \"ocid1.patch.oc1.phx.<unique_ID>\",\n \"action\" : \"APPLY\"\n },\n \"sshPublicKeys\" : [ \"ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAQEA...BOk70tWmJHF== rsa-key-20170408\" ]\n }\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateDbSystemDetails' description: Request to update the properties of a DB system. required: true /dbSystems/{dbSystemId}/ExadataIormConfig: get: description: 'Gets the IORM configuration settings for the specified cloud Exadata DB system. All Exadata service instances have default IORM settings. **Note:** Deprecated for Exadata Cloud Service systems. Use the [new resource model APIs](/iaas/Content/Database/Concepts/exaflexsystem.htm#exaflexsystem_topic-resource_model) instead. For Exadata Cloud Service instances, support for this API will end on May 15th, 2021. See [Switching an Exadata DB System to the New Resource Model and APIs](/iaas/Content/Database/Concepts/exaflexsystem_topic-resource_model_conversion.htm) for details on converting existing Exadata DB systems to the new resource model. The [GetCloudVmClusterIormConfig](#/en/database/latest/CloudVmCluster/GetCloudVmClusterIormConfig/) API is used for this operation with Exadata systems using the new resource model. ' operationId: GetExadataIormConfig parameters: - $ref: '#/components/parameters/DbSystemIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: The IORM configuration was retrieved. 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/ExadataIormConfig' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' tags: - database x-example: 'GET /20160918/dbSystems/<dbSystemId>/ExadataIormConfig Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/DbSystem' put: description: 'Updates IORM settings for the specified Exadata DB system. **Note:** Deprecated for Exadata Cloud Service systems. Use the [new resource model APIs](/iaas/Content/Database/Concepts/exaflexsystem.htm#exaflexsystem_topic-resource_model) instead. For Exadata Cloud Service instances, support for this API will end on May 15th, 2021. See [Switching an Exadata DB System to the New Resource Model and APIs](/iaas/Content/Database/Concepts/exaflexsystem_topic-resource_model_conversion.htm) for details on converting existing Exadata DB systems to the new resource model. The [UpdateCloudVmClusterIormConfig](#/en/database/latest/CloudVmCluster/UpdateCloudVmClusterIormConfig/) API is used for Exadata systems using the new resource model. ' operationId: UpdateExadataIormConfig parameters: - $ref: '#/components/parameters/DbSystemIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: The updated IORM configuration was retrieved. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ExadataIormConfig' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' tags: - database x-example: 'PUT /latest/dbSystems/<dbSystemId>/ExadataIormConfig Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/DbSystem' requestBody: content: application/json: schema: $ref: '#/components/schemas/ExadataIormConfigUpdateDetails' description: Request to perform database update. required: true /dbSystems/{dbSystemId}/actions/changeCompartment: post: description: 'Moves the DB system and its dependent resources to the specified compartment. For more information about moving DB systems, see [Moving Database Resources to a Different Compartment](/Content/Database/Concepts/databaseoverview.htm#moveRes). ' operationId: ChangeDbSystemCompartment parameters: - $ref: '#/components/parameters/DbSystemIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: The request was successfully received and the change compartment action is being performed. 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 of the work request. schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ChangeDbSystemCompartment tags: - database x-example: "POST /20160918/dbSystems/<dbSystemId>/actions/changeCompartment\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\" : \"ocid.compartment.oc1..<unique_ID>\"\n}\n" x-related-resource: '#/definitions/DbSystem' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeCompartmentDetails' description: 'Request to move the DB system to a different compartment. **Note:** Deprecated for Exadata Cloud Service systems. Use the [new resource model APIs](/iaas/Content/Database/Concepts/exaflexsystem.htm#exaflexsystem_topic-resource_model) instead. For Exadata Cloud Service instances, support for this API will end on May 15th, 2021. See [Switching an Exadata DB System to the New Resource Model and APIs](/iaas/Content/Database/Concepts/exaflexsystem_topic-resource_model_conversion.htm) for details on converting existing Exadata DB systems to the new resource model. ' required: true /dbSystems/{dbSystemId}/actions/migration: post: description: 'Migrates the Exadata DB system to the new [Exadata resource model](/iaas/Content/Database/Concepts/exaflexsystem.htm#exaflexsystem_topic-resource_model). All related resources will be migrated. ' operationId: MigrateExadataDbSystemResourceModel parameters: - $ref: '#/components/parameters/DbSystemIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: An object containing information about the migration to the cloud Exadata infrastructure model. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ExadataDbSystemMigration' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' tags: - database x-example: 'PUT /latest/dbSystems/<dbSystemId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/DbSystem' /dbSystems/{dbSystemId}/actions/osPatch: post: description: 'Execute an operating system (OS) patch action on a DB system. Returns 202 and a work request. Some updates may require a reboot. ' operationId: ExecuteDbSystemOsPatch parameters: - $ref: '#/components/parameters/DbSystemIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: The request was successfully received and the OS patching action is being performed. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ExecuteDbSystemOsPatch tags: - database x-example: "POST /20160918/dbSystems/<dbSystemId>/actions/osPatch\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"action\" : \"PRECHECK\"\n}\n" x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/DbSystem' requestBody: content: application/json: schema: $ref: '#/components/schemas/ExecuteDbSystemOsPatchDetails' description: Details to execute an OS patch action on a DB System. required: true /dbSystems/{dbSystemId}/actions/upgrade: post: description: 'Upgrades the operating system and grid infrastructure of the DB system. ' operationId: UpgradeDbSystem parameters: - $ref: '#/components/parameters/DbSystemIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: The request was successfully received and the action is being performed. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DbSystem' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpgradeDbSystem tags: - database x-example: "POST /20160918/dbSystems/<dbSystemId>/actions/upgrade\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n {\n \"newGiVersion\" : \"19.7.0.0\",\n \"snapshotRetentionPeriodInDays\" : 30,\n \"action\" : \"PRECHECK\"\n }\n" x-related-resource: '#/definitions/DbSystem' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpgradeDbSystemDetails' description: Request to perform an upgrade of the operating system and the Oracle Grid Infrastructure (GI) of the DB system. required: true /dbSystems/{dbSystemId}/dbSystemUpgrades: get: description: 'Lists the applicable upgrade components for a DB systems. ' operationId: ListDbSystemUpgrades parameters: - $ref: '#/components/parameters/DbSystemIdPathParam' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' responses: 200: description: Lists the possible upgrade components available for DB systems. 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/DbSystemUpgradeSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListDbSystemUpgrades tags: - database x-example: 'GET /20160918/dbSystems/<dbSystemId>/dbSystemUpgrades Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/DbSystemUpgradeSummary' /dbSystems/{dbSystemId}/osPatchHistoryEntries: get: description: 'Gets the history of the OS patch actions performed on the specified DB system. ' operationId: ListDbSystemOsPatchHistoryEntries parameters: - $ref: '#/components/parameters/DbSystemIdPathParam' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ListDbSystemOsPatchHistoryEntriesSortByQueryParam' - $ref: '#/components/parameters/ListDbSystemOsPatchHistoryEntriesFilterByLifecycleStateQueryParam' - $ref: '#/components/parameters/ListDbSystemOsPatchHistoryEntriesFilterByActionQueryParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: The OS patch history for the specified DB system was retrieved. 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/DbSystemOsPatchHistoryEntryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListDbSystemOsPatchHistoryEntries tags: - database x-example: 'GET /20160918/dbSystems/<dbSystemId>/osPatchHistoryEntries?limit=100 Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/DbSystemOsPatchHistoryEntryCollection' /dbSystems/{dbSystemId}/osPatchHistoryEntries/{osPatchHistoryEntryId}: get: description: 'Gets the details of the specified OS patch action for the specified DB system. ' operationId: GetDbSystemOsPatchHistoryEntry parameters: - $ref: '#/components/parameters/DbSystemIdPathParam' - $ref: '#/components/parameters/DbSystemOsPatchHistoryEntryIdParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: The OS patch operation details were retrieved. 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/DbSystemOsPatchHistoryEntry' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetDbSystemOsPatchHistoryEntry tags: - database x-example: 'GET /20160918/dbSystems/<dbSystemId>/osPatchHistoryEntries/<osPatchHistoryEntryId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/DbSystemOsPatchHistoryEntry' /dbSystems/{dbSystemId}/patchHistoryEntries: get: description: 'Gets the history of the patch actions performed on the specified DB system. ' operationId: ListDbSystemPatchHistoryEntries parameters: - $ref: '#/components/parameters/DbSystemIdPathParam' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' responses: 200: description: The patch history for the specified DB system was retrieved. 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/PatchHistoryEntrySummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListDbSystemPatchHistoryEntries tags: - database x-example: 'GET /20160918/dbSystems/<dbSystemId>/patchHistoryEntries?limit=100 Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/PatchHistoryEntry' /dbSystems/{dbSystemId}/patchHistoryEntries/{patchHistoryEntryId}: get: description: 'Gets the details of the specified patch operation on the specified DB system. ' operationId: GetDbSystemPatchHistoryEntry parameters: - $ref: '#/components/parameters/DbSystemIdPathParam' - $ref: '#/components/parameters/PatchHistoryEntryIdPathParam' responses: 200: description: The patch operation details were retrieved. 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/PatchHistoryEntry' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetDbSystemPatchHistoryEntry tags: - database x-example: 'GET /20160918/patchHistoryEntries/<patchHistoryEntryId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/PatchHistoryEntry' /dbSystems/{dbSystemId}/patches: get: description: 'Lists the patches applicable to the specified DB system. ' operationId: ListDbSystemPatches parameters: - $ref: '#/components/parameters/DbSystemIdPathParam' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' responses: 200: description: The list of applicable patches was retrieved. 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/PatchSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListDbSystemPatches tags: - database x-example: 'GET /20160918/dbSystems/<dbSystemId>/patches?limit=10 Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/Patch' /dbSystems/{dbSystemId}/patches/{patchId}: get: description: 'Gets information the specified patch. ' operationId: GetDbSystemPatch parameters: - $ref: '#/components/parameters/DbSystemIdPathParam' - $ref: '#/components/parameters/PatchIdPathParam' responses: 200: description: The patch information was retrieved. 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/Patch' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetDbSystemPatch tags: - database x-example: 'GET /20160918/dbSystems/<dbSystemId>/patches/<patchId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/Patch' /dbSystems/{dbSystemId}/upgradeHistoryEntries: get: description: 'Gets the history of the upgrade actions performed on the specified DB system. ' operationId: ListDbSystemUpgradeHistoryEntries parameters: - $ref: '#/components/parameters/DbSystemIdPathParam' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ListUpgradeHistoryEntriesSortByQueryParam' - $ref: '#/components/parameters/FilterByDbSystemUpgradeActionQueryParam' - $ref: '#/components/parameters/FilterByUpgradeDbSystemLifecycleStateQueryParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: The upgrade history for the specified DB system was retrieved. 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/DbSystemUpgradeHistoryEntrySummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListDbSystemUpgradeHistoryEntries tags: - database x-example: 'GET /20160918/dbSystems/<dbSystemId>/upgradeHistoryEntries?limit=100 Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/DbSystemUpgradeHistoryEntry' /dbSystems/{dbSystemId}/upgradeHistoryEntries/{upgradeHistoryEntryId}: get: description: 'Gets the details of the specified operating system upgrade operation for the specified DB system. ' operationId: GetDbSystemUpgradeHistoryEntry parameters: - $ref: '#/components/parameters/DbSystemIdPathParam' - $ref: '#/components/parameters/UpgradeHistoryEntryIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: The upgrade operation details were retrieved. 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/DbSystemUpgradeHistoryEntry' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetDbSystemUpgradeHistoryEntry tags: - database x-example: 'GET /20160918/upgradeHistoryEntries/<upgradeHistoryEntryId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/DbSystemUpgradeHistoryEntry' /dbVersions: get: description: Gets a list of supported Oracle Database versions. operationId: ListDbVersions parameters: - $ref: '#/components/parameters/CompartmentId' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' - $ref: '#/components/parameters/DbSystemShapeParam' - $ref: '#/components/parameters/OptionalDbSystemIdQueryParam' - $ref: '#/components/parameters/OptionalStorageManagementQueryParam' - $ref: '#/components/parameters/ShapeAttributeQueryParam' - $ref: '#/components/parameters/OptionalDatabaseUpgradeSupportedQueryParam' - $ref: '#/components/parameters/OptionalDatabaseSoftwareImageSupportedQueryParam' responses: 200: description: Supported Oracle Database versions. 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/DbVersionSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListDbVersions tags: - database x-example: 'GET /20160918/dbVersions?compartmentId=<compartmentId>&limit=100 Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-obmcs-authz-declarations: authorizationRequired: false /dbnodeSnapshots: get: description: 'Gets a list of the Exadata Database Node Snapshots in the specified compartment. ' operationId: ListDbnodeSnapshots parameters: - $ref: '#/components/parameters/CompartmentId' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' - $ref: '#/components/parameters/ListDbnodeSnapshotsSortByQueryParam' - $ref: '#/components/parameters/FilterByNameQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ListDbnodeSnapshotsFilterByLifecycleStateQueryParam' - $ref: '#/components/parameters/ListDbnodeSnapshotsFilterByClusterQueryParam' - $ref: '#/components/parameters/ListDbnodeSnapshotsFilterByDbNodeQueryParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: List of the Exadata Database Node Snapshots 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/DbnodeSnapshotSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListDbnodeSnapshots tags: - database x-example: 'GET /20160918/dbnodeSnapshots?compartmentId=<compartmentId>&limit=10 Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/DbnodeSnapshot' /dbnodeSnapshots/{dbnodeSnapshotId}: delete: description: 'Deletes the specified Exadata Database Node Snapshot. ' operationId: DeleteDbnodeSnapshot parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/DbnodeSnapshotIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 204: description: The request to delete the Exadata Database Node Snapshot was accepted. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Deletes the specified Exadata Database Node Snapshot. tags: - database x-related-resource: '#/definitions/DbnodeSnapshot' get: description: 'Gets information about the specified Exadata Database Node Snapshot in the specified compartment. ' operationId: GetDbnodeSnapshot parameters: - $ref: '#/components/parameters/DbnodeSnapshotIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: Information about the Exadata Database Node Snapshot. 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/DbnodeSnapshot' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetDbnodeSnapshot tags: - database x-example: 'GET /20160918/dbnodeSnapshots/<dbnodeSnapshotId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' /dbnodeSnapshots/{dbnodeSnapshotId}/actions/mount: post: description: 'Mounts the snapshot for the provided dbNode. ' operationId: MountDbnodeSnapshot parameters: - $ref: '#/components/parameters/DbnodeSnapshotIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: The request was successfully received and the mount action is being performed. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DbnodeSnapshot' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: MountDbnodeSnapshot tags: - database x-example: "POST /20160918/dbnodeSnapshots/<dbnodeSnapshotId>/actions/mount\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"dbNodeId\": \"ocid1.dbnode.oc1.\"\n}\n" x-obmcs-terraform: actionType: START x-related-resource: '#/definitions/DbnodeSnapshot' requestBody: content: application/json: schema: $ref: '#/components/schemas/MountDbnodeSnapshotDetails' description: Request to mount the snapshot for the provided Exadata Database Node. required: true /dbnodeSnapshots/{dbnodeSnapshotId}/actions/unmount: post: description: 'Unmounts the snapshot for the provided dbNode. ' operationId: UnmountDbnodeSnapshot parameters: - $ref: '#/components/parameters/DbnodeSnapshotIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: The request was successfully received and the unmount action is being performed. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DbnodeSnapshot' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UnmountDbnodeSnapshot tags: - database x-example: "POST /20160918/dbnodeSnapshots/<dbnodeSnapshotId>/actions/unmount\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"dbNodeId\": \"ocid1.dbnode.oc1.\"\n}\n" x-obmcs-terraform: actionType: STOP x-related-resource: '#/definitions/DbnodeSnapshot' requestBody: content: application/json: schema: $ref: '#/components/schemas/UnmountDbnodeSnapshotDetails' description: Request to unmount the snapshot for the provided Exadata Database Node. required: true /exadataInfrastructures: get: description: 'Lists the Exadata infrastructure resources in the specified compartment. Applies to Exadata Cloud@Customer instances only. To list the Exadata Cloud Service infrastructure resources in a compartment, use the [ListCloudExadataInfrastructures](#/en/database/latest/CloudExadataInfrastructure/ListCloudExadataInfrastructures) operation. ' operationId: ListExadataInfrastructures parameters: - $ref: '#/components/parameters/CompartmentId' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/ListExadataInfrastructuresSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ListExadataInfrastructuresFilterByLifecycleStateQueryParam' - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' - $ref: '#/components/parameters/OptionalExcludedFieldsQueryParam' responses: 200: description: 'A list of the Exadata Cloud@Customer infrastructure resources in the specified compartment. ' 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/ExadataInfrastructureSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListExadataInfrastructures tags: - database x-example: 'GET /20160918/exadataInfrastructures?compartmentId=<compartmentId>&limit=10 Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/ExadataInfrastructure' post: description: 'Creates an Exadata infrastructure resource. Applies to Exadata Cloud@Customer instances only. To create an Exadata Cloud Service infrastructure resource, use the [CreateCloudExadataInfrastructure](#/en/database/latest/CloudExadataInfrastructure/CreateCloudExadataInfrastructure) operation. ' operationId: CreateExadataInfrastructure parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: 'The request was successfully received and the create Exadata Cloud@Customer infrastructure operation is in progress. ' 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ExadataInfrastructure' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateExadataInfrastructure tags: - database x-example: "POST /20160918/exadataInfrastructures\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\" : \"ocid1.tenancy.oc1.<unique_ID>\",\n \"displayName\" : \"tstExaInfra\",\n \"shape\" : \"Exadata.Full2.336\",\n \"timeZone\" : \"PST\",\n \"cloudControlPlaneServer1\" :\"192.168.19.1\",\n \"cloudControlPlaneServer2\" : \"192.168.19.2\",\n \"netmask\" : \"255.255.0.0\",\n \"gateway\" : \"192.168.20.1\",\n \"adminNetworkCIDR\" : \"192.168.19.2/16\",\n \"infiniBandNetworkCIDR\" : \"10.172.19.1/24\",\n \"corporateProxy\" : \"192.168.20.1\",\n \"dnsServer\" : [\"192.168.10.10\"],\n \"databaseServerType\": \"X11M\",\n \"storageServerType\": \"X11M-HC-XRMEM\",\n \"ntpServer\" : [\"192.168.10.20\"]\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateExadataInfrastructureDetails' description: Request to create Exadata Cloud@Customer infrastructure. required: true /exadataInfrastructures/{exadataInfrastructureId}: delete: description: 'Deletes the Exadata Cloud@Customer infrastructure. ' operationId: DeleteExadataInfrastructure parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/ExadataInfrastructureIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 204: description: The request to delete the Exadata Cloud@Customer infrastructure was accepted. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Deletes the specified Exadata infrastructure. tags: - database x-related-resource: '#/definitions/ExadataInfrastructure' get: description: 'Gets information about the specified Exadata infrastructure. Applies to Exadata Cloud@Customer instances only. To get information on an Exadata Cloud Service infrastructure resource, use the [GetCloudExadataInfrastructure](#/en/database/latest/CloudExadataInfrastructure/GetCloudExadataInfrastructure) operation. ' operationId: GetExadataInfrastructure parameters: - $ref: '#/components/parameters/ExadataInfrastructureIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/OptionalExcludedFieldsQueryParam' responses: 200: description: The Exadata Cloud@Customer infrastructure details. 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/ExadataInfrastructure' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetExadataInfrastructure tags: - database x-example: 'GET /20160918/exadataInfrastructures/<exadataInfrastructureId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' put: description: 'Updates the Exadata infrastructure resource. Applies to Exadata Cloud@Customer instances only. To update an Exadata Cloud Service infrastructure resource, use the [UpdateCloudExadataInfrastructure](#/en/database/latest/CloudExadataInfrastructure/UpdateCloudExadataInfrastructure) operation. ' operationId: UpdateExadataInfrastructure parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/ExadataInfrastructureIdPathParam' responses: 200: description: 'The request was successfully received and the Exadata Cloud@Customer infrastructure update is in progress. ' 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ExadataInfrastructure' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Updates the specified Exadata Cloud@Customer Infrastructure tags: - database x-example: "PUT /20160918/exadataInfrastructures/<exadataInfrastructureId>\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"adminNetworkCIDR\" : \"192.168.19.1/16\",\n \"infiniBandNetworkCIDR\" : \"10.172.19.2/24\"\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateExadataInfrastructureDetails' description: Request to update the properties of an Exadata Cloud@Customer infrastructure. required: true /exadataInfrastructures/{exadataInfrastructureId}/actions/activate: post: description: 'Activates the specified Exadata infrastructure resource. Applies to Exadata Cloud@Customer instances only. ' operationId: ActivateExadataInfrastructure parameters: - $ref: '#/components/parameters/ExadataInfrastructureIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The Exadata Cloud@Customer Infrastructure. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ExadataInfrastructure' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Activate ExadataInfrastructure tags: - database x-example: "POST /20160918/exadataInfrastructures/<exadataInfrastructureId>/actions/activate\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"activationFile\" : \"<base64EncodedActivationFile>\"\n}\n" x-related-resource: '#/definitions/ExadataInfrastructure' requestBody: content: application/json: schema: $ref: '#/components/schemas/ActivateExadataInfrastructureDetails' description: The activation details for the Exadata infrastructure and the additional storage servers requested. required: true /exadataInfrastructures/{exadataInfrastructureId}/actions/addStorageCapacity: post: description: 'Makes the storage capacity from additional storage servers available for VM Cluster consumption. Applies to Exadata Cloud@Customer instances only. ' operationId: AddStorageCapacityExadataInfrastructure parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/ExadataInfrastructureIdPathParam' responses: 200: description: 'The request was successfully received and the Exadata Cloud@Customer infrastructure update is in progress. ' 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ExadataInfrastructure' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Makes the storage capacity from additional storage servers available for VM Cluster consumption. Applies to Exadata Cloud@Customer instances only. tags: - database x-related-resource: '#/definitions/ExadataInfrastructure' /exadataInfrastructures/{exadataInfrastructureId}/actions/changeCompartment: post: description: 'Moves an Exadata infrastructure resource and its dependent resources to another compartment. Applies to Exadata Cloud@Customer instances only. To move an Exadata Cloud Service infrastructure resource to another compartment, use the [ChangeCloudExadataInfrastructureCompartment](#/en/database/latest/CloudExadataInfrastructure/ChangeCloudExadataInfrastructureCompartment) operation. ' operationId: ChangeExadataInfrastructureCompartment parameters: - $ref: '#/components/parameters/ExadataInfrastructureIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: The request was successfully received and the change compartment action is being performed. 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 of the work request. schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ChangeExadataInfrastructureCompartment tags: - database x-related-resource: '#/definitions/ExadataInfrastructure' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeExadataInfrastructureCompartmentDetails' description: Request to move Exadata infrastructure to a different compartment required: true /exadataInfrastructures/{exadataInfrastructureId}/actions/downloadConfigFile: post: description: 'Downloads the configuration file for the specified Exadata Cloud@Customer infrastructure. ' operationId: DownloadExadataInfrastructureConfigFile parameters: - $ref: '#/components/parameters/ExadataInfrastructureIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The configuration file for the specified Exadata Cloud@Customer infrastructure is being retrieved. headers: content-length: description: Size of the file. schema: type: integer format: int64 etag: description: For optimistic concurrency control. See `if-match`. schema: type: string last-modified: description: The date and time the configuration file was created, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. schema: type: string format: date-time 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/octet-stream: schema: format: binary type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Downloads the configuration file for the specified Exadata infrastructure. tags: - database x-related-resource: '#/definitions/ExadataInfrastructure' /exadataInfrastructures/{exadataInfrastructureId}/unAllocatedResources: get: description: 'Gets un allocated resources information for the specified Exadata infrastructure. Applies to Exadata Cloud@Customer instances only. ' operationId: GetExadataInfrastructureUnAllocatedResources parameters: - $ref: '#/components/parameters/ExadataInfrastructureIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/OptionalDbServersQueryParam' responses: 200: description: The Exadata Cloud@Customer infrastructure un allocated resources details. 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/ExadataInfrastructureUnAllocatedResources' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetExadataInfrastructureUnAllocatedResources tags: - database x-example: 'GET /20160918/exadataInfrastructures/<exadataInfrastructureId>/unAllocatedResources Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' /exadataInfrastructures/{exadataInfrastructureId}/vmClusterNetworks: get: description: 'Gets a list of the VM cluster networks in the specified compartment. Applies to Exadata Cloud@Customer instances only. ' operationId: ListVmClusterNetworks parameters: - $ref: '#/components/parameters/ExadataInfrastructureIdPathParam' - $ref: '#/components/parameters/CompartmentId' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' - $ref: '#/components/parameters/ListVmClusterNetworksSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ListVmClusterNetworksFilterByLifecycleStateQueryParam' - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: A list of VM cluster networks in the specified compartment. 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/VmClusterNetworkSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListVmClusterNetworks tags: - database x-example: 'GET /20160918/vmClusterNetworks?compartmentId=<compartmentId>&limit=10 Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/VmClusterNetwork' post: description: 'Creates the VM cluster network. Applies to Exadata Cloud@Customer instances only. To create a cloud VM cluster in an Exadata Cloud Service instance, use the [CreateCloudVmCluster ](#/en/database/latest/CloudVmCluster/CreateCloudVmCluster) operation. ' operationId: CreateVmClusterNetwork parameters: - $ref: '#/components/parameters/ExadataInfrastructureIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: 'The request was successfully received and the create operation is in progress. ' 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/VmClusterNetwork' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateVmClusterNetwork tags: - database x-example: "POST /20160918/exadataInfrastructures/<exadataInfrastructureId>vmClusterNetworks\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\" : \"testVmClusterNw\",\n \"compartmentId\" : \"ocid1.tenancy.oc1.<example_unique_ID>\",\n \"scans\": [\n {\n \"hostname\": \"sea2410c4-scan\",\n \"port\": 1521,\n \"ips\": [\"10.0.20.20\", \"10.0.20.21\", \"10.0.20.22\"]\n }\n ],\n \"dnsServer\" : [\"192.168.10.10\"],\n \"ntpServer\" : [\"192.168.10.20\"],\n \"vmNetworks\":\n [\n {\n \"network_type\": \"client\",\n \"domainname\": \"sredatart.srevcn.oraclevcn.com\",\n \"netmask\": \"255.255.255.0\",\n \"gateway\": \"10.0.20.1\",\n \"prefix\": \"myprefix1\",\n \"vlanId\": \"0-4095\",\n \"cidr\": \"192.168.19.2/16\",\n \"nodes\":\n [\n {\n \"lifecycleState\" : \"CREATING\",\n \"dbServerId\": \"ocid1.dbserver.oc1.\",\n \"hostname\": \"sea2410c4n7\",\n \"ip\": \"10.0.20.14\",\n \"vipHostname\": \"sea2410c4n7-vip\",\n \"vip\": \"10.0.20.15\"\n },\n {\n \"lifecycleState\" : \"CREATING\",\n \"dbServerId\": \"ocid1.dbserver.oc1.\",\n \"hostname\": \"sea2410c4n8\",\n \"ip\": \"10.0.20.16\",\n \"vipHostname\": \"sea2410c4n8-vip\",\n \"vip\": \"10.0.20.17\"\n }\n ]\n },\n {\n \"network_type\": \"backup\",\n \"domainname\": \"srebackupsn.srevcn.oraclevcn.com\",\n \"netmask\": \"255.255.255.0\",\n \"gateway\": \"10.0.21.1\",\n \"prefix\": \"myprefix2\",\n \"vlanId\": \"0-4095\",\n \"cidr\": \"192.168.19.2/16\",\n \"nodes\":\n [\n {\n \"lifecycleState\" : \"CREATING\",\n \"dbServerId\": \"ocid1.dbserver.oc1.\",\n \"hostname\": \"sea2410c4bk7\",\n \"ip\": \"10.0.21.8\",\n \"vipHostname\": \"sea2411c4n7-vip\",\n \"vip\": \"192.168.19.3\"\n },\n {\n \"lifecycleState\" : \"CREATING\",\n \"dbServerId\": \"ocid1.dbserver.oc1.\",\n \"hostname\": \"sea2410c4bk8\",\n \"ip\": \"10.0.21.9\",\n \"vipHostname\": \"sea2412c4n7-vip\",\n \"vip\": \"192.168.19.4\"\n }\n ]\n }\n ]\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/VmClusterNetworkDetails' description: Request to create the Cloud@Customer VM cluster network. required: true /exadataInfrastructures/{exadataInfrastructureId}/vmClusterNetworks/actions/generateRecommendedNetwork: post: description: 'Generates a recommended Cloud@Customer VM cluster network configuration. ' operationId: GenerateRecommendedVmClusterNetwork parameters: - $ref: '#/components/parameters/ExadataInfrastructureIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The request was successfully received. 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/VmClusterNetworkDetails' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Generates a recommended VM cluster network configuration. tags: - database x-example: "POST /20160918/exadataInfrastructures/<exadataInfrastructureId>/vmClusterNetworks/actions/generateRecommendedNetwork\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\" : \"ocid1.tenancy.oc1.<unique_ID>\",\n \"displayName\" : \"testVmClusterNw\",\n \"dbServers\" : [\"ocid1.dbserver.oc1.\", \"ocid1.dbserver.oc1.\"],\n \"dns\" : [\"192.168.10.10\"],\n \"ntp\" : [\"192.168.10.20\"],\n \"networks\" : [{\n \"networkType\" : \"CLIENT\",\n \"vlanId\" : \"0-54095\",\n \"cidr\" : \"192.168.19.2/16\",\n \"gateway\" : \"192.168.20.1\",\n \"netmask\" : \"255.255.0.0\",\n \"domain\" : \"oracle.com\",\n \"prefix\" : \"myprefix1\"\n },{\n \"networkType\" : \"BACKUP\",\n \"vlanId\" : \"0-54095\",\n \"cidr\" : \"192.168.19.1/16\",\n \"gateway\" : \"192.168.20.1\",\n \"netmask\" : \"255.255.0.0\",\n \"domain\" : \"oracle.com\",\n \"prefix\" : \"myprefix2\"\n }]\n}\n" x-related-resource: '#/definitions/ExadataInfrastructure' requestBody: content: application/json: schema: $ref: '#/components/schemas/GenerateRecommendedNetworkDetails' description: Request to generate a recommended Cloud@Customer VM cluster network configuration. required: true /exadataInfrastructures/{exadataInfrastructureId}/vmClusterNetworks/{vmClusterNetworkId}: delete: description: 'Deletes the specified VM cluster network. Applies to Exadata Cloud@Customer instances only. To delete a cloud VM cluster in an Exadata Cloud Service instance, use the [DeleteCloudVmCluster ](#/en/database/latest/CloudVmCluster/DeleteCloudVmCluster) operation. ' operationId: DeleteVmClusterNetwork parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/ExadataInfrastructureIdPathParam' - $ref: '#/components/parameters/VmClusterNetworkIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 204: description: The request to delete the VM cluster network was accepted. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Deletes the specified VM cluster network. tags: - database x-related-resource: '#/definitions/VmClusterNetwork' get: description: 'Gets information about the specified VM cluster network. Applies to Exadata Cloud@Customer instances only. To get information about a cloud VM cluster in an Exadata Cloud Service instance, use the [GetCloudVmCluster ](#/en/database/latest/CloudVmCluster/GetCloudVmCluster) operation. ' operationId: GetVmClusterNetwork parameters: - $ref: '#/components/parameters/ExadataInfrastructureIdPathParam' - $ref: '#/components/parameters/VmClusterNetworkIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: The specified Exadata Cloud@Customer VM cluster network. 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/VmClusterNetwork' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetVmClusterNetwork tags: - database x-example: 'GET /20160918/exadataInfrastructures/<exadataInfrastructureId>/vmClusterNetworks/<vmClusterNetworkId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' put: description: 'Updates the specified VM cluster network. Applies to Exadata Cloud@Customer instances only. To update a cloud VM cluster in an Exadata Cloud Service instance, use the [UpdateCloudVmCluster ](#/en/database/latest/CloudVmCluster/UpdateCloudVmCluster) operation. ' operationId: UpdateVmClusterNetwork parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/ExadataInfrastructureIdPathParam' - $ref: '#/components/parameters/VmClusterNetworkIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: The request was successfully received and the Exadata Cloud@Customer VM cluster network update is in progress. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/VmClusterNetwork' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Updates the specified VM cluster network. tags: - database x-example: "PUT /latest/exadataInfrastructures/<exadataInfrastructureId>/vmClusterNetworks/<vmClusterNetworkId>\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"dnsServer\" : [\"192.168.10.30\"],\n \"ntpServer\" : [\"192.168.10.40\"]\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateVmClusterNetworkDetails' description: Request to update the properties of a VM cluster network. required: true /exadataInfrastructures/{exadataInfrastructureId}/vmClusterNetworks/{vmClusterNetworkId}/actions/downloadConfigFile: post: description: 'Downloads the configuration file for the specified VM cluster network. Applies to Exadata Cloud@Customer instances only. ' operationId: DownloadVmClusterNetworkConfigFile parameters: - $ref: '#/components/parameters/ExadataInfrastructureIdPathParam' - $ref: '#/components/parameters/VmClusterNetworkIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The configuration file for the specified VM cluster network is being retrieved. headers: content-length: description: Size of the file. schema: type: integer format: int64 etag: description: For optimistic concurrency control. See `if-match`. schema: type: string last-modified: description: The date and time the configuration file was created, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. schema: type: string format: date-time 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/octet-stream: schema: format: binary type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Downloads the configuration file for the specified VM Cluster Network. tags: - database x-related-resource: '#/definitions/VmClusterNetwork' /exadataInfrastructures/{exadataInfrastructureId}/vmClusterNetworks/{vmClusterNetworkId}/actions/resize: post: description: 'Adds or removes Db server network nodes to extend or shrink the existing VM cluster network. Applies to Exadata Cloud@Customer instances only. ' operationId: ResizeVmClusterNetwork parameters: - $ref: '#/components/parameters/ExadataInfrastructureIdPathParam' - $ref: '#/components/parameters/VmClusterNetworkIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: The request was successfully received and the Exadata Cloud@Customer operation is in progress. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/VmClusterNetwork' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Adds or removes Db server network nodes in the VM cluster network. tags: - database x-example: 'POST /20160918/vmClusterNetworks/<vmClusterNetworkId>/actions/resize Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/VmClusterNetwork' requestBody: content: application/json: schema: $ref: '#/components/schemas/ResizeVmClusterNetworkDetails' description: Request to add or remove Db server network nodes in the VM cluster network. required: true /exadataInfrastructures/{exadataInfrastructureId}/vmClusterNetworks/{vmClusterNetworkId}/actions/validate: post: description: 'Validates the specified VM cluster network. Applies to Exadata Cloud@Customer instances only. ' operationId: ValidateVmClusterNetwork parameters: - $ref: '#/components/parameters/ExadataInfrastructureIdPathParam' - $ref: '#/components/parameters/VmClusterNetworkIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The specified VM cluster network. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/VmClusterNetwork' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Validates the specified VM cluster network. tags: - database x-example: 'POST /20160918/vmClusterNetworks/<vmClusterNetworkId>/actions/validate Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/VmClusterNetwork' /exadbVmClusters: get: description: 'Gets a list of the Exadata VM clusters on Exascale Infrastructure in the specified compartment. Applies to Exadata Database Service on Exascale Infrastructure only. ' operationId: ListExadbVmClusters parameters: - $ref: '#/components/parameters/CompartmentId' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' - $ref: '#/components/parameters/ListExadbVmClustersSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ListExadbVmClustersFilterByLifecycleStateQueryParam' - $ref: '#/components/parameters/ListExadbVmClustersFilterByExascaleDbStorageVaultIdQueryParam' - $ref: '#/components/parameters/ListExadbVmClustersFilterByClusterPlacementGroupIdQueryParam' - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: List of the Exadata VM clusters on Exascale Infrastructure. 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/ExadbVmClusterSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListExadbVmClusters tags: - database x-example: 'GET /20160918/exadbVmClusters?compartmentId=<compartmentId>&limit=10 Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/ExadbVmCluster' post: description: 'Creates an Exadata VM cluster on Exascale Infrastructure ' operationId: CreateExadbVmCluster parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: The request was successfully received and the create Exadata VM cluster on Exascale Infrastructure operation is in progress. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ExadbVmCluster' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateExadbVmCluster tags: - database x-example: "POST /20160918/exadbVmClusters\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\" : \"exadbVmCluster\",\n \"compartmentId\" : \"ocid1.tenancy.oc1.<unique_ID>\",\n \"sshPublicKeys\" : [ \"ssh-rsa <public_SSH_key> name@example.com\" ],\n \"availabilityDomain\" : \"OXET:PHX-AD-1\",\n \"licenseModel\" : \"LICENSE_INCLUDED\",\n \"domain\" : \"example.com\",\n \"hostname\" : \"apollo\",\n \"scanListenerPortTcp\" : 1521,\n \"scanListenerPortTcpSsl\" : 2484,\n \"privateZoneId\" : \"ocid1.dns-zone.oc1.<unique_ID>\",\n \"timeZone\" : \"PST\",\n \"subnetId\" : \"ocid1.subnet.oc1.phx.<unique_ID>\",\n \"backupSubnetId\" : \"ocid1.subnet.oc1.phx.<unique_ID>\",\n \"shape\" : \"ExaDB-XS-2\",\n \"gridImageId\" : \"ocid1.gridimage.oc1.<unique_ID>\",\n \"totalECpuCount\" : 10,\n \"enabledECpuCount\": 2,\n \"vmFileSystemStorage\": {\n \"totalSizeInGbs\": 1000\n },\n \"exascaleDbStorageVaultId\": \"ocid1.exascaledbstoragevault.oc1.<unique_ID>\",\n \"nodeCount\": 2\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateExadbVmClusterDetails' description: 'Request to create a Exadata VM cluster on Exascale Infrastructure. Applies to Exadata Database Service on Exascale Infrastructure only. See [The New Exadata Cloud Service Resource Model](/iaas/Content/Database/iaas/Content/Database/Concepts/exaflexsystem.htm#exaflexsystem_topic-resource_model) for information on this resource type. ' required: true /exadbVmClusters/{exadbVmClusterId}: delete: description: 'Deletes the specified Exadata VM cluster on Exascale Infrastructure. Applies to Exadata Database Service on Exascale Infrastructure only. ' operationId: DeleteExadbVmCluster parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/ExadbVmClusterIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 204: description: The request to delete the Exadata VM cluster on Exascale Infrastructure was accepted. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application-json: example: '{} ' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Deletes the specified Exadata VM cluster on Exascale Infrastructure. tags: - database x-example: 'DELETE /20160918/exadbVmClusters/<exadbVmClusterId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> { } ' x-related-resource: '#/definitions/ExadbVmCluster' get: description: 'Gets information about the specified Exadata VM cluster on Exascale Infrastructure. Applies to Exadata Database Service on Exascale Infrastructure only. ' operationId: GetExadbVmCluster parameters: - $ref: '#/components/parameters/ExadbVmClusterIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: Information about the Exadata VM cluster on Exascale Infrastructure 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/ExadbVmCluster' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetExadbVmCluster tags: - database x-example: 'GET /20160918/exadbVmClusters/<exadbVmClusterId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' put: description: 'Updates the specified Exadata VM cluster on Exascale Infrastructure. Applies to Exadata Database Service on Exascale Infrastructure only. ' operationId: UpdateExadbVmCluster parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/ExadbVmClusterIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: The request was successfully received and the Exadata VM cluster on Exascale Infrastructure update operation is in progress. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ExadbVmCluster' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Updates the specified Exadata VM cluster on Exascale Infrastructure. tags: - database x-example: "PUT /20160918/exadbVmClusters/<exadbVmClusterId>\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"enabledECpuCount\" : 10,\n \"licenseModel\" : \"LICENSE_INCLUDED\",\n \"dbCertificateId\" : \"ocid1.dbcertificate.oc1.\"\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateExadbVmClusterDetails' description: Request to update the attributes of a Exadata VM cluster on Exascale Infrastructure. required: true /exadbVmClusters/{exadbVmClusterId}/actions/addDbNodeSnapshots: post: description: 'Add a database node snapshots to the Exadb VM cluster.. ' operationId: AddDbnodeSnapshotsForExadbVmCluster parameters: - $ref: '#/components/parameters/ExadbVmClusterIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: The request was successfully received to create DB Node Snapshots. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DbnodeSnapshots' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: AddDbnodeSnapshotsForExadbVmCluster tags: - database x-example: "POST /20160918/exadbVmClusters/<exadbVmClusterId>/actions/addDbNodeSnapshot\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"name\" : \"snapshot-1\",\n \"sourceDbnodeIds\": [\n \"ocid1.dbnode.oc1.\",\n \"ocid1.dbnode.oc1.\",\n \"ocid1.dbnode.oc1.\"\n ]\n}\n" x-obmcs-terraform: actionType: MANAGEMENT_RESOURCE x-related-resource: '#/definitions/ExadbVmCluster' requestBody: content: application/json: schema: $ref: '#/components/schemas/AddDbnodeSnapshotsForExadbVmClusterDetails' description: 'Request to add a database node snapshots to the Exadb VM cluster.. ' required: true /exadbVmClusters/{exadbVmClusterId}/actions/changeCompartment: post: description: 'Moves a Exadata VM cluster on Exascale Infrastructure and its dependent resources to another compartment. Applies to Exadata Database Service on Exascale Infrastructure only. ' operationId: ChangeExadbVmClusterCompartment parameters: - $ref: '#/components/parameters/ExadbVmClusterIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: The request was successfully received and the change compartment action is being performed. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ChangeExadbVmClusterCompartment tags: - database x-example: "POST /20160918/exadbVmClusters/<exadbVmClusterId>/actions/changeCompartment\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\" : \"ocid1.compartment.oc1.<unique_ID>\"\n}\n" x-related-resource: '#/definitions/ExadbVmCluster' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeExadbVmClusterCompartmentDetails' description: Request to move Exadata VM cluster on Exascale Infrastructure to a different compartment required: true /exadbVmClusters/{exadbVmClusterId}/actions/changeSubscription: post: description: 'Associate a Exadata VM cluster on Exascale Infrastructure with a different subscription. ' operationId: ChangeExadbVmClusterSubscription parameters: - $ref: '#/components/parameters/ExadbVmClusterIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: The request was successfully received and the update subscription action is being performed. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ChangeExadbVmClusterSubscription tags: - database x-example: "POST /20160918/exadbVmClusters/<exadbVmClusterId>/actions/changeSubscription\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"subscriptionId\" : \"ocid1.subscription.oc1.<unique_ID>\",\n \"isDefault\" : false\n}\n" x-related-resource: '#/definitions/ExadbVmCluster' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeExadbVmClusterSubscriptionDetails' description: Associate a Exadata VM cluster on Exascale Infrastructure with a different subscription. required: true /exadbVmClusters/{exadbVmClusterId}/actions/removeVirtualMachine: post: description: 'Remove Virtual Machines from the Exadata VM cluster on Exascale Infrastructure. Applies to Exadata Cloud instances only. ' operationId: RemoveVirtualMachineFromExadbVmCluster parameters: - $ref: '#/components/parameters/ExadbVmClusterIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: The request was successfully received and the removing Virtual Machines action is being performed. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ExadbVmCluster' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: RemoveVirtualMachineFromExadbVmCluster tags: - database x-example: "POST /20160918/exadbVmClusters/<exadbVmClusterId>/actions/removeVirtualMachine\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"dbNodes\" : [\n {\n \"dbNodeId\" : \"ocid1.dbnode.oc1.\"\n },\n {\n \"dbNodeId\" : \"ocid1.dbnode.oc1.\"\n }\n ]\n}\n" x-related-resource: '#/definitions/ExadbVmCluster' requestBody: content: application/json: schema: $ref: '#/components/schemas/RemoveVirtualMachineFromExadbVmClusterDetails' description: Request to remove Virtual Machines from the Exadata VM cluster on Exascale Infrastructure. required: true /exadbVmClusters/{exadbVmClusterId}/updateHistoryEntries: get: description: 'Gets the history of the maintenance update actions performed on the specified Exadata VM cluster on Exascale Infrastructure. ' operationId: ListExadbVmClusterUpdateHistoryEntries parameters: - $ref: '#/components/parameters/ExadbVmClusterIdPathParam' - $ref: '#/components/parameters/FilterByExadbVmClusterUpdateTypeQueryParam' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: The maintenance update history for the specified Exadata VM cluster on Exascale Infrastructure. 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/ExadbVmClusterUpdateHistoryEntrySummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListExadbVmClusterUpdateHistoryEntries tags: - database x-example: 'GET /20160918/exadbVmClusters/<exadbVmClusterId>/updateHistoryEntries?limit=100 Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/ExadbVmClusterUpdateHistoryEntry' /exadbVmClusters/{exadbVmClusterId}/updateHistoryEntries/{updateHistoryEntryId}: get: description: 'Gets the maintenance update history details for the specified update history entry. ' operationId: GetExadbVmClusterUpdateHistoryEntry parameters: - $ref: '#/components/parameters/ExadbVmClusterIdPathParam' - $ref: '#/components/parameters/UpdateHistoryEntryIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: The maintenance update history details for the specified update history entry. 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/ExadbVmClusterUpdateHistoryEntry' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetExadbVmClusterUpdateHistoryEntry tags: - database x-example: 'GET /20160918/exadbVmClusters/<exadbVmClusterId>/updateHistoryEntries/<updateHistoryEntryId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/ExadbVmClusterUpdateHistoryEntry' /exadbVmClusters/{exadbVmClusterId}/updates: get: description: 'Lists the maintenance updates that can be applied to the specified Exadata VM cluster on Exascale Infrastructure. ' operationId: ListExadbVmClusterUpdates parameters: - $ref: '#/components/parameters/ExadbVmClusterIdPathParam' - $ref: '#/components/parameters/FilterByExadbVmClusterUpdateTypeQueryParam' - $ref: '#/components/parameters/FilterByUpdateTypeVersionQueryParam' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: A list of the maintenance update packages. 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/ExadbVmClusterUpdateSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListExadbVmClusterUpdates tags: - database x-example: 'GET /20160918/exadbVmClusters/<exadbVmClusterId>/updates?limit=10 Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/ExadbVmClusterUpdate' /exadbVmClusters/{exadbVmClusterId}/updates/{updateId}: get: description: 'Gets information about a specified maintenance update package for a Exadata VM cluster on Exascale Infrastructure. ' operationId: GetExadbVmClusterUpdate parameters: - $ref: '#/components/parameters/ExadbVmClusterIdPathParam' - $ref: '#/components/parameters/UpdateIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: The maintenance update package. 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/ExadbVmClusterUpdate' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetExadbVmClusterUpdate tags: - database x-example: 'GET /20160918/exadbVmClusters/<exadbVmClusterId>/updates/<updateId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/ExadbVmClusterUpdate' /exascaleDbStorageVaults: get: description: 'Gets a list of the Exadata Database Storage Vaults in the specified compartment. ' operationId: ListExascaleDbStorageVaults parameters: - $ref: '#/components/parameters/CompartmentId' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' - $ref: '#/components/parameters/ListExascaleDbStorageVaultsSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ListExascaleDbStorageVaultsFilterByLifecycleStateQueryParam' - $ref: '#/components/parameters/ListExascaleDbStorageVaultsFilterByClusterPlacementGroupIdQueryParam' - $ref: '#/components/parameters/AttachedShapeAttributesNotEqualToQueryParam' - $ref: '#/components/parameters/AttachedShapeAttributesQueryParam' - $ref: '#/components/parameters/VmClusterCountLessThanOrEqualToQueryParam' - $ref: '#/components/parameters/VmClusterCountGreaterThanOrEqualToQueryParam' - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/ListExascaleDbStorageVaultsFilterByExadataInfrastructureIdQueryParam' responses: 200: description: List of the Exadata Database Storage Vaults 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/ExascaleDbStorageVaultSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListExascaleDbStorageVaults tags: - database x-example: 'GET /20160918/exascaleDbStorageVaults?compartmentId=<compartmentId>&limit=10 Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/ExascaleDbStorageVault' post: description: 'Creates an Exadata Database Storage Vault ' operationId: CreateExascaleDbStorageVault parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: The request was successfully received and the create Exadata Database Storage Vault. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ExascaleDbStorageVault' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateExascaleDbStorageVault tags: - database x-example: "POST /20160918/exascaleDbStorageVaults\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\" : \"exascaleDbStorageVault\",\n \"compartmentId\" : \"ocid1.tenancy.oc1.<unique_ID>\",\n \"availabilityDomain\" : \"OXET:PHX-AD-1\",\n \"highCapacityDatabaseStorage\": {\n \"totalSizeInGbs\": 256\n },\n \"additionalFlashCacheInPercent\": 20\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateExascaleDbStorageVaultDetails' description: 'Request to create a Exadata Database Storage Vault. ' required: true /exascaleDbStorageVaults/{exascaleDbStorageVaultId}: delete: description: 'Deletes the specified Exadata Database Storage Vault. ' operationId: DeleteExascaleDbStorageVault parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/ExascaleDbStorageVaultIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 204: description: The request to delete the Exadata Database Storage Vault was accepted. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Deletes the specified Exadata Database Storage Vault. tags: - database x-example: 'DELETE /20160918/exascaleDbStorageVaults/<storageVaultId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/ExascaleDbStorageVault' get: description: 'Gets information about the specified Exadata Database Storage Vaults in the specified compartment. ' operationId: GetExascaleDbStorageVault parameters: - $ref: '#/components/parameters/ExascaleDbStorageVaultIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: Information about the Exadata Database Storage Vault. 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/ExascaleDbStorageVault' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetExascaleDbStorageVault tags: - database x-example: 'GET /20160918/exascaleDbStorageVaults/<storageVaultId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' put: description: 'Updates the specified Exadata Database Storage Vault. ' operationId: UpdateExascaleDbStorageVault parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/ExascaleDbStorageVaultIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: The request was successfully received and the Exadata Database Storage Vault update operation is in progress. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ExascaleDbStorageVault' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Updates the specified Exadata Database Storage Vault. tags: - database x-example: "PUT /20160918/exascaleDbStorageVaults/<storageVaultId>\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"highCapacityDatabaseStorage\": {\n \"totalSizeInGbs\": 256\n },\n \"additionalFlashCacheInPercent\": 20,\n \"displayName\": \"exascaleVaultName\"\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateExascaleDbStorageVaultDetails' description: Request to update the attributes of a Exadata Database Storage Vault. required: true /exascaleDbStorageVaults/{exascaleDbStorageVaultId}/actions/changeCompartment: post: description: 'Moves a Exadata Database Storage Vault to another compartment. ' operationId: ChangeExascaleDbStorageVaultCompartment parameters: - $ref: '#/components/parameters/ExascaleDbStorageVaultIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: The request was successfully received and the change compartment action is being performed. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ChangeExascaleDbStorageVaultCompartment tags: - database x-example: "POST /20160918/exascaleDbStorageVaults/<storageVaultId>/actions/changeCompartment\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\"\n}\n" x-related-resource: '#/definitions/ExascaleDbStorageVault' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeExascaleDbStorageVaultCompartmentDetails' description: Request to move Exadata Database Storage Vault to a different compartment required: true /exascaleDbStorageVaults/{exascaleDbStorageVaultId}/actions/changeSubscription: post: description: 'Associate a Exadata Database Storage Vault with a different subscription. ' operationId: ChangeExascaleDbStorageVaultSubscription parameters: - $ref: '#/components/parameters/ExascaleDbStorageVaultIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: The request was successfully received and the update subscription action is being performed. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ChangeExascaleDbStorageVaultSubscription tags: - database x-example: "POST /20160918/exascaleDbStorageVaults/<storageVaultId>/actions/changeSubscription\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"subscriptionId\": \"ocid1.subscription.oc1..<unique_ID>\"\n}\n" x-related-resource: '#/definitions/ExascaleDbStorageVault' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeExascaleDbStorageVaultSubscriptionDetails' description: Associate a Exadata Database Storage Vault with a different subscription. required: true /executionActions: get: description: 'Lists the execution action resources in the specified compartment. ' operationId: ListExecutionActions parameters: - $ref: '#/components/parameters/CompartmentId' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/ListExecutionActionsSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ListExecutionActionsFilterByLifecycleStateQueryParam' - $ref: '#/components/parameters/ListExecutionActionsFilterByExecutionWindowIdQueryParam' - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' responses: 200: description: 'A list of the execution action resources in the specified compartment. ' 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/ExecutionActionSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListExecutionActions tags: - database x-example: 'GET /20160918/executionActions?compartmentId=<compartmentId>&limit=10 Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/ExecutionAction' post: description: 'Creates an execution action resource. ' operationId: CreateExecutionAction parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: 'The request was successfully received and the create execution action operation is in progress. ' 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ExecutionAction' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateExecutionAction tags: - database x-example: "POST /20160918/executionActions\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\" : \"ocid1.tenancy.oc1.<unique_ID>\",\n \"executionWindowId\" : \"ocid1.executionWindow.oc1.phx.\",\n \"executionActionType\" : \"DB_SERVER_FULL_SOFTWARE_UPDATE\",\n \"executionActionParams\" : [\n {\"patchingMode\": \"Rolling\"},\n {\"enableCustomtActionTimeout\": \"true\"},\n {\"customtActionTimeout\": \"30\"}\n ],\n \"actionMembers\": [{\n \"memberOrder\": \"1\",\n \"memberId\": \"ocid1.dbServer.oc1.phx.\"\n },\n {\n \"memberOrder\": \"2\",\n \"memberId\": \"ocid1.dbServer.oc1.phx.\"\n }]\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateExecutionActionDetails' description: Request to create execution action. required: true /executionActions/{executionActionId}: delete: description: 'Deletes the execution action. ' operationId: DeleteExecutionAction parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/ExecutionActionIdPathParam' responses: 204: description: The request to delete the execution action was accepted. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Delete an execution action. tags: - database x-related-resource: '#/definitions/ExecutionAction' get: description: 'Gets information about the specified execution action. ' operationId: GetExecutionAction parameters: - $ref: '#/components/parameters/ExecutionActionIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: The execution action details. 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/ExecutionAction' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Get ExecutionAction tags: - database x-example: 'GET /20160918/executionActions/<executionActionId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' put: description: 'Updates the execution action resource. ' operationId: UpdateExecutionAction parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/ExecutionActionIdPathParam' responses: 200: description: 'The request was successfully received and the execution action update is in progress. ' 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ExecutionAction' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Updates the specified execution action tags: - database x-example: "PUT /latest/executionActions/<executionActionId>\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"schedulingPolicyId\" : \"ocid1.schedulingpolicy.oc1.phx.\",\n \"executionActionParams\" : [\n {\"patchingMode\": \"Rolling\"},\n {\"enableCustomtActionTimeout\": \"false\"}\n ],\n \"actionMembers\": [{\n \"memberOrder\": \"1\",\n \"memberId\": \"ocid1.dbServer.oc1.phx.\",\n },\n {\n \"memberOrder\": \"2\",\n \"memberId\": \"ocid1.dbServer.oc1.phx.\",\n }]\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateExecutionActionDetails' description: Request to update the properties of a execution action. required: true /executionActions/{executionActionId}/actions/moveActionMember: post: description: 'Moves an execution action member to this execution action resource from another. ' operationId: MoveExecutionActionMember parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/ExecutionActionIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: 'The request was successfully received and the add component operation is in progress. ' 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ExecutionAction' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Moves an execution action member to this execution action resource from another. tags: - database x-example: "POST /latest/executionActions/<executionActionId>/actions/moveActionMember\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"sourceExecutionActionId\" : \"ocid1.executionAction.oc1.phx.\",\n \"executionActionMemberId\" : \"ocid1.dbServer.oc1.phx.\",\n \"executionActionMemberCount\" : null\n}\n" x-related-resource: '#/definitions/ExecutionAction' requestBody: content: application/json: schema: $ref: '#/components/schemas/MoveExecutionActionMemberDetails' description: Request to move an execution action member to this execution action resource from another. required: true /executionWindows: get: description: 'Lists the execution window resources in the specified compartment. ' operationId: ListExecutionWindows parameters: - $ref: '#/components/parameters/CompartmentId' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/ListExecutionWindowsSortByQueryParam' - $ref: '#/components/parameters/ListExecutionWindowsByResourceIdQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ListExecutionWindowsFilterByLifecycleStateQueryParam' - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' responses: 200: description: 'A list of execution window resources in the specified compartment. ' 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/ExecutionWindowSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListExecutionWindows tags: - database x-example: 'GET /20160918/executionWindows?compartmentId=<compartmentId>&limit=10 Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/ExecutionWindow' post: description: 'Creates an execution window resource. ' operationId: CreateExecutionWindow parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: 'The request was successfully received and the create execution window operation is in progress. ' 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ExecutionWindow' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateExecutionWindow tags: - database x-example: "POST /20160918/executionWindows\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\" : \"ocid1.tenancy.oc1.\",\n \"executionResourceId\" : \"ocid1.maintenanceRun.oc1.phx.\",\n \"timeScheduled\" : \"2018-12-23T01:59:07.030Z\",\n \"windowDurationInMins\" : 360,\n \"isEnforcedDuration\" : false\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateExecutionWindowDetails' description: Request to create execution window. required: true /executionWindows/{executionWindowId}: delete: description: 'Deletes the execution window. ' operationId: DeleteExecutionWindow parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/ExecutionWindowIdPathParam' responses: 204: description: The request to delete the execution window was accepted. 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 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Delete an execution window. tags: - database x-related-resource: '#/definitions/ExecutionWindow' get: description: 'Gets information about the specified execution window. ' operationId: GetExecutionWindow parameters: - $ref: '#/components/parameters/ExecutionWindowIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: The execution window details. 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/ExecutionWindow' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetExecutionWindow tags: - database x-example: 'GET /20160918/executionWindows/<executionWindowId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' put: description: 'Updates the execution window resource. ' operationId: UpdateExecutionWindow parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/ExecutionWindowIdPathParam' responses: 200: description: 'The request was successfully received and the execution window update is in progress. ' 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ExecutionWindow' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Updates the specified execution window tags: - database x-example: "PUT /latest/executionWindows/<executionWindowId>\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"timeScheduled\" : \"2018-12-23T01:59:07.030Z\",\n \"windowDurationInMins\" : 360,\n \"isEnforcedDuration\" : false,\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateExecutionWindowDetails' description: Request to update the properties of a execution window. required: true /executionWindows/{executionWindowId}/actions/reorder: post: description: 'Reorders the execution actions under this execution window resource. ' operationId: ReorderExecutionActions parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/ExecutionWindowIdPathParam' responses: 200: description: 'The request was successfully received and the execution action reordering is in progress. ' 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ExecutionWindow' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Reorders the execution actions under this execution window resource. tags: - database x-example: "POST /latest/executionWindows/<executionWindowId>/actions/reorder\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"executionActionOrderList\" : [\n {\n \"actionOrder\": \"1\",\n \"actionResourceId\": \"ocid1.executionAction.oc1.phx.\"\n },\n {\n \"actionOrder\": \"2\",\n \"actionResourceId\": \"ocid1.executionAction.oc1.phx.\"\n }\n ]\n}\n" x-related-resource: '#/definitions/ExecutionWindow' requestBody: content: application/json: schema: $ref: '#/components/schemas/ReorderExecutionActionDetails' description: Request to reorder the execution actions under this execution window resource. required: true /externalBackupJobs: post: description: 'Creates a new backup resource and returns the information the caller needs to back up an on-premises Oracle Database to Oracle Cloud Infrastructure. **Note:** This API is used by an Oracle Cloud Infrastructure Python script that is packaged with the Oracle Cloud Infrastructure CLI. Oracle recommends that you use the script instead using the API directly. See [Migrating an On-Premises Database to Oracle Cloud Infrastructure by Creating a Backup in the Cloud](/Content/Database/Tasks/mig-onprembackup.htm) for more information. ' operationId: CreateExternalBackupJob parameters: - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The request was successfully received and the backup resource is being provisioned. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ExternalBackupJob' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateExternalBackupJob tags: - database x-example: "POST /20160918/externalBackupJobs\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"availabilityDomain\" : \"OXET:PHX-AD-1\",\n \"compartmentId\" : \"ocid1.tenancy.oc1..<unique_ID>\",\n \"dbVersion\" : \"12.1.0.2\",\n \"dbName\" : \"<example_db>\"\n \"externalDatabaseIdentifier\" : \"3942196782\",\n \"displayName\" : \"<example_display_name>\"\n \"characterSet\" : \"AL32UTF8\",\n \"ncharacterSet\" : \"AL16UTF16\"\n \"shape\" : \"BM.DensioIO1.36\"\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateExternalBackupJobDetails' description: Request to create a cloud backup resource for a database running outside the cloud. required: true /externalBackupJobs/{backupId}: get: description: 'Gets information about the specified external backup job. **Note:** This API is used by an Oracle Cloud Infrastructure Python script that is packaged with the Oracle Cloud Infrastructure CLI. Oracle recommends that you use the script instead using the API directly. See [Migrating an On-Premises Database to Oracle Cloud Infrastructure by Creating a Backup in the Cloud](/Content/Database/Tasks/mig-onprembackup.htm) for more information. ' operationId: GetExternalBackupJob parameters: - $ref: '#/components/parameters/BackupIdPathParam' responses: 200: description: The backup of an external database. 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/ExternalBackupJob' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetExternalBackupJob tags: - database x-example: 'GET /20160918/externalBackupJobs/<backupId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' /externalBackupJobs/{backupId}/actions/complete: post: description: 'Changes the status of the standalone backup resource to `ACTIVE` after the backup is created from the on-premises database and placed in Oracle Cloud Infrastructure Object Storage. **Note:** This API is used by an Oracle Cloud Infrastructure Python script that is packaged with the Oracle Cloud Infrastructure CLI. Oracle recommends that you use the script instead using the API directly. See [Migrating an On-Premises Database to Oracle Cloud Infrastructure by Creating a Backup in the Cloud](/Content/Database/Tasks/mig-onprembackup.htm) for more information. ' operationId: CompleteExternalBackupJob parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/BackupIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The request was successfully received and the update of the backup resource is in progress. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ExternalBackupJob' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CompleteExternalBackupJob tags: - database x-example: "POST /20160918/externalBackupJobs/<backupId>/actions/complete\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"cfBackupHandle\" : \"nlongterm_example_db_3829144951_16s6pt5b_1_1_20170614_946664619\"\n \"spfBackuphandle\" : \"nlongterm_example_db_36495879761_185h5yuu_1_2_20170614_946665678\"\n}\n" x-related-resource: '#/definitions/ExternalBackupJob' requestBody: content: application/json: schema: $ref: '#/components/schemas/CompleteExternalBackupJobDetails' description: Updates the status of the backup resource. required: true /externalcontainerdatabases: get: description: 'Gets a list of the external container databases in the specified compartment. ' operationId: ListExternalContainerDatabases parameters: - $ref: '#/components/parameters/CompartmentId' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' - $ref: '#/components/parameters/ListExternalContainerDatabasesSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ListExternalContainerDatabasesFilterByLifecycleStateQueryParam' - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' responses: 200: description: The list of external container databases in the specified compartment. 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/ExternalContainerDatabaseSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListExternalContainerDatabases tags: - database x-example: "Example:\n GET /20160918/externalcontainerdatabases?compartmentId=<compartmentId>&limit=10\n Host: database.us-phoenix-1.oraclecloud.com\n <authorization and other headers>\n" x-related-resource: '#/definitions/ExternalContainerDatabase' post: description: Creates a new external container database resource. operationId: CreateExternalContainerDatabase parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: The request was successfully received and is in-progress. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ExternalContainerDatabase' 400: $ref: '#/components/responses/400' 404: $ref: '#/components/responses/404' 401: $ref: '#/components/responses/401' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateExternalContainerDatabase tags: - database x-example: "Example I:\n POST /20160918/externalcontainerdatabases\n Host: database.us-phoenix-1.oraclecloud.com\n <authorization and other headers>\n {\n \"compartmentId\" : \"ocid1.[tenancy|compartment].oc1.<unique_ID>\",\n \"displayName\": \"myTestExternalCdb\"\n }\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateExternalContainerDatabaseDetails' description: Request to create a new external container database resource. required: true /externalcontainerdatabases/{externalContainerDatabaseId}: delete: description: 'Deletes the [external container database](#/en/database/latest/datatypes/CreateExternalContainerDatabaseDetails) resource. Any external pluggable databases registered under this container database must be deleted in your Oracle Cloud Infrastructure tenancy prior to this operation. ' operationId: DeleteExternalContainerDatabase parameters: - $ref: '#/components/parameters/ExternalContainerDatabaseIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/IfMatchHeader' responses: 204: description: 'The request to delete the [external container database](#/en/database/latest/datatypes/CreateExternalContainerDatabaseDetails) resource was accepted. ' 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Delete the ExternalContainerDatabase tags: - database x-example: 'DELETE /20160918/externalcontainerdatabases/<externalContainerDatabaseId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/ExternalContainerDatabase' get: description: Gets information about the specified external container database. operationId: GetExternalContainerDatabase parameters: - $ref: '#/components/parameters/ExternalContainerDatabaseIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: The external container database. 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/ExternalContainerDatabase' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetExternalContainerDatabase tags: - database x-example: 'GET /20160918/externalcontainerdatabases/<externalContainerDatabaseId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' put: description: 'Updates the properties of an [ExternalContainerDatabase](#/en/database/latest/datatypes/CreateExternalContainerDatabaseDetails) resource, such as the display name. ' operationId: UpdateExternalContainerDatabase parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/ExternalContainerDatabaseIdPathParam' responses: 200: description: 'The request was successfully received and the [external container database](#/en/database/latest/datatypes/CreateExternalContainerDatabaseDetails) update is in-progress. ' 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ExternalContainerDatabase' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdateExternalContainerDatabase tags: - database x-example: "Example:\n PUT /20160918/externalcontainerdatabases/<externalContainerDatabaseId>\n Host: database.us-phoenix-1.oraclecloud.com\n <authorization and other headers>\n {\n \"displayName\": \"myTestDb2\"\n }\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateExternalContainerDatabaseDetails' description: 'Request to update the properties of an [external container database](#/en/database/latest/datatypes/CreateExternalContainerDatabaseDetails) resource. ' required: true /externalcontainerdatabases/{externalContainerDatabaseId}/actions/changeCompartment: post: description: 'Move the [external container database](#/en/database/latest/datatypes/CreateExternalContainerDatabaseDetails) and its dependent resources to the specified compartment. For more information about moving external container databases, see [Moving Database Resources to a Different Compartment](/Content/Database/Concepts/databaseoverview.htm#moveRes). ' operationId: ChangeExternalContainerDatabaseCompartment parameters: - $ref: '#/components/parameters/ExternalContainerDatabaseIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: The request was successfully received and the change compartment action is being performed. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ChangeExternalContainerDatabaseCompartment tags: - database x-example: "POST /20160918/externalcontainerdatabases/<externalContainerDatabaseId>/actions/changeCompartment\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\" : \"ocid.compartment.oc1..<unique_ID>\"\n}\n" x-related-resource: '#/definitions/ExternalContainerDatabase' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeCompartmentDetails' description: Request to move the external container database to a different compartment. required: true /externalcontainerdatabases/{externalContainerDatabaseId}/actions/disableDatabaseManagement: post: description: 'Disable Database Management service for the external container database. ' operationId: DisableExternalContainerDatabaseDatabaseManagement parameters: - $ref: '#/components/parameters/ExternalContainerDatabaseIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: The request was successfully received and Database Management Service is being disabled. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Disable Database Management Service for the external container database. tags: - database x-example: "POST /20160918/externalcontainerdatabases/<externalContainerDatabaseId>/actions\n /disableDatabaseManagement\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n" x-related-resource: '#/definitions/ExternalContainerDatabase' /externalcontainerdatabases/{externalContainerDatabaseId}/actions/disableStackMonitoring: post: description: 'Disable Stack Monitoring for the external container database. ' operationId: DisableExternalContainerDatabaseStackMonitoring parameters: - $ref: '#/components/parameters/ExternalContainerDatabaseIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: The request was successfully received and this External Container Database will disable Stack Monitoring. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Disable Stack Monitoring Service for the external container database. tags: - database x-example: "POST /20160918/externalcontainerdatabases/<externalContainerDatabaseId>/actions\n /disableStackMonitoring\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n" x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/ExternalContainerDatabase' /externalcontainerdatabases/{externalContainerDatabaseId}/actions/enableDatabaseManagement: post: description: 'Enables Database Management Service for the external container database. For more information about the Database Management Service, see [Database Management Service](/Content/ExternalDatabase/Concepts/databasemanagementservice.htm). ' operationId: EnableExternalContainerDatabaseDatabaseManagement parameters: - $ref: '#/components/parameters/ExternalContainerDatabaseIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: The request was successfully received and Database Management Service is being enabled. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Enable Database Management Service for the external container database. tags: - database x-example: "POST /20160918/externalcontainerdatabases/<externalContainerDatabaseId>/actions\n /enableDatabaseManagement\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"externalDatabaseConnectorId\": \"ocid1.externaldatabaseconnector..unique_ID\",\n \"licenseModel\": \"BRING_YOUR_OWN_LICENSE\"\n}\n" x-related-resource: '#/definitions/ExternalContainerDatabase' requestBody: content: application/json: schema: $ref: '#/components/schemas/EnableExternalContainerDatabaseDatabaseManagementDetails' description: Request to enable the Database Management Service for an external container database. required: true /externalcontainerdatabases/{externalContainerDatabaseId}/actions/enableStackMonitoring: post: description: 'Enable Stack Monitoring for the external container database. ' operationId: EnableExternalContainerDatabaseStackMonitoring parameters: - $ref: '#/components/parameters/ExternalContainerDatabaseIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: The request was successfully received and this External Container Database will enable Stack Monitoring. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Enable Stack Monitoring Service for the external container database. tags: - database x-example: "POST /20160918/externalcontainerdatabases/<externalContainerDatabaseId>/actions\n /enableStackMonitoring\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"externalDatabaseConnectorId\": \"ocid1.externaldatabaseconnector..unique_ID\"\n}\n" x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/ExternalContainerDatabase' requestBody: content: application/json: schema: $ref: '#/components/schemas/EnableExternalContainerDatabaseStackMonitoringDetails' description: 'Details to enable Stack Monitoring on the external container database. ' required: true /externalcontainerdatabases/{externalContainerDatabaseId}/actions/scanPluggableDatabases: post: description: 'Scans for pluggable databases in the specified external container database. This operation will return un-registered pluggable databases in the [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) operation. ' operationId: ScanExternalContainerDatabasePluggableDatabases parameters: - $ref: '#/components/parameters/ExternalContainerDatabaseIdPathParam' - $ref: '#/components/parameters/ExternalDatabaseConnectorIdQueryParam' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: 'The request was successfully received and the scan pluggable databases action is being performed. ' 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application-json: example: "Example GetWorkRequest response:\n{\n \"operationType\": \"SCAN_EXTERNAL_CONTAINER_DATABASE_PLUGGABLE_DATABASES\",\n \"status\": \"SUCCEEDED\",\n \"id\": \"\",\n \"compartmentId\": \"\"\n \"resources\" : [\n {\n \"actionType\": \"RELATED\",\n \"entityType\": \"externalpluggabledatabases\",\n \"identifier\": \"{'cdb':'','pdb':'Name1_PDB'}\",\n \"metadata\": {\n \"pdbUniqueName\": \"Name1_PDB\"\n }\n },\n {\n \"actionType\": \"RELATED\",\n \"entityType\": \"externalpluggabledatabases\",\n \"identifier\": \"{'cdb':'','pdb':'Name2_PDB'}\",\n \"metadata\": {\n \"pdbUniqueName\": \"Name2_PDB\"\n }\n },\n {\n \"actionType\": \"RELATED\",\n \"entityType\": \"externalpluggabledatabases\",\n \"identifier\": \"{'cdb':'','pdb':'Name3_PDB'}\",\n \"metadata\": {\n \"pdbUniqueName\": \"Name3_PDB\"\n }\n }\n ],\n \"percentComplete\": 100,\n \"timeAccepted\": \"2016-11-23T01:59:07.032Z\",\n \"timeStarted\": \"2016-11-23T02:00:00.000Z\",\n \"timeFinished\": \"2016-11-23T02:05:00.000Z\"\n}\n" 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Scan for un-registered pluggable databases in this external container database. tags: - database x-examples: 'POST /20160918/externalcontainerdatabases/<externalContainerDatabaseId>/actions/scanPluggableDatabases ?externalDatabaseConnectorId=<externalDatabaseConnectorId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/ExternalContainerDatabase' /externaldatabaseconnectors: get: description: 'Gets a list of the external database connectors in the specified compartment. ' operationId: ListExternalDatabaseConnectors parameters: - $ref: '#/components/parameters/CompartmentId' - $ref: '#/components/parameters/ListExternalDatabaseConnectorsExternalDatabaseIdQueryParam' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' - $ref: '#/components/parameters/ListExternalDatabaseConnectorsSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ListExternalDatabaseConnectorsFilterByLifecycleStateQueryParam' - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' responses: 200: description: All the external database connectors. 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/ExternalDatabaseConnectorSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListExternalDatabaseConnectors tags: - database x-example: "Example:\n GET /20160918/externaldatabaseconnectors?compartmentId=<compartmentId>&limit=10\n Host: database.us-phoenix-1.oraclecloud.com\n <authorization and other headers>\n" x-related-resource: '#/definitions/ExternalDatabaseConnector' post: description: Creates a new external database connector. operationId: CreateExternalDatabaseConnector parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: The request was successfully received and is in-progress. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ExternalDatabaseConnector' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Creates an ExternalDatabaseConnector tags: - database x-example: "Example:\n POST /20160918/externaldatabaseconnectors\n Host: database.us-phoenix-1.oraclecloud.com\n <authorization and other headers>\n {\n \"displayName\": \"myTestConn\",\n \"connectionString\": {\n \"hostname\": \"myHost.test\",\n \"port\": 1521,\n \"service\": \"testService\",\n \"protocol\": \"TCP\"\n },\n \"connectionCredentials\": {\n \"username\": \"testUser\",\n \"password\": \"greatPassword\",\n \"role\": \"SYSDBA\"\n },\n \"connectorType\": \"MACS\",\n \"connectorAgentId\": \"ocid\",\n \"externalDatabaseId\": \"ocid\"\n }\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateExternalDatabaseConnectorDetails' description: Request to create a connector to an external database. required: true /externaldatabaseconnectors/{externalDatabaseConnectorId}: delete: description: 'Deletes an external database connector. Any services enabled using the external database connector must be deleted prior to this operation. ' operationId: DeleteExternalDatabaseConnector parameters: - $ref: '#/components/parameters/ExternalDatabaseConnectorIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OptionalRequestId' responses: 204: description: The request to delete the ExternalDatabaseConnector was accepted. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: DeleteExternalDatabaseConnector tags: - database x-example: 'DELETE /20160918/externaldatabaseconnectors/<externalDatabaseConnectorId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/ExternalDatabaseConnector' get: description: Gets information about the specified external database connector. operationId: GetExternalDatabaseConnector parameters: - $ref: '#/components/parameters/ExternalDatabaseConnectorIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: The ExternalDatabaseConnector object. 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/ExternalDatabaseConnector' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetExternalDatabaseConnector tags: - database x-example: 'GET /20160918/externaldatabaseconnectors/<externalDatabaseConnectorId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' put: description: Updates the properties of an external database connector, such as the display name. operationId: UpdateExternalDatabaseConnector parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/ExternalDatabaseConnectorIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: The request was successfully received and the external database connector update is in-progress. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ExternalDatabaseConnector' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdateExternalDatabaseConnector tags: - database x-example: "Example:\n PUT /20160918/externaldatabaseconnectors/<externalDatabaseConnectorId>\n Host: database.us-phoenix-1.oraclecloud.com\n <authorization and other headers>\n {\n \"connectionCredentials\": {\n \"username\": \"testUser\",\n \"password\": \"greatPassword2\",\n \"role\": \"SYSDBA\"\n }\n }\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateExternalDatabaseConnectorDetails' description: Request to update the properties of an external database connector. required: true /externaldatabaseconnectors/{externalDatabaseConnectorId}/actions/checkConnectionStatus: post: description: 'Check the status of the external database connection specified in this connector. This operation will refresh the connectionStatus and timeConnectionStatusLastUpdated fields. ' operationId: CheckExternalDatabaseConnectorConnectionStatus parameters: - $ref: '#/components/parameters/ExternalDatabaseConnectorIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: The request was successfully received and the status of the external database connection is being checked. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Check the status of the external database connection specified in this connector. tags: - database x-example: 'POST /20160918/externaldatabaseconnectors/<externalDatabaseConnectorId>/actions/checkConnectionStatus Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/ExternalDatabaseConnector' /externalnoncontainerdatabases: get: description: 'Gets a list of the ExternalNonContainerDatabases in the specified compartment. ' operationId: ListExternalNonContainerDatabases parameters: - $ref: '#/components/parameters/CompartmentId' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' - $ref: '#/components/parameters/ListExternalNonContainerDatabasesSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ListExternalNonContainerDatabasesFilterByLifecycleStateQueryParam' - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' responses: 200: description: The list of external non-container databases in the specified compartment. 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/ExternalNonContainerDatabaseSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: List the ExternalNonContainerDatabases in the compartment. tags: - database x-example: "Example:\n GET /20160918/externalnoncontainerdatabases?compartmentId=<compartmentId>&limit=10\n Host: database.us-phoenix-1.oraclecloud.com\n <authorization and other headers>\n" x-related-resource: '#/definitions/ExternalNonContainerDatabase' post: description: 'Creates a new ExternalNonContainerDatabase resource ' operationId: CreateExternalNonContainerDatabase parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: The request was successfully received and the database create is in-progress. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ExternalNonContainerDatabase' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateExternalNonContainerDatabase tags: - database x-example: "Example:\n POST /20160918/externalnoncontainerdatabases\n Host: database.us-phoenix-1.oraclecloud.com\n <authorization and other headers>\n {\n \"compartmentId\" : \"ocid1.[tenancy|compartment].oc1.<unique_ID>\",\n \"displayName\": \"myExternalNonCdb\"\n }\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateExternalNonContainerDatabaseDetails' description: Request to create a new external non-container database. required: true /externalnoncontainerdatabases/{externalNonContainerDatabaseId}: delete: description: 'Deletes the Oracle Cloud Infrastructure resource representing an external non-container database. ' operationId: DeleteExternalNonContainerDatabase parameters: - $ref: '#/components/parameters/ExternalNonContainerDatabaseIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OptionalRequestId' responses: 204: description: 'The request to delete the [ExternalNonContainerDatabase](#/en/database/latest/datatypes/CreateExternalNonContainerDatabaseDetails) resource was accepted. ' 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Delete the ExternalNonContainerDatabase tags: - database x-example: 'DELETE /20160918/externalnoncontainerdatabases/<externalNonConatinerDatabaseId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/ExternalNonContainerDatabase' get: description: Gets information about a specific external non-container database. operationId: GetExternalNonContainerDatabase parameters: - $ref: '#/components/parameters/ExternalNonContainerDatabaseIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: The external non-container database. 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/ExternalNonContainerDatabase' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetExternalNonContainerDatabase tags: - database x-example: 'GET /20160918/externalnoncontainerdatabases/<externalNonContainerDatabaseId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' put: description: Updates the properties of an external non-container database, such as the display name. operationId: UpdateExternalNonContainerDatabase parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/ExternalNonContainerDatabaseIdPathParam' responses: 200: description: 'The request was successfully received and the [ExternalNonContainerDatabase](#/en/database/latest/datatypes/CreateExternalNonContainerDatabaseDetails) update is in-progress. ' 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ExternalNonContainerDatabase' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdateExternalNonContainerDatabase tags: - database x-example: "Example:\n PUT /20160918/externalnoncontainerdatabases/<externalNonContainerDatabaseId>\n Host: database.us-phoenix-1.oraclecloud.com\n <authorization and other headers>\n {\n \"displayName\": \"myOPNonCdb\"\n }\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateExternalNonContainerDatabaseDetails' description: Request to update the properties of an external non-container database. required: true /externalnoncontainerdatabases/{externalNonContainerDatabaseId}/actions/changeCompartment: post: description: 'Move the external non-container database and its dependent resources to the specified compartment. For more information about moving external non-container databases, see [Moving Database Resources to a Different Compartment](/Content/Database/Concepts/databaseoverview.htm#moveRes). ' operationId: ChangeExternalNonContainerDatabaseCompartment parameters: - $ref: '#/components/parameters/ExternalNonContainerDatabaseIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: The request was successfully received and the change compartment action is being performed. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ChangeExternalNonContainerDatabaseCompartment tags: - database x-example: "POST /20160918/externalnoncontainerdatabases/<externalNonConatinerDatabaseId>/actions/changeCompartment\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\" : \"ocid.compartment.oc1..<unique_ID>\"\n}\n" x-related-resource: '#/definitions/ExternalNonContainerDatabase' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeCompartmentDetails' description: Request to move the external non-container database to a different compartment. required: true /externalnoncontainerdatabases/{externalNonContainerDatabaseId}/actions/disableDatabaseManagement: post: description: 'Disable Database Management Service for the external non-container database. For more information about the Database Management Service, see [Database Management Service](/Content/ExternalDatabase/Concepts/databasemanagementservice.htm). ' operationId: DisableExternalNonContainerDatabaseDatabaseManagement parameters: - $ref: '#/components/parameters/ExternalNonContainerDatabaseIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: The request was successfully received and Database Management Service is being disabled. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Disable Database Management Service for the external container database. tags: - database x-example: "POST /20160918/externalnoncontainerdatabases/<externalNonContainerDatabaseId>/actions\n /disableDatabaseManagement\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n" x-related-resource: '#/definitions/ExternalNonContainerDatabase' /externalnoncontainerdatabases/{externalNonContainerDatabaseId}/actions/disableOperationsInsights: post: description: 'Disable Operations Insights for the external non-container database. ' operationId: DisableExternalNonContainerDatabaseOperationsInsights parameters: - $ref: '#/components/parameters/ExternalNonContainerDatabaseIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: The request was successfully received and this External Non-container Database will disable Operations Insights. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Disable Operations Insights Service for the external non-container database. tags: - database x-example: "POST /20160918/externalnoncontainerdatabases/<externalNonContainerDatabaseId>/actions\n /disableOperationsInsights\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n" x-related-resource: '#/definitions/ExternalNonContainerDatabase' /externalnoncontainerdatabases/{externalNonContainerDatabaseId}/actions/disableStackMonitoring: post: description: 'Disable Stack Monitoring for the external non-container database. ' operationId: DisableExternalNonContainerDatabaseStackMonitoring parameters: - $ref: '#/components/parameters/ExternalNonContainerDatabaseIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: The request was successfully received and this External Non-container Database will disable Stack Monitoring. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Disable Stack Monitoring Service for the external non-container database. tags: - database x-example: "POST /20160918/externalnoncontainerdatabases/<externalNonContainerDatabaseId>/actions\n /disableStackMonitoring\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n" x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/ExternalNonContainerDatabase' /externalnoncontainerdatabases/{externalNonContainerDatabaseId}/actions/enableDatabaseManagement: post: description: 'Enable Database Management Service for the external non-container database. For more information about the Database Management Service, see [Database Management Service](/Content/ExternalDatabase/Concepts/databasemanagementservice.htm). ' operationId: EnableExternalNonContainerDatabaseDatabaseManagement parameters: - $ref: '#/components/parameters/ExternalNonContainerDatabaseIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: The request was successfully received and Database Management Service is being enabled. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Enable Database Management Service for the external container database. tags: - database x-example: "POST /20160918/externalnoncontainerdatabases/<externalNonContainerDatabaseId>/actions\n /enableDatabaseManagement\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"externalDatabaseConnectorId\": \"ocid1.externaldatabaseconnector..unique_ID\",\n \"licenseModel\": \"BRING_YOUR_OWN_LICENSE\"\n}\n" x-related-resource: '#/definitions/ExternalNonContainerDatabase' requestBody: content: application/json: schema: $ref: '#/components/schemas/EnableExternalNonContainerDatabaseDatabaseManagementDetails' description: Request to enable the Database Management Service for an external non-container database. required: true /externalnoncontainerdatabases/{externalNonContainerDatabaseId}/actions/enableOperationsInsights: post: description: 'Enable Operations Insights for the external non-container database. ' operationId: EnableExternalNonContainerDatabaseOperationsInsights parameters: - $ref: '#/components/parameters/ExternalNonContainerDatabaseIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: The request was successfully received and this External Non-container Database will enable Operations Insights. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Enable Operations Insights Service for the external non-container database. tags: - database x-example: "POST /20160918/externalnoncontainerdatabases/<externalNonContainerDatabaseId>/actions\n /enableOperationsInsights\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"externalDatabaseConnectorId\": \"ocid1.externaldatabaseconnector..unique_ID\"\n}\n" x-related-resource: '#/definitions/ExternalNonContainerDatabase' requestBody: content: application/json: schema: $ref: '#/components/schemas/EnableExternalNonContainerDatabaseOperationsInsightsDetails' description: 'Details to enable Operations Insights on the external non-container database ' required: true /externalnoncontainerdatabases/{externalNonContainerDatabaseId}/actions/enableStackMonitoring: post: description: 'Enable Stack Monitoring for the external non-container database. ' operationId: EnableExternalNonContainerDatabaseStackMonitoring parameters: - $ref: '#/components/parameters/ExternalNonContainerDatabaseIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: The request was successfully received and this External Non-container Database will enable Stack Monitoring. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Enable Stack Monitoring Service for the external non-container database. tags: - database x-example: "POST /20160918/externalnoncontainerdatabases/<externalNonContainerDatabaseId>/actions\n /enableStackMonitoring\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"externalDatabaseConnectorId\": \"ocid1.externaldatabaseconnector..unique_ID\"\n}\n" x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/ExternalNonContainerDatabase' requestBody: content: application/json: schema: $ref: '#/components/schemas/EnableExternalNonContainerDatabaseStackMonitoringDetails' description: 'Details to enable Stack Monitoring on the external non-container database. ' required: true /externalpluggabledatabases: get: description: 'Gets a list of the [ExternalPluggableDatabase](#/en/database/latest/datatypes/CreateExternalPluggableDatabaseDetails) resources in the specified compartment. ' operationId: ListExternalPluggableDatabases parameters: - $ref: '#/components/parameters/CompartmentId' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/ExternalContainerDatabaseIdQueryParam' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' - $ref: '#/components/parameters/ListExternalPluggableDatabasesSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ListExternalPluggableDatabasesFilterByLifecycleStateQueryParam' - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' responses: 200: description: 'The list of [ExternalPluggableDatabase](#/en/database/latest/datatypes/CreateExternalPluggableDatabaseDetails) resources in the specified compartment. ' 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/ExternalPluggableDatabaseSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: List ExternalPluggableDatabases in the specified compartment. tags: - database x-example: "Example:\n GET /20160918/externalpluggabledatabases?compartmentId=<compartmentId>&limit=10\n Host: database.us-phoenix-1.oraclecloud.com\n <authorization and other headers>\n" x-related-resource: '#/definitions/ExternalPluggableDatabase' post: description: 'Registers a new [ExternalPluggableDatabase](#/en/database/latest/datatypes/CreateExternalPluggableDatabaseDetails) resource. ' operationId: CreateExternalPluggableDatabase parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: 'The request was successfully received and the ExternalPluggableDatabase create operation is in-progress. ' 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ExternalPluggableDatabase' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Creates an ExternalPluggableDatabase tags: - database x-example: "POST /20160918/externalpluggabledatabases\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\" : \"ocid1.[tenancy|compartment].oc1.<unique_ID>\",\n \"displayName\": \"myTestExternalCdb\",\n \"externalContainerDatabaseId\": \"ocid1.externalcontainerdatabase.oc1.\"\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateExternalPluggableDatabaseDetails' description: Request to create a new external pluggable database. required: true /externalpluggabledatabases/{externalPluggableDatabaseId}: delete: description: 'Deletes the [external pluggable database](#/en/database/latest/datatypes/CreateExternalPluggableDatabaseDetails). resource. ' operationId: DeleteExternalPluggableDatabase parameters: - $ref: '#/components/parameters/ExternalPluggableDatabaseIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/IfMatchHeader' responses: 204: description: 'The request to delete the [ExternalPluggableDatabase](#/en/database/latest/datatypes/CreateExternalPluggableDatabaseDetails) resource was accepted. ' 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Deletes an ExternalPluggableDatabase tags: - database x-example: 'DELETE /20160918/externalpluggabledatabases/<externalPluggableDatabaseId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/ExternalPluggableDatabase' get: description: 'Gets information about a specific [external pluggable database](#/en/database/latest/datatypes/CreateExternalPluggableDatabaseDetails) resource. ' operationId: GetExternalPluggableDatabase parameters: - $ref: '#/components/parameters/ExternalPluggableDatabaseIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: 'The [external pluggable database](#/en/database/latest/datatypes/CreateExternalPluggableDatabaseDetails). resource. ' 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/ExternalPluggableDatabase' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetExternalPluggableDatabase tags: - database x-example: 'GET /20160918/externalpluggabledatabases/<externalPluggableDatabaseId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' put: description: 'Updates the properties of an [external pluggable database](#/en/database/latest/datatypes/CreateExternalPluggableDatabaseDetails) resource, such as the display name. ' operationId: UpdateExternalPluggableDatabase parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/ExternalPluggableDatabaseIdPathParam' responses: 200: description: 'The request was successfully received and the [ExternalPluggableDatabase](#/en/database/latest/datatypes/CreateExternalPluggableDatabaseDetails) update is in-progress. ' 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ExternalPluggableDatabase' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdateExternalPluggableDatabase tags: - database x-example: "Example:\n PUT /20160918/externalpluggabledatabases/<externalPluggableDatabaseId>\n Host: database.us-phoenix-1.oraclecloud.com\n <authorization and other headers>\n {\n \"displayName\": \"myExternalPdb\"\n }\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateExternalPluggableDatabaseDetails' description: Request to update the properties of an external pluggable database resource. required: true /externalpluggabledatabases/{externalPluggableDatabaseId}/actions/changeCompartment: post: description: 'Move the [external pluggable database](#/en/database/latest/datatypes/CreateExternalPluggableDatabaseDetails) and its dependent resources to the specified compartment. For more information about moving external pluggable databases, see [Moving Database Resources to a Different Compartment](/Content/Database/Concepts/databaseoverview.htm#moveRes). ' operationId: ChangeExternalPluggableDatabaseCompartment parameters: - $ref: '#/components/parameters/ExternalPluggableDatabaseIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: The request was successfully received and the change compartment action is being performed. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ChangeExternalPluggableDatabaseCompartment tags: - database x-example: "POST /20160918/externalpluggabledatabases/<externalPluggableDatabaseId>/actions/changeCompartment\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\" : \"ocid.compartment.oc1..<unique_ID>\"\n}\n" x-related-resource: '#/definitions/ExternalPluggableDatabase' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeCompartmentDetails' description: 'Request to move the [ExternalPluggableDatabase](#/en/database/latest/datatypes/CreateExternalPluggableDatabaseDetails) resource to a different compartment. ' required: true /externalpluggabledatabases/{externalPluggableDatabaseId}/actions/disableDatabaseManagement: post: description: 'Disable Database Management Service for the external pluggable database. For more information about the Database Management Service, see [Database Management Service](/Content/ExternalDatabase/Concepts/databasemanagementservice.htm). ' operationId: DisableExternalPluggableDatabaseDatabaseManagement parameters: - $ref: '#/components/parameters/ExternalPluggableDatabaseIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: The request was successfully received and Database Management Service is being disabled. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Disable Database Management Service for the external pluggable database. tags: - database x-example: "POST /20160918/externalpluggabledatabases/<externalPluggableDatabaseId>/actions\n /disableDatabaseManagement\nHost: database.us-phoenix-1.oraclecloud.com\n" x-related-resource: '#/definitions/ExternalPluggableDatabase' /externalpluggabledatabases/{externalPluggableDatabaseId}/actions/disableOperationsInsights: post: description: 'Disable Operations Insights for the external pluggable database. ' operationId: DisableExternalPluggableDatabaseOperationsInsights parameters: - $ref: '#/components/parameters/ExternalPluggableDatabaseIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: The request was successfully received and this External Pluggable Database will disable Operations Insights. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Disable Operations Insights Service for the external pluggable database. tags: - database x-example: "POST /20160918/externalpluggabledatabases/<externalPluggableDatabaseId>/actions\n /disableOperationsInsights\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n" x-related-resource: '#/definitions/ExternalPluggableDatabase' /externalpluggabledatabases/{externalPluggableDatabaseId}/actions/disableStackMonitoring: post: description: 'Disable Stack Monitoring for the external pluggable database. ' operationId: DisableExternalPluggableDatabaseStackMonitoring parameters: - $ref: '#/components/parameters/ExternalPluggableDatabaseIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: The request was successfully received and this External Pluggable Database will disable Stack Monitoring. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Disable Stack Monitoring Service for the external pluggable database. tags: - database x-example: "POST /20160918/externalpluggabledatabases/<externalPluggableDatabaseId>/actions\n /disableStackMonitoring\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n" x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/ExternalPluggableDatabase' /externalpluggabledatabases/{externalPluggableDatabaseId}/actions/enableDatabaseManagement: post: description: 'Enable Database Management Service for the external pluggable database. For more information about the Database Management Service, see [Database Management Service](/Content/ExternalDatabase/Concepts/databasemanagementservice.htm). ' operationId: EnableExternalPluggableDatabaseDatabaseManagement parameters: - $ref: '#/components/parameters/ExternalPluggableDatabaseIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: The request was successfully received and Database Management Service is being enabled. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Enable Database Management Service for the external pluggable database. tags: - database x-example: "POST /20160918/externalpluggabledatabases/<externalPluggableDatabaseId>/actions\n /enableDatabaseManagement\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"externalDatabaseConnectorId\": \"ocid1.externaldatabaseconnector..unique_ID\"\n}\n" x-related-resource: '#/definitions/ExternalPluggableDatabase' requestBody: content: application/json: schema: $ref: '#/components/schemas/EnableExternalPluggableDatabaseDatabaseManagementDetails' description: Request to enable the Database Management Service for an external database. required: true /externalpluggabledatabases/{externalPluggableDatabaseId}/actions/enableOperationsInsights: post: description: 'Enable Operations Insights for the external pluggable database. ' operationId: EnableExternalPluggableDatabaseOperationsInsights parameters: - $ref: '#/components/parameters/ExternalPluggableDatabaseIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: The request was successfully received and this External Pluggable Database will enable Operations Insights. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Enable Operations Insights Service for the external pluggable database. tags: - database x-example: "POST /20160918/externalpluggabledatabases/<externalPluggableDatabaseId>/actions\n /enableOperationsInsights\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"externalDatabaseConnectorId\": \"ocid1.externaldatabaseconnector..unique_ID\"\n}\n" x-related-resource: '#/definitions/ExternalPluggableDatabase' requestBody: content: application/json: schema: $ref: '#/components/schemas/EnableExternalPluggableDatabaseOperationsInsightsDetails' description: 'Details to enable Operations Insights on the external pluggable database ' required: true /externalpluggabledatabases/{externalPluggableDatabaseId}/actions/enableStackMonitoring: post: description: 'Enable Stack Monitoring for the external pluggable database. ' operationId: EnableExternalPluggableDatabaseStackMonitoring parameters: - $ref: '#/components/parameters/ExternalPluggableDatabaseIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: The request was successfully received and this External Pluggable Database will enable Stack Monitoring. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Enable Stack Monitoring Service for the external pluggable database. tags: - database x-example: "POST /20160918/externalpluggabledatabases/<externalPluggableDatabaseId>/actions\n /enableStackMonitoring\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"externalDatabaseConnectorId\": \"ocid1.externaldatabaseconnector..unique_ID\"\n}\n" x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/ExternalPluggableDatabase' requestBody: content: application/json: schema: $ref: '#/components/schemas/EnableExternalPluggableDatabaseStackMonitoringDetails' description: 'Details to enable Stack Monitoring on the external pluggable database. ' required: true /giVersions: get: description: Gets a list of supported GI versions. operationId: ListGiVersions parameters: - $ref: '#/components/parameters/CompartmentId' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/OptionalShapeQueryParam' - $ref: '#/components/parameters/ExadbxsAvailabilityDomainParam' - $ref: '#/components/parameters/OptionalResourceIdQueryParam' - $ref: '#/components/parameters/ShapeAttributeQueryParam' responses: 200: description: The list of supported Grid Infrastructure versions. 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/GiVersionSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListGiVersions tags: - database x-example: 'GET /20160918/giVersions?compartmentId=<compartmentId>&limit=100 Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-obmcs-authz-declarations: authorizationRequired: false /giVersions/{version}/minorVersions: get: description: Gets a list of supported Oracle Grid Infrastructure minor versions for the given major version and shape family. operationId: ListGiVersionMinorVersions parameters: - $ref: '#/components/parameters/GiMajorVersionPathParam' - $ref: '#/components/parameters/ExadbxsAvailabilityDomainParam' - $ref: '#/components/parameters/OptionalCompartmentIdQueryParam' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/OptionalShapeFamilyQueryParam' - $ref: '#/components/parameters/IsGiVersionForProvisioningQueryParam' - $ref: '#/components/parameters/OptionalShapeQueryParam' - $ref: '#/components/parameters/ListGiMinorVersionsSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' responses: 200: description: Gets a list of supported Oracle Grid Infrastructure minor versions for the given major version and shape family. 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/GiMinorVersionSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListGiMinorVersions tags: - database x-example: 'GET /20160918/giVersions/<version>/minorVersions?shapeFamily=EXADATA Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/GiMinorVersionSummary' /keyStores: get: description: 'Gets a list of key stores in the specified compartment. ' operationId: ListKeyStores parameters: - $ref: '#/components/parameters/CompartmentId' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: 'List of key stores. ' 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/KeyStoreSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListKeyStores tags: - database x-example: 'GET /20160918/keyStores?compartmentId=<compartmentId>&limit=10 Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/KeyStoreSummary' post: description: 'Creates a Key Store. ' operationId: CreateKeyStore parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: 'The request was successfully received and the key store is created. ' 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/KeyStore' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateKeyStore tags: - database x-example: "POST /20160918/keyStores\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\":\"Key Store1\",\n \"compartmentId\":\"ocid1.tenancy.oc1.<unique_ID>\",\n \"typeDetails\": {\n \"type\":\"ORACLE_KEY_VAULT\",\n \"connectionIps\":[\n \"198.12.34.56\",\n \"198.12.34.57\"\n ],\n \"adminUsername\":\"username1\",\n \"vaultId\":\"ocid1.vault.oc1.<unique_ID>\",\n \"secretId\":\"ocid1.key.oc1.<unique_ID>\"\n }\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateKeyStoreDetails' description: 'Request to create a new key store. ' required: true /keyStores/{keyStoreId}: delete: description: 'Deletes a key store. ' operationId: DeleteKeyStore parameters: - $ref: '#/components/parameters/KeyStoreIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OptionalRequestId' responses: 204: description: 'The key store has been deleted. ' 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 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: DeleteKeyStore tags: - database x-example: 'DELETE /20160918/keyStores/<keyStoreId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/KeyStore' get: description: 'Gets information about the specified key store. ' operationId: GetKeyStore parameters: - $ref: '#/components/parameters/KeyStoreIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: 'The key store. ' 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/KeyStore' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetKeyStore tags: - database x-example: 'GET /20160918/keyStores/<keyStoreId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' put: description: 'Edit the key store. ' operationId: UpdateKeyStore parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/KeyStoreIdPathParam' responses: 200: description: 'The update was successful. ' 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/KeyStore' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Updates the specified key store. tags: - database requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateKeyStoreDetails' description: 'Request to update the attributes of a key store. ' required: true /keyStores/{keyStoreId}/actions/changeCompartment: post: description: 'Move the key store resource to the specified compartment. For more information about moving key stores, see [Moving Database Resources to a Different Compartment](/Content/Database/Concepts/databaseoverview.htm#moveRes). ' operationId: ChangeKeyStoreCompartment parameters: - $ref: '#/components/parameters/KeyStoreIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: 'The request was successfully received and the change compartment action is being performed. ' 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ChangeKeyStoreCompartment tags: - database x-example: "POST /20160918/keyStores/<keyStoreId>/actions/changeKeyStoreCompartment\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\" : \"ocid.compartment.oc1..<unique_ID>\"\n}\n" x-related-resource: '#/definitions/KeyStore' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeKeyStoreCompartmentDetails' description: 'Request to move key store to a different compartment ' required: true /maintenanceRunHistory: get: description: 'Gets a list of the maintenance run histories in the specified compartment. ' operationId: ListMaintenanceRunHistory parameters: - $ref: '#/components/parameters/CompartmentId' - $ref: '#/components/parameters/optionalTargetResourceIdQueryParam' - $ref: '#/components/parameters/optionalTargetResourceTypeQueryParam' - $ref: '#/components/parameters/optionalMaintenanceTypeQueryParam' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' - $ref: '#/components/parameters/listMaintenanceRunsSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/listMaintenanceRunHistoryFilterByStateQueryParam' - $ref: '#/components/parameters/FilterByAvailabilityDomainQueryParam' - $ref: '#/components/parameters/OptionalMaintenanceSubtypeQueryParam' responses: 200: description: The list of maintenance run histories. 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/MaintenanceRunHistorySummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: List maintenance run histories. tags: - database x-example: 'GET /20160918/maintenanceRunHistory?compartmentId=<compartmentId>&limit=10 Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/MaintenanceRunHistory' /maintenanceRunHistory/{maintenanceRunHistoryId}: get: description: Gets information about the specified maintenance run history. operationId: GetMaintenanceRunHistory parameters: - $ref: '#/components/parameters/maintenanceRunHistoryIdPathParam' responses: 200: description: Information about the specified maintenance run history. 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/MaintenanceRunHistory' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets maintenance run history. tags: - database x-example: 'GET /20160918/maintenanceRunHistory/<maintenanceRunHistoryId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' /maintenanceRuns: get: description: 'Gets a list of the maintenance runs in the specified compartment. ' operationId: ListMaintenanceRuns parameters: - $ref: '#/components/parameters/CompartmentId' - $ref: '#/components/parameters/optionalTargetResourceIdQueryParam' - $ref: '#/components/parameters/optionalTargetResourceTypeQueryParam' - $ref: '#/components/parameters/optionalMaintenanceTypeQueryParam' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' - $ref: '#/components/parameters/listMaintenanceRunsFilterByLocalAdgQueryParam' - $ref: '#/components/parameters/listMaintenanceRunsSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/listMaintenanceRunsFilterByLifecycleStateQueryParam' - $ref: '#/components/parameters/FilterByAvailabilityDomainQueryParam' - $ref: '#/components/parameters/OptionalMaintenanceSubtypeQueryParam' responses: 200: description: The list of maintenance runs. 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/MaintenanceRunSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListMaintenanceRuns tags: - database x-example: 'GET /20160918/maintenanceRuns?compartmentId=<compartmentId>&limit=10 Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/MaintenanceRun' post: description: 'Creates a maintenance run with one of the following: 1. The latest available release update patch (RUP) for the Autonomous Container Database. 2. The latest available RUP and DST time-zone (TZ) file updates for the Autonomous Container Database. 3. The DST TZ file updates for the Autonomous Container Database. ' operationId: CreateMaintenanceRun parameters: - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The request was successfully received and the Maintenance Run for the requested resource is created. 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/MaintenanceRun' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateMaintenanceRun tags: - database requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateMaintenanceRunDetails' description: Request to create a Maintenance Run for the resource. required: true /maintenanceRuns/{maintenanceRunId}: get: description: Gets information about the specified maintenance run. operationId: GetMaintenanceRun parameters: - $ref: '#/components/parameters/maintenanceRunIdPathParam' responses: 200: description: Information about the specified maintenance run. 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/MaintenanceRun' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetMaintenanceRun tags: - database x-example: 'GET /20160918/maintenanceRuns/<maintenanceRunId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' put: description: Updates the properties of a maintenance run, such as the state of a maintenance run. operationId: UpdateMaintenanceRun parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/maintenanceRunIdPathParam' responses: 200: description: The request was successfully received and the maintenance run is 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/MaintenanceRun' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdateMaintenanceRun tags: - database x-example: "PUT /latest/maintenanceRuns/<maintenanceRunId>\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"isEnabled\" : false\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateMaintenanceRunDetails' description: Request to update the properties of a maintenance run. required: true /oneoffPatches: get: description: 'Lists one-off patches in the specified compartment. ' operationId: ListOneoffPatches parameters: - $ref: '#/components/parameters/CompartmentId' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' - $ref: '#/components/parameters/ListOneoffPatchesSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ListOneoffPatchesFilterByLifecycleStateQueryParam' - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: All the one-off patches requested. 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/OneoffPatchSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Lists one-off patches in the specified compartment. tags: - database x-example: "Example I:\n GET /20160918/oneoffPatches?<compartmentId>&limit=10\n Host: database.us-phoenix-1.oraclecloud.com\n <authorization and other headers>\n" x-related-resource: '#/definitions/OneoffPatch' post: description: 'Creates one-off patch for specified database version to download. ' operationId: CreateOneoffPatch parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: The request was successfully received and one-off patch creation is initiated. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/OneoffPatch' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Create one-off patch tags: - database x-example: "Example I:\n POST /20160918/oneoffPatches\n Host: database.us-phoenix-1.oraclecloud.com\n <authorization and other headers>\n {\n \"compartmentId\" : \"ocid1.tenancy.oc1..<unique_ID>\",\n \"dbVersion\" : \"19.0.0.0\",\n \"displayName\" : \"19.15_RU\",\n \"releaseUpdate\" : \"19.15.0.0\",\n \"oneOffPatches\": \"123456\"\n }\n" x-related-resource: '#/definitions/OneoffPatch' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateOneoffPatchDetails' description: 'Request to create a one-off patch to download. ' required: true /oneoffPatches/{oneoffPatchId}: delete: description: 'Deletes a one-off patch. ' operationId: DeleteOneoffPatch parameters: - $ref: '#/components/parameters/OneoffPatchIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/IfMatchHeader' responses: 204: description: The request to delete the one-off patch was accepted. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Delete one-off patch tags: - database x-example: 'DELETE /20160918/oneoffPatches/<oneoffPatchId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/OneoffPatch' get: description: 'Gets information about the specified one-off patch. ' operationId: GetOneoffPatch parameters: - $ref: '#/components/parameters/OneoffPatchIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: One-off patch information was retrieved. 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/OneoffPatch' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Get one-off patch tags: - database x-example: 'GET /20160918/oneoffPatches/<oneoffPatchId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' put: description: 'Updates the properties of the specified one-off patch. ' operationId: UpdateOneoffPatch parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/OneoffPatchIdPathParam' responses: 200: description: The request was successfully received and the one-off patch update is in progress. 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/OneoffPatch' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Updates the properties of the specified one-off patch. tags: - database x-example: "Example I:\n PUT /20160918/oneoffPatches/<oneoffPatchId>\n Host: database.us-phoenix-1.oraclecloud.com\n <authorization and other headers>\n {\n \"freeformTags\" : {\"Department\": \"Management\"}\n }\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateOneoffPatchDetails' description: Request to update the properties of a one-off patch. required: true /oneoffPatches/{oneoffPatchId}/actions/changeCompartment: post: description: 'Move the one-off patch to the specified compartment. ' operationId: ChangeOneoffPatchCompartment parameters: - $ref: '#/components/parameters/OneoffPatchIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: The request was successfully received and the change compartment action is being performed. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Change one-off patch compartment tags: - database x-example: "POST /20160918/oneoffPatches/<oneoffPatchId>/actions/changeCompartment\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\" : \"ocid.compartment.oc1..<unique_ID>\"\n}\n" x-obmcs-terraform: actionType: UPDATE_FIELD x-related-resource: '#/definitions/OneoffPatch' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeCompartmentDetails' description: Request to move one-off patch to a different compartment required: true /oneoffPatches/{oneoffPatchId}/actions/downloadOneoffPatch: post: description: 'Download one-off patch. ' operationId: DownloadOneoffPatch parameters: - $ref: '#/components/parameters/OneoffPatchIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: One-off patch is being retrieved. 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/DownloadOneoffPatch' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Download one-off patch. tags: - database x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/OneoffPatch' /pluggableDatabaseSnapshots: get: description: 'Gets a list of the Exadata Pluggable Database Snapshots in the specified compartment. ' operationId: ListPluggableDatabaseSnapshots parameters: - $ref: '#/components/parameters/OptionalCompartmentIdQueryParam' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' - $ref: '#/components/parameters/ListPluggableDatabaseSnapshotsSortByQueryParam' - $ref: '#/components/parameters/FilterByNameQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ListPluggableDatabaseSnapshotsFilterByLifecycleStateQueryParam' - $ref: '#/components/parameters/ListPluggableDatabaseSnapshotsFilterByClusterQueryParam' - $ref: '#/components/parameters/ListPluggableDatabaseSnapshotsFilterByDatabaseQueryParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: List of the Exadata Pluggable Database Snapshots 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/PluggableDatabaseSnapshotSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListPluggableDatabaseSnapshots tags: - database x-example: 'GET /20160918/pluggableDatabaseSnapshots?compartmentId=<compartmentId>&limit=10 Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/PluggableDatabaseSnapshot' post: description: 'Creates a Pluggable Database Snapshot ' operationId: CreatePluggableDatabaseSnapshot parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' responses: 201: description: The request was successfully received and the create pluggable database Snapshot. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/PluggableDatabaseSnapshot' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreatePluggableDatabaseSnapshot tags: - database x-example: "POST /20160918/pluggableDatabaseSnapshots\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"name\" : \"snapshot-1\",\n \"pluggableDatabaseId\": \"ocid1.pluggabledatabase.oc1.\"\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/CreatePluggableDatabaseSnapshotDetails' description: 'Request to create a pluggable database snapshot. ' required: true /pluggableDatabaseSnapshots/{pluggableDatabaseSnapshotId}: delete: description: 'Deletes the specified Exadata Pluggable Database Snapshot. ' operationId: DeletePluggableDatabaseSnapshot parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/PluggableDatabaseSnapshotIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 204: description: The request to delete the Exadata Pluggable Database Snapshot was accepted. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Deletes the specified Exadata Pluggable Database Snapshot. tags: - database x-related-resource: '#/definitions/PluggableDatabaseSnapshot' get: description: 'Gets information about the specified Exadata Pluggable Database Snapshot in the specified compartment. ' operationId: GetPluggableDatabaseSnapshot parameters: - $ref: '#/components/parameters/PluggableDatabaseSnapshotIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: Information about the Exadata Pluggable Database Snapshot. 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/PluggableDatabaseSnapshot' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetPluggableDatabaseSnapshot tags: - database x-example: 'GET /20160918/pluggableDatabaseSnapshots/<pluggableDatabaseSnapshotId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' /pluggableDatabases: get: description: 'Gets a list of the pluggable databases in a database or compartment. You must provide either a `databaseId` or `compartmentId` value. ' operationId: ListPluggableDatabases parameters: - $ref: '#/components/parameters/OptionalCompartmentIdQueryParam' - $ref: '#/components/parameters/OptionalDatabaseIdQueryParam' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' - $ref: '#/components/parameters/ListPluggableDatabasesSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ListPluggableDatabasesFilterByLifecycleStateQueryParam' - $ref: '#/components/parameters/ListPluggableDatabasesFilterByPdbNameQueryParam' responses: 200: description: All the pluggable databases in the specified compartment or database (CDB). 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/PluggableDatabaseSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListPluggableDatabases tags: - database x-example: "Example I:\n GET /20160918/pluggableDatabases?databaseId=<databaseId>&limit=10\n Host: database.us-phoenix-1.oraclecloud.com\n <authorization and other headers>\nExample II:\n GET /20160918/pluggableDatabases?compartmentId=<compartmentId>&limit=10\n Host: database.us-phoenix-1.oraclecloud.com\n <authorization and other headers>\n" x-related-resource: '#/definitions/PluggableDatabase' post: description: 'Creates and starts a pluggable database in the specified container database. Pluggable Database can be created using different operations (e.g. LocalClone, RemoteClone, Relocate ) with this API. Use the [StartPluggableDatabase](#/en/database/latest/PluggableDatabase/StartPluggableDatabase) and [StopPluggableDatabase](#/en/database/latest/PluggableDatabase/StopPluggableDatabase) APIs to start and stop the pluggable database. ' operationId: CreatePluggableDatabase parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: The request was successfully received and the create pluggable database operation is in progress. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/PluggableDatabase' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreatePluggableDatabase tags: - database x-example: "Example I:\n POST /20160918/pluggableDatabases\n\n Host: database.us-phoenix-1.oraclecloud.com\n <authorization and other headers>\n {\n \"pdbName\" : \"SalesPdb\",\n \"tdeWalletPassword\" : \"<TDE_password>\"\n \"containerDatabaseId\" : \"ocid1.database.oc1..aaaaaaaah2sauv373xyfrpcnaed2ptfy67fnspzyda2hacgdbrkijhffugaa\",\n \"pdbAdminPassword\" : \"<password>\"\n }\n\nExample II:\n POST /20160918/pluggableDatabases\n\n Host: database.us-phoenix-1.oraclecloud.com\n <authorization and other headers>\n {\n \"pdbName\" : \"SalesPdb\",\n \"tdeWalletPassword\" : \"<TDE_password>\",\n \"containerDatabaseId\" : \"ocid1.database.oc1.<password>\",\n \"shouldCreatePdbBackup\" : \"true\",\n \"pdbCreationTypeDetails\" : {\n \"creationType\" : \"LOCAL_CLONE_PDB\",\n \"sourcePluggableDatabaseId\" : \"ocid1.pluggabledatabase.oc1.\"\n }\n\nExample III:\n POST /20160918/pluggableDatabases\n\n Host: database.us-phoenix-1.oraclecloud.com\n <authorization and other headers>\n {\n \"pdbName\" : \"SalesPdb\",\n \"tdeWalletPassword\" : \"<TDE_password>\",\n \"containerDatabaseId\" : \"ocid1.database.oc1.<password>\",\n \"shouldCreatePdbBackup\" : \"true\",\n \"pdbCreationTypeDetails\" : {\n \"creationType\" : \"REMOTE_CLONE_PDB\",\n \"sourcePluggableDatabaseId\" : \"ocid1.pluggabledatabase.oc1.\",\n \"sourceContainerDatabaseAdminPassword\" : \"<password>\"\n }\n }\n\nExample IV:\n POST /20160918/pluggableDatabases\n\n Host: database.us-phoenix-1.oraclecloud.com\n <authorization and other headers>\n {\n \"pdbName\" : \"SalesPdb\",\n \"tdeWalletPassword\" : \"<TDE_password>\",\n \"containerDatabaseId\" : \"ocid1.database.oc1.<password>\",\n \"shouldCreatePdbBackup\" : \"true\",\n \"pdbCreationTypeDetails\" : {\n \"creationType\" : \"RELOCATE_PDB\",\n \"sourcePluggableDatabaseId\" : \"ocid1.pluggabledatabase.oc1.\",\n \"sourceContainerDatabaseAdminPassword\" : \"<password>\"\n }\n }\n\nExample V:\n POST /20160918/pluggableDatabases\n\n Host: database.us-phoenix-1.oraclecloud.com\n <authorization and other headers>\n {\n \"pdbName\": \"SalesPdb\",\n \"tdeWalletPassword\": \"<TDE_password>\",\n \"containerDatabaseId\": \"ocid1.database.oc1.<password>\",\n \"pdbCreationTypeDetails\": {\n \"creationType\": \"REMOTE_CLONE_PDB\",\n \"dblinkUsername\": \"C##DBLINKUSER\",\n \"dblinkUserPassword\": \"<password>\",\n \"refreshableCloneDetails\" : { \"isRefreshableClone\" : \"true\" },\n \"sourcePluggableDatabaseId\": \"ocid1.pluggabledatabase.oc1.\",\n \"sourceContainerDatabaseAdminPassword\": \"<password>\"\n }\n }\nExample VI:\n POST /20160918/pluggableDatabases\n\n Host: database.us-phoenix-1.oraclecloud.com\n <authorization and other headers>\n {\n \"pdbName\": \"SalesPdb\",\n \"tdeWalletPassword\": \"<TDE_password>\",\n \"containerDatabaseId\": \"ocid1.database.oc1.<password>\",\n \"pdbCreationTypeDetails\": {\n \"creationType\": \"LOCAL_CLONE_PDB\",\n \"sourcePluggableDatabaseId\": \"ocid1.pluggabledatabase.oc1.\",\n \"sourcePluggableDatabaseSnapshotId\": \"ocid1.pluggabledatabasesnapshot.oc1.\",\n \"isThinClone\": \"true\"\n }\n }\nExample VI:\n POST /20160918/pluggableDatabases\n\n Host: database.us-phoenix-1.oraclecloud.com\n <authorization and other headers>\n {\n \"pdbName\": \"SalesPdb\",\n \"tdeWalletPassword\": \"<TDE_password>\",\n \"containerDatabaseId\": \"ocid1.database.oc1.<password>\",\n \"pdbCreationTypeDetails\": {\n \"creationType\": \"REMOTE_CLONE_PDB\",\n \"dblinkUsername\": \"C##DBLINKUSER\",\n \"dblinkUserPassword\": \"<password>\",\n \"sourcePluggableDatabaseId\": \"ocid1.pluggabledatabase.oc1.\",\n \"sourceContainerDatabaseAdminPassword\": \"<password>\",\n \"sourcePluggableDatabaseSnapshotId\": \"ocid1.pluggabledatabasesnapshot.oc1.\",\n \"isThinClone\": \"true\"\n }\n }\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/CreatePluggableDatabaseDetails' description: Request to create pluggable database. required: true /pluggableDatabases/{pluggableDatabaseId}: delete: description: Deletes the specified pluggable database. operationId: DeletePluggableDatabase parameters: - $ref: '#/components/parameters/PluggableDatabaseIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OptionalRequestId' responses: 204: description: The request to delete pluggable database was accepted. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: DeletePluggableDatabase tags: - database x-example: 'DELETE /20160918/pluggableDatabases/<pluggableDatabaseId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/PluggableDatabase' get: description: Gets information about the specified pluggable database. operationId: GetPluggableDatabase parameters: - $ref: '#/components/parameters/PluggableDatabaseIdPathParam' responses: 200: description: The pluggable database. 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/PluggableDatabase' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetPluggableDatabase tags: - database x-example: 'GET /20160918/pluggableDatabases/<pluggableDatabaseId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/PluggableDatabase' put: description: Updates the specified pluggable database. operationId: UpdatePluggableDatabase parameters: - $ref: '#/components/parameters/PluggableDatabaseIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: The request was successfully received and the pluggable database update is in progress. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/PluggableDatabase' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdatePluggableDatabase tags: - database x-example: "PUT /20160918/pluggableDatabases/<pluggableDatabaseId>\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"freeformTags\" : {\"Department\": \"Finance\"}\n}\n" x-related-resource: '#/definitions/PluggableDatabase' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdatePluggableDatabaseDetails' description: Request to perform pluggable database update. required: true /pluggableDatabases/{pluggableDatabaseId}/actions/convertToRegular: post: description: 'Converts a Refreshable clone to Regular pluggable database (PDB). Pluggable Database will be in `READ_WRITE` openmode after conversion. ' operationId: ConvertToRegularPluggableDatabase parameters: - $ref: '#/components/parameters/PluggableDatabaseIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: The request was successfully received and the Refreshable Clone pluggable database will be converted to Regular Pluggable Database. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/PluggableDatabase' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Converts a Refreshable clone to Regular pluggable database. tags: - database x-example: "POST /20160918/pluggableDatabases/<pluggableDatabaseId>/actions/convertToRegular\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n {\n \"shouldCreatePdbBackup\" : \"true\"\n }\n" x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/PluggableDatabase' requestBody: content: application/json: schema: $ref: '#/components/schemas/ConvertToRegularPluggableDatabaseDetails' description: Request to convert a Refreshable clone pluggable database (PDB) to a Regular pluggable database. required: true /pluggableDatabases/{pluggableDatabaseId}/actions/localClone: post: deprecated: true description: '**Deprecated.** Use [CreatePluggableDatabase](#/en/database/latest/PluggableDatabase/CreatePluggableDatabase) for Pluggable Database LocalClone Operation. Clones and starts a pluggable database (PDB) in the same database (CDB) as the source PDB. The source PDB must be in the `READ_WRITE` openMode to perform the clone operation. ' operationId: LocalClonePluggableDatabase parameters: - $ref: '#/components/parameters/PluggableDatabaseIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The request was successfully received and the pluggable database will be cloned. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/PluggableDatabase' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: LocalClonePluggableDatabase tags: - database x-example: "POST /20160918/pluggableDatabases/<pluggableDatabaseId>/actions/localClone\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n {\n \"clonedPdbName\" : \"NewSalesPdb\",\n \"targetTdeWalletPassword\" : \"<TDE_password>\",\n \"pdbAdminPassword\" : \"<password>\"\n }\n" x-related-resource: '#/definitions/PluggableDatabase' requestBody: content: application/json: schema: $ref: '#/components/schemas/LocalClonePluggableDatabaseDetails' description: Request to clone a pluggable database locally. required: true /pluggableDatabases/{pluggableDatabaseId}/actions/refresh: post: description: 'Refreshes a pluggable database (PDB) Refreshable clone. ' operationId: RefreshPluggableDatabase parameters: - $ref: '#/components/parameters/PluggableDatabaseIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: The request was successfully received and the Refreshable Clone pluggable database will be refreshed. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/PluggableDatabase' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Refreshes a pluggable database Refreshable clone. tags: - database x-example: 'POST /20160918/pluggableDatabases/<pluggableDatabaseId>/actions/refresh Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/PluggableDatabase' /pluggableDatabases/{pluggableDatabaseId}/actions/remoteClone: post: deprecated: true description: '**Deprecated.** Use [CreatePluggableDatabase](#/en/database/latest/PluggableDatabase/CreatePluggableDatabase) for Pluggable Database RemoteClone Operation. Clones a pluggable database (PDB) to a different database from the source PDB. The cloned PDB will be started upon completion of the clone operation. The source PDB must be in the `READ_WRITE` openMode when performing the clone. For Exadata Cloud@Customer instances, the source pluggable database (PDB) must be on the same Exadata Infrastructure as the target container database (CDB) to create a remote clone. ' operationId: RemoteClonePluggableDatabase parameters: - $ref: '#/components/parameters/PluggableDatabaseIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The request was successfully received and the pluggable database will be cloned. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/PluggableDatabase' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: RemoteClonePluggableDatabase tags: - database x-example: "POST /20160918/pluggableDatabases/<pluggableDatabaseId>/actions/remoteClone\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n {\n \"clonedPdbName\" : \"NewSalesPdb\",\n \"targetContainerDatabaseId\" : \"ocid1.database.oc1..aaaaaaaah2sauv373xyfrpcnaed2ptfy67fnspzyda2hacgdbrkijhffugaa\",\n \"sourceContainerDbAdminPassword\" : \"<password>\",\n \"targetTdeWalletPassword\" : \"<TDE_password>\",\n \"pdbAdminPassword\" : \"<password>\"\n }\n" x-related-resource: '#/definitions/PluggableDatabase' requestBody: content: application/json: schema: $ref: '#/components/schemas/RemoteClonePluggableDatabaseDetails' description: Request to clone a pluggable database (PDB) to a different database (CDB) from the source PDB. required: true /pluggableDatabases/{pluggableDatabaseId}/actions/start: post: description: Starts a stopped pluggable database. The `openMode` value of the pluggable database will be `READ_WRITE` upon completion. operationId: StartPluggableDatabase parameters: - $ref: '#/components/parameters/PluggableDatabaseIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The request was successfully received and the pluggable database will be started. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/PluggableDatabase' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: StartPluggableDatabase tags: - database x-example: 'POST /20160918/pluggableDatabases/<pluggableDatabaseId>/actions/start Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/PluggableDatabase' /pluggableDatabases/{pluggableDatabaseId}/actions/stop: post: description: Stops a pluggable database. The `openMode` value of the pluggable database will be `MOUNTED` upon completion. operationId: StopPluggableDatabase parameters: - $ref: '#/components/parameters/PluggableDatabaseIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The request was successfully received and the pluggable database will be stopped. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/PluggableDatabase' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: StopPluggableDatabase tags: - database x-example: 'POST /20160918/pluggableDatabases/<pluggableDatabaseId>/actions/stop Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/PluggableDatabase' /resourcePrincipalToken/{instanceId}: get: description: 'Gets a resource principal intermediate token that contains mapping information between the instance prinicpal and resource. ' operationId: GetResourcePrincipalToken parameters: - $ref: '#/components/parameters/InstanceIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: The RPT that has all the mapping information between instance principal and resource information. 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/PrincipalTokenDetails' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetResourcePrincipalToken tags: - database x-example: "Example:\n GET /20160918/ResourcePrincipalToken/\n Host: database.us-phoenix-1.oraclecloud.com\n" x-related-resource: '#/definitions/PrincipalTokenDetails' /scheduledActionParams: get: description: 'List all the action params and their possible values for a given action type ' operationId: ListParamsForActionType parameters: - $ref: '#/components/parameters/ListParamsActionTypeQueryParam' - $ref: '#/components/parameters/ListParamsPlanIntentQueryParam' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: The Action parameters and their possible values. 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/ActionParamValuesCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListParamsForActionType tags: - database x-example: 'GET /20160918/scheduledActionParams?type=<type>&limit=10 Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-obmcs-authz-declarations: authorizationRequired: false x-related-resource: '#/definitions/ActionParamValuesSummary' /scheduledActions: get: description: 'Lists the Scheduled Action resources in the specified compartment. ' operationId: ListScheduledActions parameters: - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/CompartmentId' - $ref: '#/components/parameters/PaginationToken' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ListScheduledActionsFilterByServiceTypeQueryParam' - $ref: '#/components/parameters/ListScheduledActionsFilterBySchedulingPlanIdQueryParam' - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' - $ref: '#/components/parameters/ListScheduledActionsSortByQueryParam' - $ref: '#/components/parameters/ScheduledActionIdQueryParam' - $ref: '#/components/parameters/ListScheduledActionsFilterByLifecycleStateQueryParam' responses: 200: description: 'A list of the Scheduled Action resources in the specified compartment. ' 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/ScheduledActionCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListScheduledActions tags: - database x-example: 'GET /20160918/scheduledActions?compartmentId=<compartmentId>&limit=10 Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/ScheduledAction' post: description: 'Creates a Scheduled Action resource. ' operationId: CreateScheduledAction parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' responses: 201: description: 'The request was successfully received and the create Scheduled Action operation is in progress. ' 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ScheduledAction' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateScheduledAction tags: - database x-example: "POST /20160918/scheduledAction\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\" : \"ocid1.tenancy.oc1.\",\n \"lifecycleState\" : \"CREATING\",\n \"schedulePolicyId\" : \"ocid1.schedulingpolicy.oc1.<unique_ID>\",\n \"schedulePlanId\" : \"ocid1.schedulingplan.oc1.<unique_ID>\",\n \"actionOrder\" : 1\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateScheduledActionDetails' description: Request to create Scheduled Action. required: true /scheduledActions/{scheduledActionId}: delete: description: 'Deletes the scheduled action. ' operationId: DeleteScheduledAction parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/ScheduledActionIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 202: description: The request to delete the scheduled action was accepted. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Delete a scheduled action. tags: - database x-related-resource: '#/definitions/ScheduledAction' get: description: 'Gets information about the specified Scheduled Action. ' operationId: GetScheduledAction parameters: - $ref: '#/components/parameters/ScheduledActionIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: The Scheduled Action details. 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/ScheduledAction' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Get ScheduledAction tags: - database x-example: 'GET /20160918/scheduledactions/<scheduledActionId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' put: description: 'Updates the Scheduled Action resource. ' operationId: UpdateScheduledAction parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/ScheduledActionIdPathParam' responses: 202: description: 'The request was successfully received and the Scheduled Action update is in progress. ' 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ScheduledAction' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Updates the specified Scheduled Action tags: - database x-example: "PUT /latest/scheduledactions/<scheduledActionId>\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"priority\" : 1,\n \"actionMembers\": [\n {\n \"memberOrder\": 1,\n \"component\": \n },\n {\n \"memberOrder\": 2,\n \"component\": \n },\n {\n \"memberOrder\": 3,\n \"component\": \n },\n {\n \"memberOrder\": 4,\n \"component\": \n }\n ]\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateScheduledActionDetails' description: Request to update the properties of a Scheduled Action. required: true /schedulingPlans: get: description: 'Lists the Scheduling Plan resources in the specified compartment. ' operationId: ListSchedulingPlans parameters: - $ref: '#/components/parameters/CompartmentId' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/ListSchedulingPlansSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ListSchedulingPlansFilterByLifecycleStateQueryParam' - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' - $ref: '#/components/parameters/ListSchedulingPlanByResourceIdQueryParam' - $ref: '#/components/parameters/SchedulingPlanIdQueryParam' - $ref: '#/components/parameters/ListSchedulingPlansFilterByPlanIntentQueryParam' responses: 200: description: 'A list of the Scheduling Plan resources in the specified compartment. ' 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/SchedulingPlanCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListSchedulingPlans tags: - database x-example: 'GET /20160918/schedulingPlans?compartmentId=<compartmentId>&limit=10 Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/SchedulingPlan' post: description: 'Creates a Scheduling Plan resource. ' operationId: CreateSchedulingPlan parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' responses: 201: description: 'The request was successfully received and the create Scheduling Plan operation is in progress. ' 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SchedulingPlan' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateSchedulingPlan tags: - database x-example: "POST /20160918/schedulingPlans\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"resourceId\" : \"ocid1.exadatainfrastructure.oc1.phx.\",\n \"schedulePolicyId\" : \"ocid1.schedulingpolicy.oc1.phx.\",\n \"isUsingRecommendedScheduledActions\" : true,\n \"compartmentId\" : \"ocid1.tenancy.oc1.\"\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateSchedulingPlanDetails' description: Request to create Scheduling Plan. required: true /schedulingPlans/{schedulingPlanId}: delete: description: 'Deletes the scheduling plan. ' operationId: DeleteSchedulingPlan parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/SchedulingPlanIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 202: description: The request to delete the scheduling plan was accepted. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Delete a scheduling plan. tags: - database x-related-resource: '#/definitions/SchedulingPlan' get: description: 'Gets information about the specified Scheduling Plan. ' operationId: GetSchedulingPlan parameters: - $ref: '#/components/parameters/SchedulingPlanIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: The Scheduling Plan details. 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/SchedulingPlan' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Get SchedulingPlan tags: - database x-example: 'GET /20160918/schedulingplans/<schedulingPlanId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' /schedulingPlans/{schedulingPlanId}/actions/changeCompartment: post: description: 'Moves an scheduling plan resource to another compartment. ' operationId: ChangeSchedulingPlanCompartment parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/SchedulingPlanIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: The request was successfully received and the change compartment action is being performed. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ChangeSchedulingPlanCompartment tags: - database x-related-resource: '#/definitions/SchedulingPlan' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeSchedulingPlanCompartmentDetails' description: Request to move scheduling plan to a different compartment required: true /schedulingPlans/{schedulingPlanId}/actions/reorder: post: description: 'Re-order the scheduled actions under this scheduling plan resource. ' operationId: ReorderScheduledActions parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/SchedulingPlanIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: 'The request was successfully received and the scheduled action reordering is in progress. ' headers: etag: description: For optimistic concurrency control. See `if-match`. schema: 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SchedulingPlan' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Re-order the scheduled actions under this scheduling plan resource tags: - database x-example: "POST /20160918/reorderScheduledActions\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"scheduledActionIdOrders\": [\n {\n \"actionOrder\": \"1\",\n \"actionResourceId\": \"ocid1.scheduledaction.oc1.phx.\"\n },\n {\n \"actionOrder\": \"2\",\n \"actionResourceId\": \"ocid1.scheduledaction.oc1.phx.\"\n }\n ]\n}\n" x-related-resource: '#/definitions/SchedulingPlan' requestBody: content: application/json: schema: $ref: '#/components/schemas/ReorderScheduledActionsDetails' description: Request to re-order Scheduled Action resources. required: true /schedulingPolicies: get: description: 'Lists the Scheduling Policy resources in the specified compartment. ' operationId: ListSchedulingPolicies parameters: - $ref: '#/components/parameters/CompartmentId' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/ListSchedulingPoliciesSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ListSchedulingPoliciesFilterByLifecycleStateQueryParam' - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' - $ref: '#/components/parameters/ListSchedulingPoliciesFilterByCadenceQueryParam' responses: 200: description: 'A list of the Scheduling Policy resources in the specified compartment. ' 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/SchedulingPolicySummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListSchedulingPolicies tags: - database x-example: 'GET /20160918/schedulingPolicies?compartmentId=<compartmentId>&limit=10 Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/SchedulingPolicy' post: description: 'Creates a Scheduling Policy resource. ' operationId: CreateSchedulingPolicy parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: 'The request was successfully received and the create Scheduling Policy operation is in progress. ' 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SchedulingPolicy' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateSchedulingPolicy tags: - database x-example: "POST /20160918/schedulingPolicy\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\" : \"ocid1.tenancy.oc1.<unique_ID>\",\n \"displayName\" : \"tstSchedulingPolicy\",\n \"cadence\" : QUARTERLY,\n \"cadenceStartMonth\" : \"FEBRUARY\"\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateSchedulingPolicyDetails' description: Request to create Scheduling Policy. required: true /schedulingPolicies/{schedulingPolicyId}: delete: description: 'Deletes the scheduling policy. ' operationId: DeleteSchedulingPolicy parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/SchedulingPolicyIdPathParam' responses: 204: description: The request to delete the scheduling policy was accepted. 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 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Delete a scheduling policy. tags: - database x-related-resource: '#/definitions/SchedulingPolicy' get: description: 'Gets information about the specified Scheduling Policy. ' operationId: GetSchedulingPolicy parameters: - $ref: '#/components/parameters/SchedulingPolicyIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: The Scheduling Policy details. 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/SchedulingPolicy' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Get SchedulingPolicy tags: - database x-example: 'GET /20160918/schedulingpolicies/<schedulingPolicyId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' put: description: 'Updates the Scheduling Policy resource. ' operationId: UpdateSchedulingPolicy parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/SchedulingPolicyIdPathParam' responses: 200: description: 'The request was successfully received and the Scheduling Policy update is in progress. ' 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SchedulingPolicy' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Updates the specified Scheduling Policy tags: - database x-example: "PUT /latest/schedulingPolicies/<schedulingPolicyId>\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\" : \"updatedSchedulingPolicy\"\n \"cadence\" : QUARTERLY,\n \"cadenceStartMonth\" : \"FEBRUARY\"\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateSchedulingPolicyDetails' description: Request to update the properties of a Scheduling Policy. required: true /schedulingPolicies/{schedulingPolicyId}/actions/changeCompartment: post: description: 'Moves an scheduling policy resource to another compartment. ' operationId: ChangeSchedulingPolicyCompartment parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/SchedulingPolicyIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: The request was successfully received and the change compartment action is being performed. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ChangeSchedulingPolicyCompartment tags: - database x-related-resource: '#/definitions/SchedulingPolicy' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeSchedulingPolicyCompartmentDetails' description: Request to move scheduling policy to a different compartment required: true /schedulingPolicies/{schedulingPolicyId}/recommendedScheduledActions: get: description: 'Returns a recommended Scheduled Actions configuration for a given resource, plan intent and scheduling policy. ' operationId: ListRecommendedScheduledActions parameters: - $ref: '#/components/parameters/SchedulingPolicyIdPathParam' - $ref: '#/components/parameters/SchedulingPolicyTargetResourceIdQueryParam' - $ref: '#/components/parameters/PlanIntentQueryParam' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: The Scheduling Actions configuration. 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/RecommendedScheduledActionsCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListRecommendedScheduledActions tags: - database x-example: 'GET /20160918/schedulingPolicies/<schedulingPolicyId>/recommendedScheduledActions?schedulingPolicyTargetResourceId=<schedulingPolicyTargetResourceId>&planIntent=<planIntent> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/RecommendedScheduledActionSummary' /schedulingPolicies/{schedulingPolicyId}/schedulingWindows: get: description: 'Lists the Scheduling Window resources in the specified compartment. ' operationId: ListSchedulingWindows parameters: - $ref: '#/components/parameters/SchedulingPolicyIdPathParam' - $ref: '#/components/parameters/OptionalCompartmentIdQueryParam' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/ListSchedulingWindowsSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ListSchedulingWindowsFilterByLifecycleStateQueryParam' - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' responses: 200: description: 'A list of the Scheduling Window resources in the specified compartment. ' 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/SchedulingWindowSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListSchedulingWindows tags: - database x-example: 'GET /20160918/schedulingPolicies/<schedulingPolicyId>/schedulingWindows?compartmentId=<compartmentId>&limit=10 Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/SchedulingWindow' post: description: 'Creates a Scheduling Window resource. ' operationId: CreateSchedulingWindow parameters: - $ref: '#/components/parameters/SchedulingPolicyIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: 'The request was successfully received and the create Scheduling Window operation is in progress. ' 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SchedulingWindow' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateSchedulingWindow tags: - database x-example: "POST /20160918/schedulingPolicies/<schedulingPolicyId>/schedulingWindows\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"schedulingPolicyId\" : \"ocid1.schedulingpolicy.oc1.phx.\",\n \"windowPreference\" : {\n \"months\" : [\"FEBRUARY\"],\n \"weeksOfMonth\" : [1],\n \"daysOfWeek\" : [SATURDAY],\n \"startTime\" : \"10:00\",\n \"duration\" : 12,\n \"isEnforcedDuration\" : false\n }\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateSchedulingWindowDetails' description: Request to create Scheduling Window. required: true /schedulingPolicies/{schedulingPolicyId}/schedulingWindows/{schedulingWindowId}: delete: description: 'Deletes the scheduling window. ' operationId: DeleteSchedulingWindow parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/SchedulingPolicyIdPathParam' - $ref: '#/components/parameters/SchedulingWindowIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 204: description: The request to delete the scheduling window was accepted. 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 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Delete a scheduling window. tags: - database x-related-resource: '#/definitions/SchedulingWindow' get: description: 'Gets information about the specified Scheduling Window. ' operationId: GetSchedulingWindow parameters: - $ref: '#/components/parameters/SchedulingPolicyIdPathParam' - $ref: '#/components/parameters/SchedulingWindowIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: The Scheduling Window details. 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/SchedulingWindow' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Get SchedulingWindow tags: - database x-example: 'GET /20160918/schedulingPolicies/<schedulingPolicyId>/schedulingWindows/<schedulingWindowId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' put: description: 'Updates the Scheduling Window resource. ' operationId: UpdateSchedulingWindow parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/SchedulingPolicyIdPathParam' - $ref: '#/components/parameters/SchedulingWindowIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: 'The request was successfully received and the Scheduling Window update is in progress. ' 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SchedulingWindow' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Updates the specified Scheduling Window tags: - database x-example: "PUT /latest/schedulingPolicies/<schedulingPolicyId>/schedulingWindows/<schedulingWindowId>\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"schedulingPolicyId\" : \"ocid1.schedulingpolicy.oc1.phx.\",\n \"windowPreference\" : {\n \"months\" : [\"FEBRUARY\"],\n \"weeksOfMonth\" : [1],\n \"daysOfWeek\" : [SATURDAY],\n \"startTime\" : \"10:00\",\n \"duration\" : 12,\n \"isEnforcedDuration\" : false\n }\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateSchedulingWindowDetails' description: Request to update the properties of a Scheduling Window. required: true /systemVersions: get: description: Gets a list of supported Exadata system versions for a given shape and GI version. operationId: ListSystemVersions parameters: - $ref: '#/components/parameters/CompartmentId' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/OptionalShapeQueryParam' - $ref: '#/components/parameters/OptionalLatestQueryParam' - $ref: '#/components/parameters/OptionalResourceIdQueryParam' - $ref: '#/components/parameters/GridInfrastructureVersionQueryParam' responses: 200: description: The list of supported Exadata system versions for a given shape and GI version. 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/SystemVersionCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListSystemVersions tags: - database x-example: 'GET /20160918/systemVersions?compartmentId=<compartmentId>&shape=<shape>&giVersion=<giVersion>&limit=100 Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' /systemVersions/{majorVersion}/minorVersions: get: description: Retrieves a list of supported minor versions for the specified Exadata System Software major version. You must provide either a `shape` or `resourceId` value. operationId: ListSystemVersionMinorVersions parameters: - $ref: '#/components/parameters/MajorSystemVersionPathParam' - $ref: '#/components/parameters/CompartmentId' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/GridInfrastructureVersionQueryParam' - $ref: '#/components/parameters/OptionalShapeQueryParam' - $ref: '#/components/parameters/OptionalResourceIdQueryParam' - $ref: '#/components/parameters/OptionalLatestQueryParam' responses: 200: description: Retrieves a list of supported minor versions for the specified Exadata System Software major version. 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/SystemVersionMinorVersionCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListSystemVersionMinorVersions tags: - database x-example: 'GET /20160918/systemVersions/<majorVersion>/minorVersions?shapeFamily=EXADATA Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' /vmClusters: get: description: 'Lists the VM clusters in the specified compartment. Applies to Exadata Cloud@Customer instances only. To list the cloud VM clusters in an Exadata Cloud Service instance, use the [ListCloudVmClusters ](#/en/database/latest/CloudVmCluster/ListCloudVmClusters) operation. ' operationId: ListVmClusters parameters: - $ref: '#/components/parameters/CompartmentId' - $ref: '#/components/parameters/OptionalExadataInfrastructureIdQueryParam' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' - $ref: '#/components/parameters/ListVmClustersSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ListVmClustersFilterByLifecycleStateQueryParam' - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: The list of Exadata Cloud@Customer VM clusters. 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/VmClusterSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListVmClusters tags: - database x-example: 'GET /20160918/vmClusters?compartmentId=<compartmentId>&limit=10 Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/VmCluster' post: description: 'Creates an Exadata Cloud@Customer VM cluster. ' operationId: CreateVmCluster parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: The request was successfully received and the create VM cluster operation is in progress. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/VmCluster' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateVmCluster tags: - database x-example: "POST /20160918/vmClusters\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\" : \"vmCluster\",\n \"compartmentId\" : \"ocid1.tenancy.oc1.<unique_ID>\",\n \"exadataInfrastructureId\" : \"ocid1.tenancy.oc1.oc1.<unique_ID>\",\n \"vmClusterNetworkId\" : \"ocid1.vmclusternetwork.oc1.<unique_ID>\",\n \"cpuCoreCount\" : 4,\n \"memorySizeInGBs\" : 30,\n \"dbNodeStorageSizeInGBs\" : 60,\n \"dataStorageSizeInTBs\" : 84,\n \"sshPublicKeys\" : [ \"ssh-rsa <public_SSH_key> name@example.com\" ],\n \"licenseModel\" : \"LICENSE_INCLUDED\",\n \"isSparseDiskgroupEnabled\" : false,\n \"isLocalBackupEnabled\" : true,\n \"timeZone\" : \"PST\",\n \"giVersion\" : \"19.1.0.0\",\n \"fileSystemConfigurationDetails\" : [{\n \"mountPoint\" : \"/u01\",\n \"fileSystemSizeGb\" : 10\n }, {\n \"mountPoint\" : \"/var\",\n \"fileSystemSizeGb\" : 10\n }],\n \"dbServers\" : [\"ocid1.dbserver.oc1.\", \"ocid1.dbserver.oc1.\"]\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateVmClusterDetails' description: 'Request to create a VM cluster. Applies to Exadata Cloud@Customer instances only. See [CreateCloudVmClusterDetails Reference](#/en/database/latest/datatypes/CreateCloudVmClusterDetails) for details on creating a cloud VM cluster in an Exadata Cloud Service instance. ' required: true /vmClusters/{vmClusterId}: delete: description: 'Deletes the specified VM cluster. Applies to Exadata Cloud@Customer instances only. ' operationId: DeleteVmCluster parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/VmClusterIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 204: description: The request to delete the VM cluster was accepted. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Deletes the specified VM cluster. tags: - database x-related-resource: '#/definitions/VmCluster' get: description: 'Gets information about the VM cluster. Applies to Exadata Cloud@Customer instances only. ' operationId: GetVmCluster parameters: - $ref: '#/components/parameters/VmClusterIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: Information about the Exadata Cloud@Customer VM cluster. 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/VmCluster' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetVmCluster tags: - database x-example: 'GET /20160918/vmClusters/<vmClusterId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' put: description: 'Updates the specified VM cluster. Applies to Exadata Cloud@Customer instances only. ' operationId: UpdateVmCluster parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/VmClusterIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: The request was successfully received and the VM cluster update is in progress. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/VmCluster' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Updates the specified VM cluster. tags: - database x-example: "PUT /20160918/vmClusters/<vmClusterId>\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"cpuCoreCount\" : 10\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateVmClusterDetails' description: Request to update the attributes of a VM cluster. required: true /vmClusters/{vmClusterId}/actions/addVirtualMachine: post: description: 'Add Virtual Machines to the VM cluster. Applies to Exadata Cloud@Customer instances only. ' operationId: AddVirtualMachineToVmCluster parameters: - $ref: '#/components/parameters/VmClusterIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: The request was successfully received and the adding Virtual Machines action is being performed. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/VmCluster' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: AddVirtualMachineToVmCluster tags: - database x-example: "POST /20160918/vmClusters/<vmClusterId>/actions/addVirtualMachine\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"dbServers\" : [\n {\n \"dbServerId\" : \"ocid1.dbserver.oc1.\"\n },\n {\n \"dbServerId\" : \"ocid1.dbserver.oc1.\"\n }\n ]\n}\n" x-related-resource: '#/definitions/VmCluster' requestBody: content: application/json: schema: $ref: '#/components/schemas/AddVirtualMachineToVmClusterDetails' description: Request to add Virtual Machines to the VM cluster. required: true /vmClusters/{vmClusterId}/actions/changeCompartment: post: description: 'Moves a VM cluster and its dependent resources to another compartment. Applies to Exadata Cloud@Customer instances only. To move a cloud VM cluster in an Exadata Cloud Service instance to another compartment, use the [ChangeCloudVmClusterCompartment ](#/en/database/latest/CloudVmCluster/ChangeCloudVmClusterCompartment) operation. ' operationId: ChangeVmClusterCompartment parameters: - $ref: '#/components/parameters/VmClusterIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: The request was successfully received and the change compartment action is being performed. 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 of the work request. schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ChangeVmClusterCompartment tags: - database x-related-resource: '#/definitions/VmCluster' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeVmClusterCompartmentDetails' description: Request to move the Exadata Cloud@Customer VM cluster to a different compartment. required: true /vmClusters/{vmClusterId}/actions/removeVirtualMachine: post: description: 'Remove Virtual Machines from the VM cluster. Applies to Exadata Cloud@Customer instances only. ' operationId: RemoveVirtualMachineFromVmCluster parameters: - $ref: '#/components/parameters/VmClusterIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/OptionalRequestId' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: The request was successfully received and the removing Virtual Machines action is being performed. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/VmCluster' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: RemoveVirtualMachineFromVmCluster tags: - database x-example: "POST /20160918/vmClusters/<vmClusterId>/actions/removeVirtualMachine\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"dbServers\" : [\n {\n \"dbServerId\" : \"ocid1.dbserver.oc1.\"\n },\n {\n \"dbServerId\" : \"ocid1.dbserver.oc1.\"\n }\n ]\n}\n" x-related-resource: '#/definitions/VmCluster' requestBody: content: application/json: schema: $ref: '#/components/schemas/RemoveVirtualMachineFromVmClusterDetails' description: Request to remove Virtual Machines from the VM cluster. required: true /vmClusters/{vmClusterId}/patchHistoryEntries: get: description: 'Gets the history of the patch actions performed on the specified VM cluster in an Exadata Cloud@Customer system. ' operationId: ListVmClusterPatchHistoryEntries parameters: - $ref: '#/components/parameters/VmClusterIdPathParam' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' responses: 200: description: The patch history for the specified VM cluster. 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/PatchHistoryEntrySummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListVmClusterPatchHistoryEntries tags: - database x-example: 'GET /20160918/vmClusters/<vmClusterId>/patchHistoryEntries?limit=100 Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/PatchHistoryEntry' /vmClusters/{vmClusterId}/patchHistoryEntries/{patchHistoryEntryId}: get: description: 'Gets the patch history details for the specified patch history entry. ' operationId: GetVmClusterPatchHistoryEntry parameters: - $ref: '#/components/parameters/VmClusterIdPathParam' - $ref: '#/components/parameters/PatchHistoryEntryIdPathParam' responses: 200: description: The patch history details for the specified patch history entry. 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/PatchHistoryEntry' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetVmClusterPatchHistoryEntry tags: - database x-example: 'GET /20160918/patchHistoryEntries/<patchHistoryEntryId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/PatchHistoryEntry' /vmClusters/{vmClusterId}/patches: get: description: 'Lists the patches applicable to the specified VM cluster in an Exadata Cloud@Customer system. ' operationId: ListVmClusterPatches parameters: - $ref: '#/components/parameters/VmClusterIdPathParam' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' responses: 200: description: The list of the patches was retrieved. 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/PatchSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListVmClusterPatches tags: - database x-example: 'GET /20160918/vmclusters/<vmClusterId>/patches?limit=10 Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/Patch' /vmClusters/{vmClusterId}/patches/{patchId}: get: description: 'Gets information about a specified patch package. ' operationId: GetVmClusterPatch parameters: - $ref: '#/components/parameters/VmClusterIdPathParam' - $ref: '#/components/parameters/PatchIdPathParam' responses: 200: description: The patch package. 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/Patch' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetVmClusterPatch tags: - database x-example: 'GET /20160918/vmClusters/<vmClusterId>/patches/<patchId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/Patch' /vmClusters/{vmClusterId}/updateHistoryEntries: get: description: 'Gets the history of the maintenance update actions performed on the specified VM cluster. Applies to Exadata Cloud@Customer instances only. ' operationId: ListVmClusterUpdateHistoryEntries parameters: - $ref: '#/components/parameters/VmClusterIdPathParam' - $ref: '#/components/parameters/FilterByVmClusterUpdateTypeQueryParam' - $ref: '#/components/parameters/ListVmClusterUpdateHistoryEntriesFilterByLifecycleStateQueryParam' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: The maintenance update history for the specified VM cluster. 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/VmClusterUpdateHistoryEntrySummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListVmClusterUpdateHistoryEntries tags: - database x-example: 'GET /20160918/vmClusters/<vmClusterId>/updateHistoryEntries?limit=100 Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/VmClusterUpdateHistoryEntry' /vmClusters/{vmClusterId}/updateHistoryEntries/{updateHistoryEntryId}: get: description: 'Gets the maintenance update history details for the specified update history entry. Applies to Exadata Cloud@Customer instances only. ' operationId: GetVmClusterUpdateHistoryEntry parameters: - $ref: '#/components/parameters/VmClusterIdPathParam' - $ref: '#/components/parameters/UpdateHistoryEntryIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: The maintenance update history details for the specified update history entry. 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/VmClusterUpdateHistoryEntry' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetVmClusterUpdateHistoryEntry tags: - database x-example: 'GET /20160918/vmClusters/<vmClusterId>/updateHistoryEntries/<updateHistoryEntryId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/VmClusterUpdateHistoryEntry' /vmClusters/{vmClusterId}/updates: get: description: 'Lists the maintenance updates that can be applied to the specified VM cluster. Applies to Exadata Cloud@Customer instances only. ' operationId: ListVmClusterUpdates parameters: - $ref: '#/components/parameters/VmClusterIdPathParam' - $ref: '#/components/parameters/FilterByVmClusterUpdateTypeQueryParam' - $ref: '#/components/parameters/ListVmClusterUpdatesFilterByLifecycleStateQueryParam' - $ref: '#/components/parameters/PaginationLimitParam' - $ref: '#/components/parameters/PaginationToken' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: A list of the maintenance update packages. 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' 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/VmClusterUpdateSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListVmClusterUpdates tags: - database x-example: 'GET /20160918/vmclusters/<vmClusterId>/updates?limit=10 Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/VmClusterUpdate' /vmClusters/{vmClusterId}/updates/{updateId}: get: description: 'Gets information about a specified maintenance update package for a VM cluster. Applies to Exadata Cloud@Customer instances only. ' operationId: GetVmClusterUpdate parameters: - $ref: '#/components/parameters/VmClusterIdPathParam' - $ref: '#/components/parameters/UpdateIdPathParam' - $ref: '#/components/parameters/OptionalRequestId' responses: 200: description: The maintenance update package. 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/VmClusterUpdate' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetVmClusterUpdate tags: - database x-example: 'GET /20160918/vmClusters/<vmClusterId>/updates/<updateId> Host: database.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/VmClusterUpdate' components: parameters: isFreeTierQueryParam: description: 'Filter on the value of the resource''s ''isFreeTier'' property. A value of `true` returns only Always Free resources. A value of `false` excludes Always Free resources from the returned results. Omitting this parameter returns both Always Free and paid resources. ' in: query name: isFreeTier schema: type: boolean AvailabilityDomainQueryParam: description: The name of the Availability Domain. in: query name: availabilityDomain required: true schema: type: string ConsoleConnectionIdPathParam: description: The OCID of the console connection. in: path name: consoleConnectionId required: true schema: type: string PatchIdPathParam: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the patch. in: path name: patchId required: true schema: type: string maxLength: 255 minLength: 1 listAutonomousDatabasesFilterByCloneTypeQueryParam: description: A filter to return only resources that match the given clone type exactly. in: query name: cloneType required: false schema: type: string enum: - REFRESHABLE_CLONE DataGuardAssociationIdPathParam: description: The Data Guard association's [OCID](/Content/General/Concepts/identifiers.htm). in: path name: dataGuardAssociationId required: true schema: type: string maxLength: 255 minLength: 1 ListScheduledActionsFilterByServiceTypeQueryParam: description: A filter to return only resources that match the given service type exactly. in: query name: serviceType required: false x-default-description: Return only resources that match the given service type exactly. schema: type: string maxLength: 255 minLength: 1 IfMatchHeader: description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter 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 FilterByNameQueryParam: description: A filter to return only resources that match the entire name given. The match is not case sensitive. in: query name: name required: false schema: type: string ListDbHomesFilterByLifecycleStateQueryParam: description: A filter to return only resources that match the given lifecycle state exactly. in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/DbHomeSummary/lifecycleState' schema: type: string ListParamsPlanIntentQueryParam: description: The plan intent the action will be used for. Relevant to action type that can be used in multiple plans in: query name: planIntent required: false x-default-description: Return relevant to action type that can be used in multiple plans schema: type: string enum: - EXADATA_INFRASTRUCTURE_FULL_SOFTWARE_UPDATE - EXADATA_INFRASTRUCTURE_SECURITY_UPDATE ListPluggableDatabasesFilterByPdbNameQueryParam: description: A filter to return only pluggable databases that match the entire name given. The match is not case sensitive. in: query name: pdbName required: false x-default-description: 'null' schema: type: string maintenanceRunIdPathParam: description: The maintenance run OCID. in: path name: maintenanceRunId required: true schema: type: string maxLength: 255 minLength: 1 ListDatabasesFilterByLifecycleStateQueryParam: description: A filter to return only resources that match the given lifecycle state exactly. in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/DatabaseSummary/lifecycleState' schema: type: string ListDbHomesSortByQueryParam: description: The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. in: query name: sortBy required: false schema: type: string enum: - TIMECREATED - DISPLAYNAME ListCloudExadataInfrastructuresFilterByClusterPlacementGroupIdQueryParam: description: A filter to return only resources that match the given cluster placement group ID exactly. in: query name: clusterPlacementGroupId required: false schema: type: string ListExadbVmClustersSortByQueryParam: description: 'The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. ' in: query name: sortBy required: false schema: type: string enum: - TIMECREATED - DISPLAYNAME default: TIMECREATED TimeExpiryScheduledGreaterThanOrEqualTo: description: The start of date-time range of expiration for the long term backups to be fetched. in: query name: timeExpiryScheduledGreaterThanOrEqualTo required: false x-default-description: 'null' schema: type: string format: date-time mustDeleteAssociatedLongTermBackupsQueryParam: description: If set to true, terminating the Autonomous AI Database also deletes its associated long-term backups if the retention lock is not enabled. in: query name: mustDeleteAssociatedLongTermBackups required: false x-default-description: 'false' schema: type: boolean default: false ListVmClustersFilterByLifecycleStateQueryParam: description: A filter to return only resources that match the given lifecycle state exactly. in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/VmClusterSummary/lifecycleState' schema: type: string listMaintenanceRunsFilterByLifecycleStateQueryParam: description: A filter to return only resources that match the given lifecycle state exactly. in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/MaintenanceRunSummary/lifecycleState' schema: type: string OptionalShapeFamilyQueryParam: description: If provided, filters the results to the set of database versions which are supported for the given shape family. in: query name: shapeFamily required: false x-default-description: 'null' schema: type: string enum: - SINGLENODE - YODA - VIRTUALMACHINE - EXADATA - EXACC - EXADB_XS OptionalCompartmentIdQueryParam: description: The compartment [OCID](/Content/General/Concepts/identifiers.htm). in: query name: compartmentId required: false schema: type: string maxLength: 255 minLength: 1 PerformFinalBackupParam: description: 'Whether to perform a final backup of the database or not. Default is false. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work. This parameter is used in multiple APIs. Refer to the API description for details on how the operation uses it. ' in: query name: performFinalBackup required: false schema: type: boolean default: false AutonomousPatchIdPathParam: description: The autonomous patch [OCID](/Content/General/Concepts/identifiers.htm). in: path name: autonomousPatchId required: true schema: type: string maxLength: 255 minLength: 1 SchedulingPolicyIdPathParam: description: The Scheduling Policy [OCID](/Content/General/Concepts/identifiers.htm). in: path name: schedulingPolicyId required: true schema: type: string maxLength: 255 minLength: 1 ListDbnodeSnapshotsFilterByDbNodeQueryParam: description: A filter to return only Exadata Database Snapshots that match the given database node. in: query name: sourceDbnodeId required: false schema: type: string ListDbSystemsSortByQueryParam: description: 'The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. **Note:** If you do not include the availability domain filter, the resources are grouped by availability domain, then sorted. ' in: query name: sortBy required: false schema: type: string enum: - TIMECREATED - DISPLAYNAME ListSchedulingPoliciesSortByQueryParam: description: 'The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. ' in: query name: sortBy required: false schema: type: string enum: - TIMECREATED - DISPLAYNAME FilterByPdbConversionActionQueryParam: description: A filter to return only the pluggable database conversion history entries that match the specified conversion action. For example, you can use this filter to return only entries for the precheck operation. in: query name: pdbConversionAction required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/PdbConversionHistoryEntrySummary/action' schema: type: string isDataGuardEnabledQueryParam: description: A filter to return only resources that have Data Guard enabled. in: query name: isDataGuardEnabled required: false schema: type: boolean AutonomousDatabaseDataguardAssociationIdPathParam: description: The Autonomous Container Database-Autonomous Data Guard association [OCID](/Content/General/Concepts/identifiers.htm). in: path name: autonomousDatabaseDataguardAssociationId required: true schema: type: string maxLength: 255 minLength: 1 ListExecutionActionsSortByQueryParam: description: 'The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. ' in: query name: sortBy required: false schema: type: string enum: - TIMECREATED - DISPLAYNAME default: TIMECREATED ListExecutionActionsFilterByLifecycleStateQueryParam: description: A filter to return only resources that match the given lifecycle state exactly. in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/ExecutionActionSummary/lifecycleState' schema: type: string ListConsoleHistoriesSortByQueryParam: description: 'The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. ' in: query name: sortBy required: false x-default-description: 'null' schema: type: string enum: - TIMECREATED - DISPLAYNAME ListExternalPluggableDatabasesSortByQueryParam: description: 'The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. ' in: query name: sortBy required: false x-default-description: 'The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. ' schema: type: string enum: - DISPLAYNAME - TIMECREATED ExadataInfrastructureIdPathParam: description: The Exadata infrastructure [OCID](/Content/General/Concepts/identifiers.htm). in: path name: exadataInfrastructureId required: true schema: type: string maxLength: 255 minLength: 1 ListCloudAutonomousVmClustersFilterByLifecycleStateQueryParam: description: A filter to return only resources that match the given lifecycle state exactly. in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/CloudAutonomousVmClusterSummary/lifecycleState' schema: type: string optionalAutonomousExadataInfrastructureIdQueryParam: description: The Autonomous Exadata Infrastructure [OCID](/Content/General/Concepts/identifiers.htm). in: query name: autonomousExadataInfrastructureId required: false schema: type: string maxLength: 255 minLength: 1 ListAutonomousDatabaseSoftwareImagesFilterByImageShapeFamilyQueryParam: description: A filter to return only resources that match the given image shape family exactly. in: query name: imageShapeFamily required: true x-obmcs-enumref: '#/definitions/AutonomousDatabaseSoftwareImage/imageShapeFamily' schema: type: string ShapeTypeParam: description: Optional. Filters the performance results by shape type. in: query name: shapeType required: false x-default-description: 'null' schema: type: string PaginationToken: description: The pagination token to continue listing from. in: query name: page required: false schema: type: string maxLength: 256 minLength: 1 ListPluggableDatabaseSnapshotsFilterByLifecycleStateQueryParam: description: A filter to return only Exadata Pluggable Database Snapshots that match the given lifecycle state exactly. in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/PluggableDatabaseSnapshot/lifecycleState' schema: type: string FilterByPdbConversionLifecycleStateQueryParam: description: A filter to return only the pluggable database conversion history entries that match the specified lifecycle state. For example, you can use this filter to return only entries in the "failed" lifecycle state. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/PdbConversionHistoryEntrySummary/lifecycleState' schema: type: string ListScheduledActionsSortByQueryParam: description: 'The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. ' in: query name: sortBy required: false schema: type: string enum: - TIMECREATED - DISPLAYNAME default: TIMECREATED ExternalNonContainerDatabaseIdPathParam: description: The external non-container database [OCID](/Content/General/Concepts/identifiers.htm). in: path name: externalNonContainerDatabaseId required: true schema: type: string maxLength: 255 minLength: 1 characterSetTypeQueryParam: description: 'Specifies whether this request pertains to database character sets or national character sets. ' in: query name: characterSetType schema: type: string enum: - DATABASE - NATIONAL default: DATABASE OptionalCloudExadataInfrastructureIdQueryParam: description: If provided, filters the results for the specified cloud Exadata infrastructure. in: query name: cloudExadataInfrastructureId required: false schema: type: string maxLength: 255 minLength: 1 UpdateIdPathParam: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the maintenance update. in: path name: updateId required: true schema: type: string maxLength: 255 minLength: 1 ListParamsActionTypeQueryParam: description: The type of the scheduled action in: query name: type required: true x-obmcs-enumref: '#/definitions/RecommendedScheduledActionSummary/actionType' schema: type: string ListUpgradeHistoryEntriesSortByQueryParam: description: 'The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is ascending. ' in: query name: sortBy required: false schema: type: string enum: - TIMESTARTED default: TIMESTARTED ListVmClusterUpdateHistoryEntriesFilterByLifecycleStateQueryParam: description: A filter to return only resources that match the given lifecycle state exactly. in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/VmClusterUpdateHistoryEntrySummary/lifecycleState' schema: type: string ListCloudExadataInfrastructuresSortByQueryParam: description: 'The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. ' in: query name: sortBy required: false schema: type: string enum: - TIMECREATED - DISPLAYNAME VmClusterIdPathParam: description: The VM cluster [OCID](/Content/General/Concepts/identifiers.htm). in: path name: vmClusterId required: true schema: type: string maxLength: 255 minLength: 1 isDeleteVmClustersQueryParam: description: 'If `true`, forces the deletion the specified cloud Exadata infrastructure resource as well as all associated VM clusters. If `false`, the cloud Exadata infrastructure resource can be deleted only if it has no associated VM clusters. Default value is `false`. ' in: query name: isDeleteVmClusters schema: type: boolean default: false UpdateHistoryEntryIdPathParam: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the maintenance update history entry. in: path name: updateHistoryEntryId required: true schema: type: string maxLength: 255 minLength: 1 MajorSystemVersionPathParam: description: The System major version. in: path name: majorVersion required: true schema: type: string maxLength: 255 minLength: 1 ListDbnodeSnapshotsFilterByClusterQueryParam: description: A filter to return only Exadata Database Node Snapshots that match the given VM cluster. in: query name: clusterId required: false schema: type: string CloudVmClusterIdPathParam: description: The cloud VM cluster [OCID](/Content/General/Concepts/identifiers.htm). in: path name: cloudVmClusterId required: true schema: type: string maxLength: 255 minLength: 1 PatchSetGreaterThanOrEqualToQueryParam: description: A filter to return only resources with `patchSet` greater than or equal to given value. in: query name: patchSetGreaterThanOrEqualTo required: false schema: type: string FilterByExadbVmClusterUpdateTypeQueryParam: description: A filter to return only resources that match the given update type exactly. in: query name: updateType required: false schema: type: string enum: - GI_UPGRADE - GI_PATCH - OS_UPDATE default: GI_UPGRADE VmClusterCountGreaterThanOrEqualToQueryParam: description: A filter to return only Exadata Database Storage Vaults with associated Exadata VM Clusters greater than or equal to the given count in: query name: vmClusterCountGreaterThanOrEqualTo required: false schema: type: integer minimum: 0 PatchHistoryEntryIdPathParam: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the patch history entry. in: path name: patchHistoryEntryId required: true schema: type: string maxLength: 255 minLength: 1 ListAutonomousExadataInfrastructuresSortByQueryParam: description: "The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.\n\n **Note:** If you do not include the availability domain filter, the resources are grouped by availability domain, then sorted.\n" in: query name: sortBy required: false schema: type: string enum: - TIMECREATED - DISPLAYNAME SchedulingPolicyTargetResourceIdQueryParam: description: The target resource [OCID](/Content/General/Concepts/identifiers.htm) the scheduled actions will be for. in: query name: schedulingPolicyTargetResourceId required: true schema: type: string maxLength: 255 minLength: 1 listAutonomousDatabaseBackupsSortByQueryParam: description: 'The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. **Note:** If you do not include the availability domain filter, the resources are grouped by availability domain, then sorted. ' in: query name: sortBy required: false schema: type: string enum: - TIMECREATED - DISPLAYNAME FilterByCloudVmClusterUpdateTypeQueryParam: description: A filter to return only resources that match the given update type exactly. in: query name: updateType required: false schema: type: string enum: - GI_UPGRADE - GI_PATCH - OS_UPDATE ListSchedulingWindowsFilterByLifecycleStateQueryParam: description: A filter to return only resources that match the given lifecycle state exactly. in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/SchedulingWindowSummary/lifecycleState' schema: type: string ExadbxsAvailabilityDomainParam: description: The target availability domain. Only passed if the limit is AD-specific. in: query name: availabilityDomain required: false schema: type: string maintenanceRunHistoryIdPathParam: description: The maintenance run history OCID. in: path name: maintenanceRunHistoryId required: true schema: type: string maxLength: 255 minLength: 1 ListDbnodeSnapshotsSortByQueryParam: description: 'The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for NAME is ascending. The NAME sort order is case sensitive. ' in: query name: sortBy required: false schema: type: string enum: - TIMECREATED - NAME default: TIMECREATED ListExadbVmClustersFilterByLifecycleStateQueryParam: description: 'A filter to return only Exadata VM clusters on Exascale Infrastructure that match the given lifecycle state exactly. ' in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/ExadbVmClusterSummary/lifecycleState' schema: type: string ListExecutionWindowsFilterByLifecycleStateQueryParam: description: A filter to return only resources that match the given lifecycle state exactly. in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/ExecutionWindowSummary/lifecycleState' schema: type: string OptionalAssociatedResourceIdQueryParam: description: The OCID of the VM cluster associated with the connection bundle. If the parameter is set to null, all bundles are returned. in: query name: associatedResourceId required: false x-default-description: The default value is null. schema: type: string maxLength: 255 minLength: 1 DbHomeIdQueryParam: description: A Database Home [OCID](/Content/General/Concepts/identifiers.htm). in: query name: dbHomeId required: false schema: type: string maxLength: 255 minLength: 1 AutonomousVirtualMachineIdPathParam: description: The Autonomous Virtual machine [OCID](/Content/General/Concepts/identifiers.htm). in: path name: autonomousVirtualMachineId required: true schema: type: string maxLength: 255 minLength: 1 ListGiMinorVersionsSortByQueryParam: description: Sort by VERSION. Default order for VERSION is descending. in: query name: sortBy required: false x-default-description: 'null' schema: type: string enum: - VERSION ListDatabaseSoftwareImagesFilterByImageShapeFamilyQueryParam: description: A filter to return only resources that match the given image shape family exactly. in: query name: imageShapeFamily required: false x-obmcs-enumref: '#/definitions/DatabaseSoftwareImageSummary/imageShapeFamily' schema: type: string ListExascaleDbStorageVaultsSortByQueryParam: description: 'The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. ' in: query name: sortBy required: false schema: type: string enum: - TIMECREATED - DISPLAYNAME default: TIMECREATED ListAutonomousDatabasesFilterByInfrastructureTypeQueryParam: description: A filter to return only resources that match the given Infrastructure Type. in: query name: infrastructureType required: false x-obmcs-enumref: '#/definitions/AutonomousDatabaseSummary/infrastructureType' schema: type: string ListExternalDatabaseConnectorsFilterByLifecycleStateQueryParam: description: A filter to return only resources that match the specified lifecycle state. in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/ExternalDatabaseConnector/lifecycleState' schema: type: string SortOrderQueryParam: description: The sort order to use, either ascending (`ASC`) or descending (`DESC`). in: query name: sortOrder required: false schema: type: string enum: - ASC - DESC default: ASC OptionalPeerAutonomousDatabaseIdQueryParam: description: The database OCID(/Content/General/Concepts/identifiers.htm) of the Disaster Recovery peer (source Primary) database, which is located in a different (remote) region from the current peer database. in: query name: peerDbId required: false schema: type: string maxLength: 255 minLength: 1 autonomousDatabaseIdPathParam: description: The database [OCID](/Content/General/Concepts/identifiers.htm). in: path name: autonomousDatabaseId required: true schema: type: string maxLength: 255 minLength: 1 VmClusterNetworkIdPathParam: description: The VM cluster network [OCID](/Content/General/Concepts/identifiers.htm). in: path name: vmClusterNetworkId required: true schema: type: string maxLength: 255 minLength: 1 AutonomousDatabaseSoftwareImageIdPathParam: description: The Autonomous AI Database Software Image [OCID](/Content/General/Concepts/identifiers.htm). in: path name: autonomousDatabaseSoftwareImageId required: true schema: type: string maxLength: 255 minLength: 1 ListAutonomousContainerDatabaseBackupsFilterByInfrastructureTypeQueryParam: description: A filter to return only resources that match the given Infrastructure Type. in: query name: infrastructureType required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/AutonomousContainerDatabaseBackupSummary/infrastructureType' schema: type: string default: null ListPluggableDatabasesSortByQueryParam: description: The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for PDBNAME is ascending. The PDBNAME sort order is case sensitive. in: query name: sortBy required: false schema: type: string enum: - PDBNAME - TIMECREATED default: TIMECREATED DbVersionQueryParam: description: A filter to return only DB Homes that match the specified dbVersion. in: query name: dbVersion required: false schema: type: string default: NONE maxLength: 255 minLength: 1 DbHomeIdPathParam: description: The Database Home [OCID](/Content/General/Concepts/identifiers.htm). in: path name: dbHomeId required: true schema: type: string maxLength: 255 minLength: 1 DbConnectionBundleIdPathParam: description: The OCID of the database connection bundle. in: path name: dbConnectionBundleId required: true schema: type: string maxLength: 255 minLength: 1 CloudVmClusterIdQueryParam: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud VM cluster associated with the application virtual IP (VIP) address. in: query name: cloudVmClusterId required: true schema: type: string maxLength: 255 minLength: 1 KeyStoreIdPathParam: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the key store. in: path name: keyStoreId required: true schema: type: string maxLength: 255 minLength: 1 OptionalShapeQueryParam: description: If provided, filters the results for the given shape. in: query name: shape required: false schema: type: string default: default maxLength: 255 minLength: 1 FilterByDbSystemUpgradeActionQueryParam: description: A filter to return only upgradeHistoryEntries that match the specified Upgrade Action. in: query name: upgradeAction required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/DbSystemUpgradeHistoryEntrySummary/action' schema: type: string ListDbConnectionBundlesFilterByLifecycleStateQueryParam: description: A filter that returns only resources that match the given lifecycle state. The state value is case-insensitive. in: query name: lifecycleState required: false x-default-description: The default value is null. schema: type: string enum: - CREATING - ACTIVE - INACTIVE - UPDATING - DELETING - DELETED - FAILED CloudAutonomousVmClusterIdPathParam: description: The Cloud VM cluster [OCID](/Content/General/Concepts/identifiers.htm). in: path name: cloudAutonomousVmClusterId required: true schema: type: string maxLength: 255 minLength: 1 ListExecutionWindowsSortByQueryParam: description: 'The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. ' in: query name: sortBy required: false schema: type: string enum: - TIMECREATED - DISPLAYNAME default: TIMECREATED ListSchedulingPlansSortByQueryParam: description: 'The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. ' in: query name: sortBy required: false schema: type: string enum: - TIMECREATED - DISPLAYNAME default: TIMECREATED ListAutonomousVmClustersSortByQueryParam: description: 'The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. ' in: query name: sortBy required: false schema: type: string enum: - TIMECREATED - DISPLAYNAME ListCloudVmClustersFilterByLifecycleStateQueryParam: description: A filter to return only cloud VM clusters that match the given lifecycle state exactly. in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/CloudVmClusterSummary/lifecycleState' schema: type: string ListPluggableDatabasesFilterByLifecycleStateQueryParam: description: A filter to return only resources that match the given lifecycle state exactly. in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/PluggableDatabaseSummary/lifecycleState' schema: type: string DatabaseEditionQueryParam: description: The database edition of quota (STANDARD_EDITION/ENTERPRISE_EDITION/ENTERPRISE_EDITION_HIGH_PERFORMANCE/ENTERPRISE_EDITION_EXTREME_PERFORMANCE/ENTERPRISE_EDITION_DEVELOPER) in: query name: databaseEdition required: false x-default-description: 'null' schema: type: string enum: - STANDARD_EDITION - ENTERPRISE_EDITION - ENTERPRISE_EDITION_HIGH_PERFORMANCE - ENTERPRISE_EDITION_EXTREME_PERFORMANCE - ENTERPRISE_EDITION_DEVELOPER resourcePoolLeaderIdParam: description: The database [OCID](/Content/General/Concepts/identifiers.htm) of the resourcepool Leader Autonomous AI Database. in: query name: resourcePoolLeaderId required: false x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 ListDbServersFilterByLifecycleStateQueryParam: description: A filter to return only resources that match the given lifecycle state exactly. in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/DbServerSummary/lifecycleState' schema: type: string AttachedShapeAttributesNotEqualToQueryParam: description: A filter to return only Exadata Database Storage Vaults which do not match the given attachedShapeAttributes in: query name: attachedShapeAttributesNotEqualTo required: false x-default-description: 'null' schema: type: string ExternalDatabaseConnectorIdQueryParam: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the external database connector resource (`ExternalDatabaseConnectorId`). ' in: query name: externalDatabaseConnectorId required: true schema: type: string maxLength: 255 minLength: 1 listAutonomousDatabasesFilterByLifecycleStateNotEqualToQueryParam: description: A filter to return only resources that not match the given lifecycle state. in: query name: lifecycleStateNotEqualTo required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/AutonomousDatabaseSummary/lifecycleState' schema: type: string default: null optionalautonomousDatabaseIdQueryParam: description: The database [OCID](/Content/General/Concepts/identifiers.htm). in: query name: autonomousDatabaseId required: false schema: type: string maxLength: 255 minLength: 1 refreshableCloneQueryParam: description: 'Filter on the value of the resource''s ''isRefreshableClone'' property. A value of `true` returns only refreshable clones. A value of `false` excludes refreshable clones from the returned results. Omitting this parameter returns both refreshable clones and databases that are not refreshable clones. ' in: query name: isRefreshableClone schema: type: boolean ListOneoffPatchesSortByQueryParam: description: 'The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. ' in: query name: sortBy required: false schema: type: string enum: - TIMECREATED - DISPLAYNAME GiMajorVersionPathParam: description: The Oracle Grid Infrastructure major version. in: path name: version required: true schema: type: string maxLength: 30 minLength: 1 ScheduledActionIdQueryParam: description: A filter to return only resources that match the given Scheduled Action id exactly. in: query name: id required: false x-default-description: Return only resources that match the given Scheduled Action id exactly. schema: type: string maxLength: 255 minLength: 1 ListDbConnectionBundlesSortByQueryParam: description: "The field to sort by. You can specify only one sort order. The default\norder for `TIMECREATED` is descending. The default order for `TIMEREFRESHED` \nis descending.\n" in: query name: sortBy required: false x-default-description: The default value is `TIMECREATED`. schema: type: string enum: - TIMECREATED - TIMEREFRESHED VmClusterCountLessThanOrEqualToQueryParam: description: A filter to return only Exadata Database Storage Vaults with associated Exadata VM Clusters less than or equal to the given count in: query name: vmClusterCountLessThanOrEqualTo required: false schema: type: integer minimum: 0 ConsoleHistoryIdPathParam: description: The OCID of the console history. in: path name: consoleHistoryId required: true schema: type: string DbnodeSnapshotIdPathParam: description: The Exadata Database Node Snapshot [OCID](/Content/General/Concepts/identifiers.htm). in: path name: dbnodeSnapshotId required: true schema: type: string maxLength: 255 minLength: 1 OptionalDatabaseSoftwareImageSupportedQueryParam: description: If true, filters the results to the set of Oracle Database versions that are supported for OCI database software images. in: query name: isDatabaseSoftwareImageSupported required: false x-default-description: 'null' schema: type: boolean ExecutionActionIdPathParam: description: The execution action [OCID](/Content/General/Concepts/identifiers.htm). in: path name: executionActionId required: true schema: type: string maxLength: 255 minLength: 1 ExternalContainerDatabaseIdPathParam: description: The ExternalContainerDatabase [OCID](/Content/General/Concepts/identifiers.htm). in: path name: externalContainerDatabaseId required: true schema: type: string maxLength: 255 minLength: 1 DbNodeIdPathParam: description: The database node [OCID](/Content/General/Concepts/identifiers.htm). in: path name: dbNodeId required: true schema: type: string maxLength: 255 minLength: 1 listAutonomousDatabasesSortByQueryParam: description: 'The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. **Note:** If you do not include the availability domain filter, the resources are grouped by availability domain, then sorted. ' in: query name: sortBy required: false schema: type: string enum: - TIMECREATED - DISPLAYNAME FilterByUpdateTypeVersionQueryParam: description: A filter to return only resources that match the given update version exactly. in: query name: version required: false x-default-description: Return resources with all the available update versions if not specified schema: type: string AutonomousVmClusterIdPathParam: description: The autonomous VM cluster [OCID](/Content/General/Concepts/identifiers.htm). in: path name: autonomousVmClusterId required: true schema: type: string maxLength: 255 minLength: 1 ListDbSystemsFilterByLifecycleStateQueryParam: description: A filter to return only resources that match the given lifecycle state exactly. in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/DbSystemSummary/lifecycleState' schema: type: string listAutonomousDbPreviewVersionSortByQueryParam: description: 'The field to sort by. You can provide one sort order (`sortOrder`). Default order for DBWORKLOAD is ascending. **Note:** If you do not include the availability domain filter, the resources are grouped by availability domain, then sorted. ' in: query name: sortBy required: false schema: type: string enum: - DBWORKLOAD OptionalDbServersQueryParam: description: The list of [OCIDs](/Content/General/Concepts/identifiers.htm) of the Db servers. in: query name: dbServers required: false x-default-description: 'null' style: form explode: true schema: type: array items: maxLength: 255 minLength: 1 type: string listAutonomousDatabasesFilterByLifecycleStateQueryParam: description: A filter to return only resources that match the given lifecycle state exactly. in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/AutonomousDatabaseSummary/lifecycleState' schema: type: string ServiceComponentQueryParam: description: The service component to use, either ADBD or EXACC. in: query name: serviceComponent required: true schema: type: string enum: - ADBD - EXACC ListBackupsFilterByLifecycleStateQueryParam: description: A filter to return only resources that match the given lifecycle state exactly. in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/BackupSummary/lifecycleState' schema: type: string isDedicatedQueryParam: description: 'Specifies if the request is for an Autonomous AI Database Dedicated instance. The default request is for an Autonomous AI Database Dedicated instance. ' in: query name: isDedicated x-default-description: 'null' schema: type: boolean ExternalContainerDatabaseIdQueryParam: description: The ExternalContainerDatabase [OCID](/Content/General/Concepts/identifiers.htm). in: query name: externalContainerDatabaseId required: false x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 ListExternalNonContainerDatabasesSortByQueryParam: description: 'The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. ' in: query name: sortBy required: false x-default-description: 'null' schema: type: string enum: - DISPLAYNAME - TIMECREATED ListDatabaseSoftwareImagesFilterByImageTypeQueryParam: description: A filter to return only resources that match the given image type exactly. in: query name: imageType required: false x-obmcs-enumref: '#/definitions/DatabaseSoftwareImageSummary/imageType' schema: type: string ListAutonomousContainerDatabasesFilterByInfrastructureTypeQueryParam: description: A filter to return only resources that match the given Infrastructure Type. in: query name: infrastructureType required: false x-obmcs-enumref: '#/definitions/AutonomousContainerDatabaseSummary/infrastructureType' schema: type: string AutonomousContainerDatabaseDataguardAssociationIdPathParam: description: The Autonomous Container Database-Autonomous Data Guard association [OCID](/Content/General/Concepts/identifiers.htm). in: path name: autonomousContainerDatabaseDataguardAssociationId required: true schema: type: string maxLength: 255 minLength: 1 StorageManagementQueryParam: description: 'The DB system storage management option. Used to list database versions available for that storage manager. Valid values are `ASM` and `LVM`. * ASM specifies Oracle Automatic Storage Management * LVM specifies logical volume manager, sometimes called logical disk manager. ' in: query name: storageManagement required: true x-obmcs-enumref: '#/definitions/DbSystemOptions/storageManagement' schema: type: string default: ASM ListPdbConversionHistoryEntriesSortByQueryParam: description: 'The field to sort by. You can provide one sort order (`sortOrder`). The default order for `TIMECREATED` is ascending. ' in: query name: sortBy required: false schema: type: string enum: - TIMESTARTED default: TIMESTARTED OptionalMaintenanceSubtypeQueryParam: description: The sub-type of the maintenance run. in: query name: maintenanceSubtype required: false x-obmcs-enumref: '#/definitions/MaintenanceRunSummary/maintenanceSubtype' schema: type: string UpgradeHistoryEntryIdPathParam: description: The database/db system upgrade History [OCID](/Content/General/Concepts/identifiers.htm). in: path name: upgradeHistoryEntryId required: true schema: type: string maxLength: 255 minLength: 1 SchedulingPlanIdPathParam: description: The Schedule Plan [OCID](/Content/General/Concepts/identifiers.htm). in: path name: schedulingPlanId required: true schema: type: string maxLength: 255 minLength: 1 DbServerIdPathParam: description: The DB server [OCID](/Content/General/Concepts/identifiers.htm). in: path name: dbServerId required: true schema: type: string maxLength: 255 minLength: 1 ListCloudVmClustersSortByQueryParam: description: 'The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. ' in: query name: sortBy required: false schema: type: string enum: - TIMECREATED - DISPLAYNAME ListDbSystemOsPatchHistoryEntriesSortByQueryParam: description: 'The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMESTARTED is descending. ' in: query name: sortBy required: false schema: type: string enum: - TIMESTARTED - ACTION default: TIMESTARTED listAutonomousDatabasesFilterByDbVersionQueryParam: description: A filter to return only Autonomous AI Database resources that match the specified dbVersion. in: query name: dbVersion required: false schema: type: string maxLength: 255 minLength: 1 ListVmClustersSortByQueryParam: description: 'The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. ' in: query name: sortBy required: false schema: type: string enum: - TIMECREATED - DISPLAYNAME ExternalDatabaseConnectorIdPathParam: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the external database connector resource (`ExternalDatabaseConnectorId`). ' in: path name: externalDatabaseConnectorId required: true schema: type: string maxLength: 255 minLength: 1 ListDbServersSortByQueryParam: description: Sort by TIMECREATED. Default order for TIMECREATED is descending. in: query name: sortBy required: false x-default-description: 'null' schema: type: string enum: - TIMECREATED ListAutonomousDatabaseSoftwareImagesSortByQueryParam: description: 'parameter according to which Autonomous AI Database Software Images will be sorted. ' in: query name: sortBy required: false schema: type: string enum: - TIMECREATED - DISPLAYNAME default: TIMECREATED CloudExadataInfrastructureIdPathParam: description: The cloud Exadata infrastructure [OCID](/Content/General/Concepts/identifiers.htm). in: path name: cloudExadataInfrastructureId required: true schema: type: string maxLength: 255 minLength: 1 optionalMaintenanceTypeQueryParam: description: The maintenance type. in: query name: maintenanceType required: false x-obmcs-enumref: '#/definitions/MaintenanceRunSummary/maintenanceType' schema: type: string ListSchedulingPoliciesFilterByLifecycleStateQueryParam: description: A filter to return only resources that match the given lifecycle state exactly. in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/SchedulingPolicySummary/lifecycleState' schema: type: string FilterByBackupDestinationIdQueryParam: description: A filter to return only resources that have the given backup destination id. in: query name: backupDestinationId required: false x-default-description: 'null' schema: type: string OneoffPatchIdPathParam: description: The one-off patch [OCID](/Content/General/Concepts/identifiers.htm). in: path name: oneoffPatchId required: true schema: type: string maxLength: 255 minLength: 1 ListConsoleHistoriesFilterByLifecycleStateQueryParam: description: A filter to return only resources that match the given lifecycle state exactly. in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/ConsoleHistorySummary/lifecycleState' schema: type: string ListDbNodesSortByQueryParam: description: Sort by TIMECREATED. Default order for TIMECREATED is descending. in: query name: sortBy required: false schema: type: string enum: - TIMECREATED FilterByUpgradeDbSystemLifecycleStateQueryParam: description: A filter to return only upgrade history entries that match the given lifecycle state exactly. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/DbSystemUpgradeHistoryEntrySummary/lifecycleState' schema: type: string ListDatabaseSoftwareImagesSortByQueryParam: description: 'The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. Default order for PATCHSET is descending. ' in: query name: sortBy required: false schema: type: string enum: - TIMECREATED - DISPLAYNAME - PATCHSET default: TIMECREATED BackupIdPathParam: description: The backup [OCID](/Content/General/Concepts/identifiers.htm). in: path name: backupId required: true schema: type: string maxLength: 255 minLength: 1 OptionalRequestId: description: 'Unique identifier for the request. ' in: header name: opc-request-id required: false schema: type: string AutonomousContainerDatabaseIdPathParam: description: The Autonomous Container Database [OCID](/Content/General/Concepts/identifiers.htm). in: path name: autonomousContainerDatabaseId required: true schema: type: string maxLength: 255 minLength: 1 AutonomousVmClusterIdQueryParam: description: The Autonomous Virtual machine [OCID](/Content/General/Concepts/identifiers.htm). in: query name: autonomousVmClusterId required: true schema: type: string maxLength: 255 minLength: 1 FilterByUpgradeLifecycleStateQueryParam: description: A filter to return only upgradeHistoryEntries that match the given lifecycle state exactly. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/DatabaseUpgradeHistoryEntrySummary/lifecycleState' schema: type: string isSharedQueryParam: description: 'Specifies whether this request is for an Autonomous AI Database Serverless instance. By default, this request will be for Autonomous AI Database on Dedicated Exadata Infrastructure. ' in: query name: isShared x-default-description: 'null' schema: type: boolean default: null AutonomousPatchTypeQueryParam: description: 'Autonomous patch type, either "QUARTERLY" or "TIMEZONE". ' in: query name: autonomousPatchType schema: type: string enum: - QUARTERLY - TIMEZONE default: QUARTERLY FilterByDisplayNameQueryParam: description: A filter to return only resources that match the entire display name given. The match is not case sensitive. in: query name: displayName required: false schema: type: string listMaintenanceRunsSortByQueryParam: description: 'The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIME_SCHEDULED and TIME_ENDED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. **Note:** If you do not include the availability domain filter, the resources are grouped by availability domain, then sorted. ' in: query name: sortBy required: false schema: type: string enum: - TIME_SCHEDULED - TIME_ENDED - DISPLAYNAME ListCloudAutonomousVmClustersSortByQueryParam: description: 'The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. ' in: query name: sortBy required: false schema: type: string enum: - TIMECREATED - DISPLAYNAME default: TIMECREATED DbSystemShapeParam: description: If provided, filters the results to the set of database versions which are supported for the given shape. in: query name: dbSystemShape required: false x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 isResourcePoolLeaderParam: description: 'Filter if the resource is the resource pool leader. A value of `true` returns only resource pool leader. ' in: query name: isResourcePoolLeader required: false x-default-description: 'null' schema: type: boolean optionalTargetResourceIdQueryParam: description: The target resource ID. in: query name: targetResourceId required: false schema: type: string maxLength: 255 minLength: 1 ListAutonomousExadataInfrastructuresFilterByLifecycleStateQueryParam: description: A filter to return only resources that match the given lifecycle state exactly. in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/AutonomousExadataInfrastructureSummary/lifecycleState' schema: type: string listAutonomousDatabasesRefreshableClonesSortByQueryParam: description: 'The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. **Note:** If you do not include the availability domain filter, the resources are grouped by availability domain, then sorted. ' in: query name: sortBy required: false schema: type: string enum: - NONE - TIMECREATED - DISPLAYNAME default: NONE ListApplicationVipsFilterByLifecycleStateQueryParam: description: A filter to return only resources that match the given lifecycle state exactly. in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/ApplicationVipSummary/lifecycleState' schema: type: string ListDbConnectionBundlesFilterByTypeQueryParam: description: A filter that returns only resources that match the specified database connection bundle type. in: query name: dbConnectionBundleType required: false x-default-description: The default value is null. schema: type: string enum: - TLS - MTLS listMaintenanceRunHistoryFilterByStateQueryParam: description: The state of the maintenance run history. in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/MaintenanceRunSummary/lifecycleState' schema: type: string FilterByUpgradeActionQueryParam: description: A filter to return only upgradeHistoryEntries that match the specified Upgrade Action. in: query name: upgradeAction required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/DatabaseUpgradeHistoryEntrySummary/action' schema: type: string ListExadataInfrastructuresFilterByLifecycleStateQueryParam: description: A filter to return only resources that match the given lifecycle state exactly. in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/ExadataInfrastructureSummary/lifecycleState' schema: type: string ListExadataInfrastructuresSortByQueryParam: description: 'The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. ' in: query name: sortBy required: false schema: type: string enum: - TIMECREATED - DISPLAYNAME FilterByDbNameQueryParam: description: A filter to return only resources that match the entire database name given. The match is not case sensitive. in: query name: dbName required: false schema: type: string FilterByAvailabilityDomainQueryParam: description: A filter to return only resources that match the given availability domain exactly. in: query name: availabilityDomain required: false schema: type: string ListSchedulingPlanByResourceIdQueryParam: description: A filter to return only resources that match the given resource id exactly. in: query name: resourceId required: false x-default-description: Return only resources that match the given resource id exactly. schema: type: string maxLength: 255 minLength: 1 DatabaseIdPathParam: description: The database [OCID](/Content/General/Concepts/identifiers.htm). in: path name: databaseId required: true schema: type: string maxLength: 255 minLength: 1 DatabaseSoftwareImageIdPathParam: description: The DB system [OCID](/Content/General/Concepts/identifiers.htm). in: path name: databaseSoftwareImageId required: true schema: type: string maxLength: 255 minLength: 1 ExascaleDbStorageVaultIdPathParam: description: The Exadata Database Storage Vault [OCID](/Content/General/Concepts/identifiers.htm). in: path name: exascaleDbStorageVaultId required: true schema: type: string maxLength: 255 minLength: 1 OptionalDbServerIdQueryParam: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exacc Db server. in: query name: dbServerId required: false schema: type: string maxLength: 255 minLength: 1 ListDbSystemOsPatchHistoryEntriesFilterByActionQueryParam: description: A filter to return only OS patch history entries that match the specified OS patch action. in: query name: action required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/DbSystemOsPatchHistoryEntrySummary/action' schema: type: string DbSystemIdPathParam: description: The DB system [OCID](/Content/General/Concepts/identifiers.htm). in: path name: dbSystemId required: true schema: type: string maxLength: 255 minLength: 1 FilterByServiceLevelAgreementTypeQueryParam: description: A filter to return only resources that match the given service-level agreement type exactly. in: query name: serviceLevelAgreementType required: false x-default-description: 'null' schema: type: string PluggableDatabaseSnapshotIdPathParam: description: The Exadata Pluggable Database Snapshot [OCID](/Content/General/Concepts/identifiers.htm). in: path name: pluggableDatabaseSnapshotId required: true schema: type: string maxLength: 255 minLength: 1 AttachedShapeAttributesQueryParam: description: A filter to return only Exadata Database Storage Vaults which match the given attachedShapeAttributes or has null attachedShapeAttributes in: query name: attachedShapeAttributes required: false x-default-description: 'null' schema: type: string ListExternalDatabaseConnectorsSortByQueryParam: description: 'The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. ' in: query name: sortBy required: false x-default-description: 'null' schema: type: string enum: - DISPLAYNAME - TIMECREATED BackupIdQueryParam: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the backup. Specify a backupId to list only the DB systems or DB homes that support creating a database using this backup in this compartment. in: query name: backupId required: false schema: type: string maxLength: 255 minLength: 1 ApplicationVipIdPathParam: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the application virtual IP (VIP) address. in: path name: applicationVipId required: true schema: type: string maxLength: 255 minLength: 1 SchedulingPlanIdQueryParam: description: A filter to return only resources that match the given Schedule Plan id exactly. in: query name: id required: false schema: type: string maxLength: 255 minLength: 1 listAutonomousContainerDatabaseBackupsSortByQueryParam: description: 'The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. **Note:** If you do not include the availability domain filter, the resources are grouped by availability domain, then sorted. ' in: query name: sortBy required: false x-default-description: 'null' schema: type: string enum: - TIMECREATED - DISPLAYNAME FilterByBackupTypeQueryParam: description: A filter to return only backups that matches with the given type of Backup. in: query name: type required: false x-default-description: 'null' schema: type: string FilterByDatabaseVersionQueryParam: description: A filter to return only resources that match the given database version. in: query name: version required: false x-default-description: 'null' schema: type: string BackupDestinationIdPathParam: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the backup destination. in: path name: backupDestinationId required: true schema: type: string maxLength: 255 minLength: 1 OptionalDatabaseIdQueryParam: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the database. in: query name: databaseId required: false schema: type: string ListExascaleDbStorageVaultsFilterByClusterPlacementGroupIdQueryParam: description: A filter to return only resources that match the given cluster placement group ID exactly. in: query name: clusterPlacementGroupId required: false schema: type: string OptionalExadataInfrastructureIdQueryParam: description: If provided, filters the results for the given Exadata Infrastructure. in: query name: exadataInfrastructureId required: false schema: type: string default: default maxLength: 255 minLength: 1 OptionalStorageManagementQueryParam: description: 'The DB system storage management option. Used to list database versions available for that storage manager. Valid values are `ASM` and `LVM`. * ASM specifies Oracle Automatic Storage Management * LVM specifies logical volume manager, sometimes called logical disk manager. ' in: query name: storageManagement required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/DbSystemOptions/storageManagement' schema: type: string InstanceIdPathParam: description: The Compute Instance [OCID](/Content/General/Concepts/identifiers.htm). in: path name: instanceId required: true schema: type: string maxLength: 255 minLength: 1 optionalTargetResourceTypeQueryParam: description: The type of the target resource. in: query name: targetResourceType required: false x-obmcs-enumref: '#/definitions/MaintenanceRunSummary/targetResourceType' schema: type: string SchedulingWindowIdPathParam: description: The Scheduling Window [OCID](/Content/General/Concepts/identifiers.htm). in: path name: schedulingWindowId required: true schema: type: string maxLength: 255 minLength: 1 ListAutonomousContainerDatabasesSortByQueryParam: description: 'The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. **Note:** If you do not include the availability domain filter, the resources are grouped by availability domain, then sorted. ' in: query name: sortBy required: false schema: type: string enum: - TIMECREATED - DISPLAYNAME PluggableDatabaseIdPathParam: description: The database [OCID](/Content/General/Concepts/identifiers.htm). in: path name: pluggableDatabaseId required: true schema: type: string maxLength: 255 minLength: 1 ListAutonomousDatabaseSoftwareImagesFilterByLifecycleStateQueryParam: description: A filter to return only resources that match the given lifecycle state exactly. in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/AutonomousDatabaseSoftwareImage/lifecycleState' schema: type: string SystemIdQueryParam: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata DB system that you want to filter the database results by. Applies only to Exadata DB systems. in: query name: systemId required: false schema: type: string maxLength: 255 minLength: 1 FilterByInfrastructureTypeQueryParam: description: A filter to return only resources that match the given Infrastructure Type. in: query name: infrastructureType required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/AutonomousDatabaseBackupSummary/infrastructureType' schema: type: string ListSchedulingPlansFilterByLifecycleStateQueryParam: description: A filter to return only resources that match the given lifecycle state exactly. in: query name: lifecycleState required: false x-default-description: Return only resources that match the given lifecycle state exactly. x-obmcs-enumref: '#/definitions/SchedulingPlanSummary/lifecycleState' schema: type: string autonomousDatabaseBackupIdPathParam: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Autonomous AI Database backup. in: path name: autonomousDatabaseBackupId required: true schema: type: string maxLength: 255 minLength: 1 PlanIntentQueryParam: description: The scheduling plan intent the scheduled actions will be for. in: query name: planIntent required: true schema: type: string enum: - EXADATA_INFRASTRUCTURE_FULL_SOFTWARE_UPDATE - EXADATA_INFRASTRUCTURE_SECURITY_UPDATE ListExternalContainerDatabasesFilterByLifecycleStateQueryParam: description: A filter to return only resources that match the specified lifecycle state. in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/ExternalDatabaseBase/lifecycleState' schema: type: string ListSchedulingPlansFilterByPlanIntentQueryParam: description: A filter to return only resources that match the given plan intent exactly. in: query name: planIntent required: false x-default-description: Return only resources that match the given plan intent exactly. schema: type: string enum: - EXADATA_INFRASTRUCTURE_FULL_SOFTWARE_UPDATE - EXADATA_INFRASTRUCTURE_SECURITY_UPDATE FilterByBackupDestinationType: description: A filter to return only resources that match the given backup destination type. in: query name: backupDestinationType required: false x-default-description: 'null' schema: type: string OptionalLatestQueryParam: description: If provided, return highest versions from each major version family. in: query name: isLatest required: false schema: type: boolean default: false FilterByKeyStoreIdQueryParam: description: A filter to return only resources that have the given key store id. in: query name: keyStoreId required: false x-default-description: 'null' schema: type: string PaginationLimitParam: description: The maximum number of items to return per page. in: query name: limit required: false schema: type: integer default: 10 maximum: 1000 minimum: 1 ExecutionWindowIdPathParam: description: The execution window [OCID](/Content/General/Concepts/identifiers.htm). in: path name: executionWindowId required: true schema: type: string maxLength: 255 minLength: 1 FilterByVmClusterUpdateTypeQueryParam: description: A filter to return only resources that match the given update type exactly. in: query name: updateType required: false schema: type: string enum: - GI_UPGRADE - GI_PATCH - OS_UPDATE OptionalCloudAutonomousVmClusterIdQueryParam: description: The cloud Autonomous VM Cluster [OCID](/Content/General/Concepts/identifiers.htm). in: query name: cloudAutonomousVmClusterId required: false x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 listAutonomousDatabaseBackupsFilterByLifecycleStateQueryParam: description: A filter to return only resources that match the given lifecycle state exactly. in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/AutonomousDatabaseBackupSummary/lifecycleState' schema: type: string ListExadbVmClustersFilterByExascaleDbStorageVaultIdQueryParam: description: 'A filter to return only Exadata VM clusters on Exascale Infrastructure that match the given Exascale Database Storage Vault ID. ' in: query name: exascaleDbStorageVaultId required: false schema: type: string maxLength: 255 minLength: 1 ListExternalDatabaseConnectorsExternalDatabaseIdQueryParam: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the external database whose connectors will be listed. ' in: query name: externalDatabaseId required: true schema: type: string maxLength: 255 minLength: 1 ListScheduledActionsFilterBySchedulingPlanIdQueryParam: description: A filter to return only resources that match the given scheduling policy id exactly. in: query name: schedulingPlanId required: false x-default-description: Return only resources that match the given scheduling policy id exactly. schema: type: string maxLength: 255 minLength: 1 ListAutonomousVmClustersFilterByLifecycleStateQueryParam: description: A filter to return only resources that match the given lifecycle state exactly. in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/AutonomousVmClusterSummary/lifecycleState' schema: type: string ListDatabasesSortByQueryParam: description: The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DBNAME is ascending. The DBNAME sort order is case sensitive. in: query name: sortBy required: false schema: type: string enum: - DBNAME - TIMECREATED ListVmClusterUpdatesFilterByLifecycleStateQueryParam: description: A filter to return only resources that match the given lifecycle state exactly. in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/VmClusterUpdateSummary/lifecycleState' schema: type: string ListDbNodesFilterByLifecycleStateQueryParam: description: A filter to return only resources that match the given lifecycle state exactly. in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/DbNodeSummary/lifecycleState' schema: type: string ListDbnodeSnapshotsFilterByLifecycleStateQueryParam: description: A filter to return only Exadata Database Snapshots that match the given lifecycle state exactly. in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/DbnodeSnapshot/lifecycleState' schema: type: string ListCloudExadataInfrastructuresFilterByLifecycleStateQueryParam: description: A filter to return only resources that match the given lifecycle state exactly. in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/CloudExadataInfrastructureSummary/lifecycleState' schema: type: string ListFlexComponentsSortByQueryParam: description: 'The field to sort by. You can provide one sort order (`sortOrder`). Default order for NAME is ascending. The NAME sort order is case sensitive. ' in: query name: sortBy required: false schema: type: string enum: - NAME ListAutonomousContainerDatabasesFilterByLifecycleStateQueryParam: description: A filter to return only resources that match the given lifecycle state exactly. in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/AutonomousContainerDatabaseSummary/lifecycleState' schema: type: string AutonomousExadataInfrastructureIdPathParam: description: The Autonomous Exadata Infrastructure [OCID](/Content/General/Concepts/identifiers.htm). in: path name: autonomousExadataInfrastructureId required: true schema: type: string maxLength: 255 minLength: 1 OptionalAutonomousVmClusterIdQueryParam: description: The Autonomous VM Cluster [OCID](/Content/General/Concepts/identifiers.htm). in: query name: autonomousVmClusterId required: false schema: type: string maxLength: 255 minLength: 1 ListSchedulingPoliciesFilterByCadenceQueryParam: description: A filter to return only resources that match the given cadence period exactly. in: query name: cadence required: false x-default-description: returns only resources that match the given cadence period exactly. x-obmcs-enumref: '#/definitions/SchedulingPolicySummary/cadence' schema: type: string ListDbSystemOsPatchHistoryEntriesFilterByLifecycleStateQueryParam: description: A filter to return only OS patch history entries that match the given lifecycle state exactly. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/DbSystemOsPatchHistoryEntrySummary/lifecycleState' schema: type: string ListExternalPluggableDatabasesFilterByLifecycleStateQueryParam: description: A filter to return only resources that match the specified lifecycle state. in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/ExternalDatabaseBase/lifecycleState' schema: type: string ExadataInfrastructureIdQueryParam: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the ExadataInfrastructure. in: query name: exadataInfrastructureId required: true schema: type: string maxLength: 255 minLength: 1 ListPluggableDatabaseSnapshotsFilterByClusterQueryParam: description: A filter to return only Exadata Database Node Snapshots that match the given VM cluster. in: query name: clusterId required: false schema: type: string FilterByDestinationTypeQueryParam: description: A filter to return only resources that match the given type of the Backup Destination. in: query name: type required: false schema: type: string ListScheduledActionsFilterByLifecycleStateQueryParam: description: A filter to return only resources that match the given lifecycle state exactly. in: query name: lifecycleState required: false x-default-description: Return only resources that match the given lifecycle state exactly. x-obmcs-enumref: '#/definitions/ScheduledActionSummary/lifecycleState' schema: type: string ListPluggableDatabaseSnapshotsFilterByDatabaseQueryParam: description: A filter to return only Exadata Pluggable Database Snapshots that match the given database [OCID](/Content/General/Concepts/identifiers.htm). in: query name: pluggableDatabaseId required: false schema: type: string OptionalAvailabilityDomainQueryParam: description: The name of the Availability Domain. in: query name: availabilityDomain required: false schema: type: string OptionalIsOnlineRestartQueryParam: description: If provided, an online restart will be triggered. in: query name: isOnlineRestart required: false schema: type: boolean default: false ListSchedulingWindowsSortByQueryParam: description: 'The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. ' in: query name: sortBy required: false schema: type: string enum: - TIMECREATED - DISPLAYNAME ListVmClusterNetworksSortByQueryParam: description: 'The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. ' in: query name: sortBy required: false schema: type: string enum: - TIMECREATED - DISPLAYNAME OptionalDatabaseUpgradeSupportedQueryParam: description: If provided, filters the results to the set of database versions which are supported for Upgrade. in: query name: isUpgradeSupported required: false x-default-description: 'null' schema: type: boolean TimeExpiryScheduledLessThan: description: The end of date-time range of expiration for the long term backups to be fetched. in: query name: timeExpiryScheduledLessThan required: false x-default-description: 'null' schema: type: string format: date-time ShapeAttributeQueryParam: description: If provided and applicable, return DB System shape parameters based on the shapeAttribute provided in: query name: shapeAttribute required: false x-default-description: 'null' schema: type: string ListExternalNonContainerDatabasesFilterByLifecycleStateQueryParam: description: A filter to return only resources that match the specified lifecycle state. in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/ExternalDatabaseBase/lifecycleState' schema: type: string ListExecutionActionsFilterByExecutionWindowIdQueryParam: description: A filter to return only resources that match the given execution wondow id. in: query name: executionWindowId required: false schema: type: string maxLength: 255 minLength: 1 ScheduledActionIdPathParam: description: The Scheduled Action [OCID](/Content/General/Concepts/identifiers.htm). in: path name: scheduledActionId required: true schema: type: string maxLength: 255 minLength: 1 ListExternalContainerDatabasesSortByQueryParam: description: 'The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. ' in: query name: sortBy required: false x-default-description: 'null' schema: type: string enum: - DISPLAYNAME - TIMECREATED CompartmentId: description: The compartment [OCID](/Content/General/Concepts/identifiers.htm). in: query name: compartmentId required: true schema: type: string maxLength: 255 minLength: 1 OptionalVmClusterIdQueryParam: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the VM cluster. in: query name: vmClusterId required: false schema: type: string maxLength: 255 minLength: 1 FilterByShapeQueryParam: description: A filter to return only resources that belong to the entire shape name given. The match is not case sensitive. in: query name: shape required: false x-default-description: 'null' schema: type: string RetryTokenHeader: 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 ExternalPluggableDatabaseIdPathParam: description: The ExternalPluggableDatabaseId [OCID](/Content/General/Concepts/identifiers.htm). in: path name: externalPluggableDatabaseId required: true schema: type: string maxLength: 255 minLength: 1 ListOneoffPatchesFilterByLifecycleStateQueryParam: description: A filter to return only resources that match the given lifecycle state exactly in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/OneoffPatchSummary/lifecycleState' schema: type: string GridInfrastructureVersionQueryParam: description: Specifies gi version query parameter. in: query name: giVersion required: true schema: type: string maxLength: 255 minLength: 1 OptionalDbSystemIdQueryParam: description: The DB system [OCID](/Content/General/Concepts/identifiers.htm). If provided, filters the results to the set of database versions which are supported for the DB system. in: query name: dbSystemId required: false schema: type: string maxLength: 255 minLength: 1 DbNodeActionQueryParam: description: The action to perform on the DB Node. in: query name: action required: true x-obmcs-inline-enum: false schema: type: string enum: - STOP - FORCESTOP - FORCERESET - START - SOFTRESET - RESET ListVmClusterNetworksFilterByLifecycleStateQueryParam: description: A filter to return only resources that match the given lifecycle state exactly. in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/VmClusterNetworkSummary/lifecycleState' schema: type: string ListAutonomousVirtualMachinesFilterByLifecycleStateQueryParam: description: A filter to return only resources that match the given lifecycle state exactly. in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/AutonomousVirtualMachineSummary/lifecycleState' schema: type: string OptionalExcludedFieldsQueryParam: description: If provided, the specified fields will be excluded in the response. in: query name: excludedFields x-default-description: 'null' style: form explode: true schema: type: array items: enum: - multiRackConfigurationFile type: string ExadbVmClusterIdPathParam: description: The Exadata VM cluster [OCID](/Content/General/Concepts/identifiers.htm) on Exascale Infrastructure. in: path name: exadbVmClusterId required: true schema: type: string maxLength: 255 minLength: 1 ListExecutionWindowsByResourceIdQueryParam: description: A filter to return only resources that match the given resource id exactly. in: query name: executionResourceId required: false x-default-description: Return only resources that match the given resource id exactly. schema: type: string maxLength: 255 minLength: 1 ListExascaleDbStorageVaultsFilterByLifecycleStateQueryParam: description: A filter to return only Exadata Database Storage Vaults that match the given lifecycle state exactly. in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/ExascaleDbStorageVault/lifecycleState' schema: type: string listAutonomousContainerDatabaseBackupsFilterByLifecycleStateQueryParam: description: A filter to return only resources that match the given lifecycle state exactly. in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/AutonomousContainerDatabaseBackupSummary/lifecycleState' schema: type: string ListExascaleDbStorageVaultsFilterByExadataInfrastructureIdQueryParam: description: A filter to return only list of Vaults that are linked to the exadata infrastructure Id. in: query name: exadataInfrastructureId required: false schema: type: string ListApplicationVipsSortByQueryParam: description: 'The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. ' in: query name: sortBy required: false x-default-description: 'null' schema: type: string enum: - DISPLAYNAME - TIMECREATED ListDatabaseSoftwareImagesFilterByLifecycleStateQueryParam: description: A filter to return only resources that match the given lifecycle state exactly. in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/DatabaseSoftwareImageSummary/lifecycleState' schema: type: string DbSystemOsPatchHistoryEntryIdParam: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the patch history entry. in: path name: osPatchHistoryEntryId required: true schema: type: string maxLength: 255 minLength: 1 IsGiVersionForProvisioningQueryParam: description: If true, returns the Grid Infrastructure versions that can be used for provisioning a cluster in: query name: isGiVersionForProvisioning schema: type: boolean default: false optionalAutonomousContainerDatabaseIdQueryParam: description: The Autonomous Container Database [OCID](/Content/General/Concepts/identifiers.htm). in: query name: autonomousContainerDatabaseId required: false schema: type: string maxLength: 255 minLength: 1 listMaintenanceRunsFilterByLocalAdgQueryParam: description: A filter to return the maintenance history results for the local standby Autonomous AI Database Serverless only. in: query name: isLocalAdg required: false schema: type: boolean default: false OptionalIsRemoteQueryParam: description: call for all remote backups in: query name: isRemote required: false schema: type: boolean default: false ListExadbVmClustersFilterByClusterPlacementGroupIdQueryParam: description: A filter to return only resources that match the given cluster placement group ID exactly. in: query name: clusterPlacementGroupId required: false schema: type: string listAutonomousDatabasesFilterByDbWorkloadQueryParam: description: A filter to return only Autonomous AI Database resources that match the specified workload type. in: query name: dbWorkload required: false x-obmcs-enumref: '#/definitions/AutonomousDatabaseSummary/dbWorkload' schema: type: string OptionalResourceIdQueryParam: description: If provided, filters the results for the specified resource Id. in: query name: resourceId required: false schema: type: string maxLength: 255 minLength: 1 PdbConversionHistoryEntryIdPathParam: description: The database conversion history [OCID](/Content/General/Concepts/identifiers.htm). in: path name: pdbConversionHistoryEntryId required: true schema: type: string maxLength: 255 minLength: 1 IsCpuAutoScaleQueryParam: description: If provided as true, cost estimate with cpu autoscaling. in: query name: isCpuAutoscale required: true schema: type: boolean default: false ListPluggableDatabaseSnapshotsSortByQueryParam: description: 'The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for NAME is ascending. The NAME sort order is case sensitive. ' in: query name: sortBy required: false schema: type: string enum: - TIMECREATED - NAME default: TIMECREATED schemas: MaintenanceRun: allOf: - $ref: '#/components/schemas/MaintenanceRunSummary' description: 'Details of a maintenance run. ' ModifyDatabaseManagementDetails: description: 'Data to update one or more attributes of the Database Management configuration for the database. ' properties: credentialDetails: $ref: '#/components/schemas/DatabaseCredentialDetails' managementType: default: BASIC description: The Database Management type. enum: - BASIC - ADVANCED type: string privateEndPointId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the private endpoint. ' maxLength: 255 minLength: 1 type: string serviceName: description: The name of the Oracle Database service that will be used to connect to the database. maxLength: 255 minLength: 1 type: string PatchHistoryEntry: allOf: - $ref: '#/components/schemas/PatchHistoryEntrySummary' AutonomousDatabaseConnectionUrls: description: 'The URLs for accessing Oracle Application Express (APEX) and SQL Developer Web with a browser from a Compute instance within your VCN or that has a direct connection to your VCN. Note that these URLs are provided by the console only for databases on [dedicated Exadata infrastructure](https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html). Example: `{"sqlDevWebUrl": "https:///ords...", "apexUrl", "https:///ords..."}` ' properties: apexUrl: description: Oracle Application Express (APEX) URL. maxLength: 512 minLength: 10 type: string databaseTransformsUrl: description: The URL of the Database Transforms for the Autonomous AI Database. maxLength: 512 minLength: 10 type: string graphStudioUrl: description: The URL of the Graph Studio for the Autonomous AI Database. maxLength: 512 minLength: 10 type: string machineLearningNotebookUrl: description: The URL of the Oracle Machine Learning (OML) Notebook for the Autonomous AI Database. maxLength: 512 minLength: 10 type: string machineLearningUserManagementUrl: description: Oracle Machine Learning user management URL. maxLength: 512 minLength: 10 type: string mongoDbUrl: description: The URL of the MongoDB API for the Autonomous AI Database. maxLength: 512 minLength: 10 type: string ordsUrl: description: The Oracle REST Data Services (ORDS) URL of the Web Access for the Autonomous AI Database. maxLength: 512 minLength: 10 type: string sqlDevWebUrl: description: Oracle SQL Developer Web URL. maxLength: 512 minLength: 10 type: string type: object ResourcePoolMemberCollection: description: A list of Autonomous AI Database resource pool member OCIDs. properties: items: description: List of resource pool member summary. items: $ref: '#/components/schemas/ResourcePoolMemberSummary' type: array required: - items ManagedSoftwareUpdateMaintenanceDetails: description: 'Provides details about actual Oracle Managed Database Software Updates scheduled time and version. ' properties: timeOfLastReadinessCheck: description: The date and time of the last readiness check. format: date-time type: string timeOfStatusUpdate: description: The date and time of when the status was updated. format: date-time type: string timeScheduled: description: The date and time of the database was scheduled for update. format: date-time type: string updateMode: description: 'Oracle Managed Database Software update method, either "ROLLING" or "NONROLLING" ' enum: - ROLLING - NONROLLING type: string updateReadinessStatus: description: The managed software update readiness status enum: - SCHEDULED - SUCCEEDED - READY_FOR_MANAGED_UPDATE - NOT_READY_FOR_MANAGED_UPDATE - IN_PROGRESS - NEEDS_ATTENTION - AWAITING_RESOLUTION type: string updateReadinessStatusDetails: description: This field will contain actual cause of update readiness state. type: string version: description: The version of the database was scheduled for update. type: string required: - timeScheduled - version ConsoleConnection: allOf: - $ref: '#/components/schemas/ConsoleConnectionSummary' ScanDetails: description: 'The Single Client Access Name (SCAN) details. ' properties: hostname: description: The SCAN hostname. type: string ips: description: The list of SCAN IP addresses. Three addresses should be provided. items: maxLength: 1024 minLength: 1 type: string maxItems: 3 type: array port: description: '**Deprecated.** This field is deprecated. You may use ''scanListenerPortTcp'' to specify the port. The SCAN TCPIP port. Default is 1521. ' type: integer required: - hostname - ips ChangeExadataInfrastructureCompartmentDetails: description: 'The configuration details for moving the resource. ' properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the resource to. ' maxLength: 255 minLength: 1 type: string required: - compartmentId AutonomousDatabaseKeyHistoryEntry: description: 'The Autonomous AI Database [Vault](/Content/KeyManagement/Concepts/keyoverview.htm#concepts) service key management history entry. ' properties: id: description: The id of the Autonomous AI Database [Vault](/Content/KeyManagement/Concepts/keyoverview.htm#concepts) service key management history entry. type: string kmsKeyVersionId: description: 'The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous AI Database Serverless does not use key versions, hence is not applicable for Autonomous AI Database Serverless instances. ' maxLength: 255 minLength: 1 type: string timeActivated: description: The date and time the kms key activated. format: date-time type: string vaultId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [vault](/Content/KeyManagement/Concepts/keyoverview.htm#concepts). This parameter and `secretId` are required for Customer Managed Keys. maxLength: 255 minLength: 1 type: string required: - id MigrateVaultKeyDetails: description: 'Details for replacing existing Oracle-managed keys with customer-managed [Vault service](/iaas/Content/KeyManagement/Concepts/keyoverview.htm) keys and vice-versa is not supported. ' properties: adminPassword: description: The existing admin password of the database. format: password maxLength: 255 minLength: 9 type: string x-default-description: 'null' kmsKeyId: description: The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. maxLength: 255 minLength: 1 type: string kmsKeyVersionId: description: 'The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous AI Database Serverless does not use key versions, hence is not applicable for Autonomous AI Database Serverless instances. ' maxLength: 255 minLength: 1 type: string tdeWalletPassword: description: The existing TDE wallet password of the database. format: password maxLength: 255 minLength: 8 type: string x-default-description: 'null' vaultId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [vault](/Content/KeyManagement/Concepts/keyoverview.htm#concepts). This parameter and `secretId` are required for Customer Managed Keys. maxLength: 255 minLength: 1 type: string required: - kmsKeyId SystemVersionCollection: description: Results of the System version lists. Contains SystemVersionSummary items. properties: items: description: List of System versions. items: $ref: '#/components/schemas/SystemVersionSummary' maxItems: 50 type: array required: - items DbSystemStoragePerformanceSummary: description: 'Representation of storage performance summary per shapeType . ' properties: dataStoragePerformanceList: description: List of storage performance for the DATA disks items: $ref: '#/components/schemas/StoragePerformanceDetails' type: array recoStoragePerformanceList: description: List of storage performance for the RECO disks items: $ref: '#/components/schemas/StoragePerformanceDetails' type: array shapeType: description: ShapeType of the DbSystems INTEL , AMD, INTEL_FLEX_X9 or AMPERE_FLEX_A1 enum: - AMD - INTEL - INTEL_FLEX_X9 - AMPERE_FLEX_A1 type: string required: - shapeType - dataStoragePerformanceList - recoStoragePerformanceList VolumeDetails: description: 'Details of the volume. ' properties: name: description: Volume Name maxLength: 255 minLength: 1 type: string size: description: Volume Size format: int32 type: integer required: - name type: object Month: description: Month of the year. properties: name: description: Name of the month of the year. enum: - JANUARY - FEBRUARY - MARCH - APRIL - MAY - JUNE - JULY - AUGUST - SEPTEMBER - OCTOBER - NOVEMBER - DECEMBER type: string required: - name type: object DbNode: allOf: - $ref: '#/components/schemas/DbNodeSummary' UpdateHistoryEntrySummary: description: 'The record of an maintenance update action on a specified cloud VM cluster. Applies to Exadata Cloud Service instances only. ' properties: id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the maintenance update history entry. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: 'Descriptive text providing additional details about the lifecycle state. ' type: string lifecycleState: description: The current lifecycle state of the maintenance update operation. enum: - IN_PROGRESS - SUCCEEDED - FAILED type: string timeCompleted: description: The date and time when the maintenance update action completed. format: date-time type: string timeStarted: description: The date and time when the maintenance update action started. format: date-time type: string updateAction: description: The update action. enum: - ROLLING_APPLY - NON_ROLLING_APPLY - PRECHECK - ROLLBACK type: string updateId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the maintenance update. maxLength: 255 minLength: 1 type: string updateType: description: The type of cloud VM cluster maintenance update. enum: - GI_UPGRADE - GI_PATCH - OS_UPDATE type: string required: - id - updateId - lifecycleState - timeStarted - updateType ManagedSoftwareUpdateDetails: description: 'The database registered for Oracle Managed Database Software Updates. ' properties: isEnrolled: description: 'If true, database is registered for Oracle Managed Database Software Updates otherwise database is not registered for Oracle Managed Database Software Updates ' type: boolean maintenanceDetails: $ref: '#/components/schemas/ManagedSoftwareUpdateMaintenanceDetails' preferenceDetails: $ref: '#/components/schemas/ManagedSoftwareUpdatePreferenceDetails' required: - isEnrolled AutonomousDatabaseStandbySummary: description: 'Autonomous Data Guard standby database details. ' properties: availabilityDomain: description: The availability domain of a local Autonomous Data Guard standby database of an Autonomous AI Database Serverless instance. maxLength: 255 minLength: 1 type: string lagTimeInSeconds: description: The amount of time, in seconds, that the data of the standby database lags the data of the primary database. Can be used to determine the potential data loss in the event of a failover. type: integer lifecycleDetails: description: Additional information about the current lifecycle state. type: string lifecycleState: description: The current state of the Autonomous AI Database. enum: - PROVISIONING - AVAILABLE - STOPPING - STOPPED - STARTING - TERMINATING - TERMINATED - UNAVAILABLE - RESTORE_IN_PROGRESS - RESTORE_FAILED - BACKUP_IN_PROGRESS - SCALE_IN_PROGRESS - AVAILABLE_NEEDS_ATTENTION - UPDATING - MAINTENANCE_IN_PROGRESS - RESTARTING - RECREATING - ROLE_CHANGE_IN_PROGRESS - UPGRADING - INACCESSIBLE - STANDBY - TRANSPORTING type: string maintenanceTargetComponent: description: The component chosen for maintenance. type: string timeDataGuardRoleChanged: description: The date and time the Autonomous Data Guard role was switched for the standby Autonomous AI Database. format: date-time type: string timeDisasterRecoveryRoleChanged: description: The date and time the Disaster Recovery role was switched for the standby Autonomous AI Database. format: date-time type: string timeMaintenanceBegin: description: The date and time when maintenance will begin. format: date-time type: string timeMaintenanceEnd: description: The date and time when maintenance will end. format: date-time type: string type: object ChangeSchedulingPolicyCompartmentDetails: description: 'The configuration details for moving the Scheduling Policy. ' properties: compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string required: - compartmentId AutonomousDatabasePeerSummary: description: 'The object holds details about a peer Autonomous AI Database for Oracle Autonomous AI Database. ' properties: id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Autonomous AI Database. maxLength: 255 minLength: 1 type: string region: description: The name of the region where this peer Autonomous AI Database clone exists. type: string required: - id type: object ExadbVmClusterUpdateSummary: description: 'A maintenance update details for an Exadata VM cluster on Exascale Infrastructure. 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: availableActions: description: The possible actions performed by the update operation on the infrastructure components. items: enum: - ROLLING_APPLY - NON_ROLLING_APPLY - PRECHECK - ROLLBACK type: string type: array description: description: Details of the maintenance update package. maxLength: 255 minLength: 1 type: string id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the maintenance update. maxLength: 255 minLength: 1 type: string lastAction: description: The previous update action performed. enum: - ROLLING_APPLY - NON_ROLLING_APPLY - PRECHECK - ROLLBACK type: string lifecycleDetails: description: 'Descriptive text providing additional details about the lifecycle state. ' type: string lifecycleState: description: The current state of the maintenance update. Dependent on value of `lastAction`. enum: - AVAILABLE - SUCCESS - IN_PROGRESS - FAILED type: string timeReleased: description: The date and time the maintenance update was released. format: date-time type: string updateType: description: The type of cloud VM cluster maintenance update. enum: - GI_UPGRADE - GI_PATCH - OS_UPDATE type: string version: description: The version of the maintenance update package. maxLength: 255 minLength: 1 type: string required: - id - description - version - timeReleased - updateType CreateCloudExadataInfrastructureDetails: description: 'Request to create cloud Exadata infrastructure. Applies to Exadata Cloud Service instances only. ' properties: availabilityDomain: description: The availability domain where the cloud Exadata infrastructure is located. maxLength: 255 minLength: 1 type: string clusterPlacementGroupId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cluster placement group of the Exadata Infrastructure. maxLength: 255 minLength: 1 type: string compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string computeCount: description: The number of compute servers for the cloud Exadata infrastructure. format: int32 type: integer customerContacts: description: Customer contacts. items: $ref: '#/components/schemas/CustomerContact' type: array x-default-description: 'null' databaseServerType: description: The database server type of the Exadata infrastructure. maxLength: 255 minLength: 1 type: string x-default-description: 'null' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object displayName: description: 'The user-friendly name for the cloud Exadata infrastructure resource. The name does not need to be unique. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object maintenanceVersionPreferences: $ref: '#/components/schemas/MaintenanceVersionPreferenceDetails' maintenanceWindow: $ref: '#/components/schemas/MaintenanceWindow' shape: description: 'The shape of the cloud Exadata infrastructure resource. ' maxLength: 255 minLength: 1 type: string storageCount: description: The number of storage servers for the cloud Exadata infrastructure. format: int32 type: integer storageServerType: description: The storage server type of the Exadata infrastructure. maxLength: 255 minLength: 1 type: string x-default-description: 'null' subscriptionId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the subscription with which resource needs to be associated with. maxLength: 255 minLength: 1 type: string required: - availabilityDomain - compartmentId - displayName - shape CreateBackupDestinationDetails: description: Details for creating a backup destination. discriminator: propertyName: type properties: compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object displayName: description: The user-provided name of the backup destination. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object type: description: Type of the backup destination. enum: - NFS - RECOVERY_APPLIANCE type: string required: - displayName - compartmentId - type AutonomousVmClusterResourceUsage: description: 'Autonomous VM Cluster usage details, including the Autonomous Container Databases usage. ' properties: autonomousDataStorageSizeInTBs: description: The data disk group size allocated for Autonomous Databases, in TBs. format: float type: number autonomousVmResourceUsage: description: List of autonomous vm cluster resource usages. items: $ref: '#/components/schemas/AutonomousVmResourceUsage' maxItems: 1024 type: array availableAutonomousDataStorageSizeInTBs: description: The data disk group size available for Autonomous Databases, in TBs. format: float type: number availableCpus: description: The number of CPU cores available. format: float type: number dbNodeStorageSizeInGBs: description: The local node storage allocated in GBs. type: integer displayName: description: The user-friendly name for the Autonomous VM cluster. The name does not need to be unique. type: string exadataStorageInTBs: description: Total exadata storage allocated for the Autonomous VM Cluster. DATA + RECOVERY + SPARSE + any overhead in TBs. format: double type: number id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Autonomous VM cluster. type: string isLocalBackupEnabled: description: If true, database backup on local Exadata storage is configured for the Autonomous VM cluster. If false, database backup on local Exadata storage is not available in the Autonomous VM cluster. type: boolean memoryPerOracleComputeUnitInGBs: description: 'The amount of memory (in GBs) to be enabled per each CPU core. ' type: integer memorySizeInGBs: description: The memory allocated in GBs. type: integer nonProvisionableAutonomousContainerDatabases: description: The number of non-provisionable Autonomous Container Databases in an Autonomous VM Cluster. type: integer provisionableAutonomousContainerDatabases: description: The number of provisionable Autonomous Container Databases in an Autonomous VM Cluster. type: integer provisionedAutonomousContainerDatabases: description: The number of provisioned Autonomous Container Databases in an Autonomous VM Cluster. type: integer provisionedCpus: description: The number of CPUs provisioned in an Autonomous VM Cluster. format: float type: number reclaimableCpus: description: 'CPU cores that continue to be included in the count of OCPUs available to the Autonomous Container Database even after one of its Autonomous Database is terminated or scaled down. You can release them to the available OCPUs at its parent AVMC level by restarting the Autonomous Container Database. ' format: float type: number reservedCpus: description: The number of CPUs reserved in an Autonomous VM Cluster. format: float type: number totalContainerDatabases: description: The total number of Autonomous Container Databases that can be created. type: integer totalCpus: description: The number of CPU cores enabled on the Autonomous VM cluster. format: float type: number usedAutonomousDataStorageSizeInTBs: description: The data disk group size used for Autonomous Databases, in TBs. format: float type: number usedCpus: description: The number of CPU cores alloted to the Autonomous Container Databases in an Autonomous VM cluster. format: float type: number required: - displayName AutonomousVmClusterSummary: description: 'Details of the Autonomous VM cluster. ' properties: autonomousDataStoragePercentage: description: The percentage of the data storage used for the Autonomous Databases in an Autonomous VM Cluster. format: float type: number autonomousDataStorageSizeInTBs: description: The data disk group size allocated for Autonomous Databases, in TBs. format: double type: number availableAutonomousDataStorageSizeInTBs: description: The data disk group size available for Autonomous Databases, in TBs. format: double minimum: 0 type: number availableContainerDatabases: description: The number of Autonomous Container Databases that can be created with the currently available local storage. minimum: 0 type: integer availableCpus: description: The numnber of CPU cores available. type: integer availableDataStorageSizeInTBs: description: '**Deprecated.** Use `availableAutonomousDataStorageSizeInTBs` for Autonomous Databases'' data storage availability in TBs. ' format: double type: number compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string computeModel: description: 'The compute model of the Autonomous VM Cluster. ECPU compute model is the recommended model and OCPU compute model is legacy. See [Compute Models in Autonomous Database on Dedicated Exadata #Infrastructure](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbak) for more details. ' enum: - ECPU - OCPU type: string cpuCoreCountPerNode: description: The number of CPU cores enabled per VM cluster node. type: integer cpuPercentage: description: The percentage of total number of CPUs used in an Autonomous VM Cluster. format: float type: number cpusEnabled: description: The number of enabled CPU cores. type: integer cpusLowestScaledValue: description: The lowest value to which cpus can be scaled down. format: int32 type: integer dataStorageSizeInGBs: description: The total data storage allocated in GBs. format: double minimum: 32 type: number dataStorageSizeInTBs: description: The total data storage allocated in TBs format: double type: number dbNodeStorageSizeInGBs: description: The local node storage allocated in GBs. type: integer dbServers: description: The list of [OCIDs](/Content/General/Concepts/identifiers.htm) of the Db servers. items: maxLength: 255 minLength: 1 type: string type: array definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object displayName: description: The user-friendly name for the Autonomous VM cluster. The name does not need to be unique. maxLength: 255 minLength: 1 type: string distributionAlgorithm: description: The distribution algorithm used for the Autonomous VM cluster. enum: - RESOURCE_OPTIMIZED - DISTRIBUTION_OPTIMIZED type: string exadataInfrastructureId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure. maxLength: 255 minLength: 1 type: string exadataStorageInTBsLowestScaledValue: description: The lowest value to which exadataStorage(in TBs) can be scaled down. format: double type: number freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Autonomous VM cluster. maxLength: 255 minLength: 1 type: string isLocalBackupEnabled: description: 'If true, database backup on local Exadata storage is configured for the Autonomous VM cluster. If false, database backup on local Exadata storage is not available in the Autonomous VM cluster. ' type: boolean isMtlsEnabled: default: false description: Enable mutual TLS(mTLS) authentication for database while provisioning a VMCluster. Default is TLS. type: boolean lastMaintenanceRunId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the last maintenance run. maxLength: 255 minLength: 1 type: string licenseModel: description: 'The Oracle license model that applies to the Autonomous VM cluster. The default is LICENSE_INCLUDED. ' enum: - LICENSE_INCLUDED - BRING_YOUR_OWN_LICENSE type: string lifecycleDetails: description: Additional information about the current lifecycle state. type: string lifecycleState: description: The current state of the Autonomous VM cluster. enum: - PROVISIONING - AVAILABLE - UPDATING - TERMINATING - TERMINATED - FAILED - MAINTENANCE_IN_PROGRESS type: string maintenanceWindow: $ref: '#/components/schemas/MaintenanceWindow' maxAcdsLowestScaledValue: description: The lowest value to which maximum number of ACDs can be scaled down. format: int32 type: integer memoryPerOracleComputeUnitInGBs: description: 'The amount of memory (in GBs) to be enabled per each CPU core. ' type: integer memorySizeInGBs: description: The memory allocated in GBs. type: integer nextMaintenanceRunId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the next maintenance run. maxLength: 255 minLength: 1 type: string nodeCount: description: 'The number of nodes in the Autonomous VM Cluster. ' format: int32 minimum: 1 type: integer nonProvisionableAutonomousContainerDatabases: description: The number of non-provisionable Autonomous Container Databases in an Autonomous VM Cluster. type: integer ocpusEnabled: description: The number of enabled OCPU cores. format: float minimum: 0.1 type: number provisionableAutonomousContainerDatabases: description: '**Deprecated.** Use field totalContainerDatabases. ' type: integer provisionedAutonomousContainerDatabases: description: The number of provisioned Autonomous Container Databases in an Autonomous VM Cluster. type: integer provisionedCpus: description: The number of CPUs provisioned in an Autonomous VM Cluster. format: float type: number reclaimableCpus: description: 'CPUs that continue to be included in the count of CPUs available to the Autonomous Container Database even after one of its Autonomous Database is terminated or scaled down. You can release them to the available CPUs at its parent Autonomous VM Cluster level by restarting the Autonomous Container Database. ' type: integer reservedCpus: description: The number of CPUs reserved in an Autonomous VM Cluster. format: float type: number scanListenerPortNonTls: description: The SCAN Listener Non TLS port number. Default value is 1521. maximum: 8999 minimum: 1024 type: integer scanListenerPortTls: description: The SCAN Listener TLS port number. Default value is 2484. maximum: 8999 minimum: 1024 type: integer sgaPercentage: description: Percentage of ECPU memory allocated for SGA(System Global Area). format: float type: number systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object timeCreated: description: The date and time that the Autonomous VM cluster was created. format: date-time type: string timeDatabaseSslCertificateExpires: description: The date and time of the Database SSL certificate expiration. format: date-time type: string timeOrdsCertificateExpires: description: The date and time of the ORDS certificate expiration. format: date-time type: string timeZone: description: The time zone to use for the Autonomous VM cluster. For details, see [DB System Time Zones](/Content/Database/References/timezones.htm). maxLength: 255 minLength: 1 type: string totalAutonomousDataStorageInTBs: description: The total data disk group size for Autonomous Databases, in TBs. format: float type: number totalContainerDatabases: description: The total number of Autonomous Container Databases that can be created. type: integer vmClusterNetworkId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the VM cluster network. maxLength: 255 minLength: 1 type: string required: - id - compartmentId - lifecycleState - displayName - exadataInfrastructureId - vmClusterNetworkId DbServer: allOf: - $ref: '#/components/schemas/DbServerSummary' description: 'Details of the Db server resource. ' AutonomousDatabaseBackupSummary: description: "An Autonomous AI Database backup.\nTo 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).\n \n**Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.\n" properties: autonomousDatabaseId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Autonomous AI Database. maxLength: 255 minLength: 1 type: string backupDestinationDetails: $ref: '#/components/schemas/BackupDestinationDetails' compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string databaseSizeInTBs: description: 'The size of the database in terabytes at the time the backup was taken. ' format: integer type: number dbVersion: description: 'A valid Oracle AI Database version for Autonomous AI Database. When you specify 23ai for dbversion, the system will provision a 23ai database, but the UI will display it as 26ai. When you specify 26ai for dbversion, the system will provision and display a 26ai database as expected. For new databases, it is recommended to use either 19c or 26ai. **Note** Starting December 2026, 23ai will not be supported as a valid value for this parameter. ' maxLength: 255 minLength: 1 type: string displayName: description: The user-friendly name for the backup. The name does not have to be unique. maxLength: 255 minLength: 1 type: string id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Autonomous AI Database backup. maxLength: 255 minLength: 1 type: string infrastructureType: description: The infrastructure type this resource belongs to. enum: - CLOUD - CLOUD_AT_CUSTOMER type: string isAutomatic: description: Indicates whether the backup is user-initiated or automatic. type: boolean isRestorable: default: true description: Indicates whether the backup can be used to restore the associated Autonomous AI Database. type: boolean keyStoreId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the key store of Oracle Vault. maxLength: 255 minLength: 1 type: string keyStoreWalletName: description: The wallet name for Oracle Key Vault. maxLength: 255 minLength: 1 type: string kmsKeyId: description: The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. maxLength: 255 minLength: 1 type: string kmsKeyVersionId: description: 'The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous AI Database Serverless does not use key versions, hence is not applicable for Autonomous AI Database Serverless instances. ' maxLength: 255 minLength: 1 type: string lifecycleDetails: description: Additional information about the current lifecycle state. type: string lifecycleState: description: The current state of the backup. enum: - CREATING - ACTIVE - DELETING - DELETED - FAILED - UPDATING type: string region: description: Name of the region in which backup is taken in. maxLength: 50 minLength: 1 type: string retentionPeriodInDays: description: Retention period, in days, for long-term backups maximum: 3650 minimum: 90 type: integer sizeInTBs: description: The backup size in terrabytes (TB). format: double type: number sourceDatabaseDetails: $ref: '#/components/schemas/SourceDatabaseDetails' timeAvailableTill: description: Timestamp until when the backup will be available format: date-time type: string timeEnded: description: The date and time the backup completed. format: date-time type: string timeStarted: description: The date and time the backup started. format: date-time type: string type: description: The type of backup. enum: - INCREMENTAL - FULL - LONGTERM - VIRTUAL_FULL - CUMULATIVE_INCREMENTAL - ROLL_FORWARD_IMAGE_COPY type: string vaultId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [vault](/Content/KeyManagement/Concepts/keyoverview.htm#concepts). This parameter and `secretId` are required for Customer Managed Keys. maxLength: 255 minLength: 1 type: string required: - id - compartmentId - lifecycleState - autonomousDatabaseId - displayName - type - isAutomatic UpdatePluggableDatabaseDetails: description: 'Details for updating a pluggable database (PDB). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object UnmountDbnodeSnapshotDetails: description: 'Details of the Exadata Database Node Snapshot to be unmounted. ' properties: dbNodeId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata Database Node where snapshot needs to be unmounted. maxLength: 255 minLength: 1 type: string required: - dbNodeId CreateAutonomousDatabaseBackupDetails: description: 'Details to create an Oracle Autonomous AI Database backup. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' properties: autonomousDatabaseId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Autonomous AI Database backup. maxLength: 255 minLength: 1 type: string backupDestinationDetails: $ref: '#/components/schemas/BackupDestinationDetails' displayName: description: The user-friendly name for the backup. The name does not have to be unique. maxLength: 255 minLength: 1 type: string isLongTermBackup: description: Indicates whether the backup is long-term type: boolean retentionPeriodInDays: description: Retention period, in days, for long-term backups maximum: 3650 minimum: 90 type: integer required: - autonomousDatabaseId DrScanDetails: description: 'The Single Client Access Name (SCAN) details for Disaster recovery network. ' properties: hostname: description: The Disaster recovery SCAN hostname. type: string ips: description: The list of Disaster recovery SCAN IP addresses. Three addresses should be provided. items: maxLength: 1024 minLength: 1 type: string maxItems: 3 type: array scanListenerPortTcp: description: The Disaster recovery SCAN TCPIP port. Default is 1521. maximum: 8999 minimum: 1024 type: integer required: - hostname - scanListenerPortTcp - ips CreateAutonomousContainerDatabaseDataguardAssociationDetails: description: 'Create Autonomous Dataguard Association to an existing Autonomous Container Database ' properties: fastStartFailOverLagLimitInSeconds: description: The lag time for my preference based on data loss tolerance in seconds. maximum: 3600 minimum: 5 type: integer isAutomaticFailoverEnabled: description: 'Indicates whether Automatic Failover is enabled for Autonomous Container Database Dataguard Association ' type: boolean peerAutonomousContainerDatabaseBackupConfig: $ref: '#/components/schemas/PeerAutonomousContainerDatabaseBackupConfig' peerAutonomousContainerDatabaseCompartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment where the standby Autonomous Container Database will be created. ' maxLength: 255 minLength: 1 type: string peerAutonomousContainerDatabaseDisplayName: description: The display name for the peer Autonomous Container Database. maxLength: 255 minLength: 1 type: string peerAutonomousVmClusterId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the peer Autonomous Exadata VM Cluster. maxLength: 255 minLength: 1 type: string peerCloudAutonomousVmClusterId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the peer cloud Autonomous Exadata VM Cluster. maxLength: 255 minLength: 1 type: string peerDbUniqueName: description: 'Specifies the `DB_UNIQUE_NAME` of the peer database to be created. ' maxLength: 32 minLength: 1 type: string protectionMode: description: 'The protection mode of this Autonomous Data Guard association. For more information, see [Oracle Data Guard Protection Modes](http://docs.oracle.com/database/122/SBYDB/oracle-data-guard-protection-modes.htm#SBYDB02000) in the Oracle Data Guard documentation. ' enum: - MAXIMUM_AVAILABILITY - MAXIMUM_PERFORMANCE type: string standbyMaintenanceBufferInDays: description: 'The scheduling detail for the quarterly maintenance window of the standby Autonomous Container Database. This value represents the number of days before scheduled maintenance of the primary database. ' maximum: 7 minimum: 1 type: integer required: - peerAutonomousContainerDatabaseDisplayName - protectionMode UpdateExecutionWindowDetails: description: 'Describes the modification parameters for the execution window. ' properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object isEnforcedDuration: default: false description: Indicates if duration the user plans to allocate for scheduling window is strictly enforced. The default value is `FALSE`. type: boolean timeScheduled: description: The scheduled start date and time of the execution window. format: date-time type: string windowDurationInMins: description: 'Duration window allows user to set a duration they plan to allocate for Scheduling window. The duration is in minutes. ' minimum: 120 type: integer UpdateCloudExadataInfrastructureDetails: description: 'Updates the cloud Exadata infrastructure. Applies to Exadata Cloud Service instances only. ' properties: computeCount: description: The number of compute servers for the cloud Exadata infrastructure. format: int32 type: integer customerContacts: description: Customer contacts. Setting this to an empty list removes all customer contact information (email addresses) for the specified OCI Database service resource. items: $ref: '#/components/schemas/CustomerContact' type: array x-default-description: 'null' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object displayName: description: 'The user-friendly name for the cloud Exadata infrastructure. The name does not need to be unique. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object maintenanceVersionPreferences: $ref: '#/components/schemas/MaintenanceVersionPreferenceDetails' maintenanceWindow: $ref: '#/components/schemas/MaintenanceWindow' storageCount: description: The number of storage servers for the cloud Exadata infrastructure. format: int32 type: integer MountDbnodeSnapshotDetails: description: 'Details of the Exadata Database Node Snapshot to be mounted. ' properties: dbNodeId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata Database Node where snapshot needs to be mounted. maxLength: 255 minLength: 1 type: string required: - dbNodeId KeyStoreSummary: description: 'Details of the Key Store. ' properties: associatedDatabases: description: List of databases associated with the key store. items: $ref: '#/components/schemas/KeyStoreAssociatedDatabaseDetails' type: array associatedLongTermBackupCount: description: Indicates the number of long term backups of Autonomous AI Databases associated with this backup destination. type: integer associatedLongTermBackups: description: List of long term backups of Autonomous AI Databases associated with this backup destination.The maximum associated number of long term backup listed here would be 1024. items: $ref: '#/components/schemas/AssociatedLongTermBackup' maxItems: 1024 minItems: 0 type: array compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object displayName: description: The user-friendly name for the key store. The name does not need to be unique. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the key store. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: Additional information about the current lifecycle state. type: string lifecycleState: description: The current state of the key store. enum: - ACTIVE - DELETED type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object timeCreated: description: The date and time that the key store was created. format: date-time type: string typeDetails: $ref: '#/components/schemas/KeyStoreTypeDetails' required: - id - compartmentId - lifecycleState - displayName - typeDetails UpdateAutonomousExadataInfrastructureDetails: description: 'Describes the modification parameters for the Autonomous Exadata Infrastructure. ' properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object displayName: description: The display name is a user-friendly name for the Autonomous Exadata Infrastructure. The display name does not have to be unique. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object maintenanceWindowDetails: $ref: '#/components/schemas/MaintenanceWindow' nsgIds: description: 'The list of [OCIDs](/Content/General/Concepts/identifiers.htm) for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see [Security Rules](/Content/Network/Concepts/securityrules.htm). ' items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array uniqueItems: true EnableExternalNonContainerDatabaseDatabaseManagementDetails: allOf: - $ref: '#/components/schemas/EnableExternalDatabaseManagementDetailsBase' - properties: licenseModel: description: 'The Oracle license model that applies to the external database. ' enum: - LICENSE_INCLUDED - BRING_YOUR_OWN_LICENSE type: string required: - licenseModel type: object description: 'Details to enable Database Management on an external non-container database. ' AssociatedResourceDetails: description: Details about the resources associated with the connection bundle. properties: resourceIds: description: The OCIDs of the associated resources. items: maxLength: 255 minLength: 1 type: string type: array required: - resourceIds type: object AutonomousDatabaseSoftwareImage: description: 'Autonomous AI Database Software Images created from Autonomous Container Database ' properties: autonomousDsiOneOffPatches: description: One-off patches included in the Autonomous AI Database Software Image items: type: string type: array compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string databaseVersion: description: The database version with which the Autonomous AI Database Software Image is to be built. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object displayName: description: The user-friendly name for the Autonomous AI Database Software Image. The name does not have to be unique. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Autonomous AI Database Software Image. maxLength: 255 minLength: 1 type: string imageShapeFamily: description: To what shape the image is meant for. enum: - EXACC_SHAPE - EXADATA_SHAPE type: string lifecycleDetails: description: Detailed message for the lifecycle state. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of the Autonomous AI Database Software Image. enum: - AVAILABLE - FAILED - PROVISIONING - EXPIRED - TERMINATED - TERMINATING - UPDATING type: string releaseUpdate: description: The Release Updates. maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object timeCreated: description: The date and time the Autonomous AI Database Software Image was created. format: date-time type: string required: - id - compartmentId - lifecycleState - displayName - timeCreated - releaseUpdate - databaseVersion - imageShapeFamily VmClusterNetwork: allOf: - $ref: '#/components/schemas/VmClusterNetworkSummary' description: The VM cluster network. CloudAutonomousVmClusterResourceUsage: description: 'Cloud Autonomous VM Cluster usage details, including the Autonomous Container Databases usage. ' properties: autonomousDataStorageSizeInTBs: description: The data disk group size allocated for Autonomous AI Databases, in TBs. format: float type: number autonomousVmResourceUsage: description: List of Autonomous VM resource usages. items: $ref: '#/components/schemas/AutonomousVmResourceUsage' maxItems: 1024 type: array availableAutonomousDataStorageSizeInTBs: description: The data disk group size available for Autonomous AI Databases, in TBs. format: float type: number availableCpus: description: The number of CPU cores available. format: float type: number dbNodeStorageSizeInGBs: description: The local node storage allocated in GBs. type: integer displayName: description: The user-friendly name for the Autonomous VM cluster. The name does not need to be unique. type: string exadataStorageInTBs: description: Total exadata storage allocated for the Autonomous VM Cluster. DATA + RECOVERY + SPARSE + any overhead in TBs. format: double type: number id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Cloud Autonomous VM cluster. type: string memoryPerOracleComputeUnitInGBs: description: 'The amount of memory (in GBs) to be enabled per each CPU core. ' type: integer memorySizeInGBs: description: The memory allocated in GBs. type: integer nonProvisionableAutonomousContainerDatabases: description: The number of non-provisionable Autonomous Container Databases in an Autonomous VM Cluster. type: integer provisionableAutonomousContainerDatabases: description: The number of provisionable Autonomous Container Databases in an Autonomous VM Cluster. type: integer provisionedAutonomousContainerDatabases: description: The number of provisioned Autonomous Container Databases in an Autonomous VM Cluster. type: integer provisionedCpus: description: The number of CPUs provisioned in an Autonomous VM Cluster. format: float type: number reclaimableCpus: description: 'CPU cores that continue to be included in the count of OCPUs available to the Autonomous Container Database even after one of its Autonomous AI Database is terminated or scaled down. You can release them to the available OCPUs at its parent AVMC level by restarting the Autonomous Container Database. ' format: float type: number reservedCpus: description: The number of CPUs reserved in an Autonomous VM Cluster. format: float type: number totalContainerDatabases: description: The total number of Autonomous Container Databases that can be created. type: integer totalCpus: description: The number of CPU cores enabled on the Cloud Autonomous VM cluster. format: float type: number usedAutonomousDataStorageSizeInTBs: description: The data disk group size used for Autonomous AI Databases, in TBs. format: float type: number usedCpus: description: 'The number of CPU cores alloted to the Autonomous Container Databases in an Cloud Autonomous VM cluster. ' format: float type: number required: - displayName InfoForNetworkGenDetails: description: 'Parameters for generation of the client or backup network in a VM cluster network in an Exadata Cloud@Customer system. ' properties: cidr: description: The cidr for the network. maxLength: 255 minLength: 1 type: string domain: description: The network domain name. maxLength: 255 minLength: 1 type: string gateway: description: The network gateway. maxLength: 255 minLength: 1 type: string netmask: description: The network netmask. maxLength: 255 minLength: 1 type: string networkType: description: The network type. enum: - CLIENT - BACKUP - DISASTER_RECOVERY type: string prefix: description: The network domain name. maxLength: 255 minLength: 1 type: string vlanId: description: The network VLAN ID. maxLength: 255 minLength: 1 type: string required: - networkType - vlanId - cidr - gateway - netmask - domain - prefix dbIormConfig: description: 'The IORM configuration settings for the database. ' properties: dbName: description: 'The database name. For the default `DbPlan`, the `dbName` is `default`. ' type: string flashCacheLimit: description: 'The flash cache limit for this database. This value is internally configured based on the share value assigned to the database. ' type: string share: description: 'The relative priority of this database. ' maximum: 32 minimum: 1 type: integer type: object AvmAcdResourceStats: description: Associated autonomous container databases usages. properties: availableCpus: description: The number of CPU cores available. format: float type: number displayName: description: The user-friendly name for the Autonomous Container Database. The name does not need to be unique. type: string id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Autonomous Container Database. type: string provisionedCpus: description: CPUs/cores assigned to Autonomous AI Databases in the ACD instances. format: float type: number reclaimableCpus: description: 'CPUs/cores that continue to be included in the count of OCPUs available to the Autonomous Container Database even after one of its Autonomous AI Database is terminated or scaled down. You can release them to the available OCPUs at its parent AVMC level by restarting the Autonomous Container Database. ' format: float type: number reservedCpus: description: 'CPUs/cores reserved for scalability, resilliency and other overheads. This includes failover, autoscaling and idle instance overhead. ' format: float type: number usedCpus: description: 'CPUs/cores assigned to the ACD instance. Sum of provisioned, reserved and reclaimable CPUs/ cores to the ACD instance. ' format: float type: number required: - displayName AutonomousContainerDatabaseSummary: description: 'An Autonomous Container Database is a container database service that enables the customer to host one or more databases within the container database. A basic container database runs on a single Autonomous Exadata Infrastructure from an availability domain without the Extreme Availability features enabled. ' properties: associatedBackupConfigurationDetails: description: A backup config object holds information about preferred backup destinations only. This object holds information about the associated backup destinations, such as secondary backup destinations created for local backups or remote replicated backups. items: $ref: '#/components/schemas/BackupDestinationConfigurationSummary' type: array autonomousExadataInfrastructureId: description: '**No longer used.** For Autonomous AI Database on dedicated Exadata infrastructure, the container database is created within a specified `cloudAutonomousVmCluster`. ' maxLength: 255 minLength: 1 type: string autonomousVmClusterId: description: The OCID of the Autonomous VM Cluster. maxLength: 255 minLength: 1 type: string availabilityDomain: description: The availability domain of the Autonomous Container Database. maxLength: 255 minLength: 1 type: string availableCpus: description: 'Sum of CPUs available on the Autonomous VM Cluster + Sum of reclaimable CPUs available in the Autonomous Container Database. ' format: float type: number backupConfig: $ref: '#/components/schemas/AutonomousContainerDatabaseBackupConfig' backupDestinationPropertiesList: description: This list describes the backup destination properties associated with the Autonomous Container Database (ACD) 's preferred backup destination. The object at a given index is associated with the destination present at the same index in the backup destination details list of the ACD Backup Configuration. items: $ref: '#/components/schemas/BackupDestinationProperties' type: array cloudAutonomousVmClusterId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud Autonomous Exadata VM Cluster. maxLength: 255 minLength: 1 type: string compartmentId: description: The OCID of the compartment. maxLength: 255 minLength: 1 type: string computeModel: description: 'The compute model of the Autonomous Container Database. For Autonomous AI Database on Dedicated Exadata Infrastructure, the CPU type (ECPUs or OCPUs) is determined by the parent Autonomous Exadata VM Cluster''s compute model. ECPU compute model is the recommended model and OCPU compute model is legacy. See [Compute Models in Autonomous AI Database on Dedicated Exadata Infrastructure](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbak) for more details. ' enum: - ECPU - OCPU type: string customerContacts: description: 'Customer Contacts. Setting this to an empty list removes all customer contacts. ' items: $ref: '#/components/schemas/CustomerContact' type: array dataguard: $ref: '#/components/schemas/AutonomousContainerDatabaseDataguard' dataguardGroupMembers: description: Array of Dg associations. items: $ref: '#/components/schemas/AutonomousContainerDatabaseDataguard' type: array dbName: description: The Database name for the Autonomous Container Database. The name must be unique within the Cloud Autonomous VM Cluster, starting with an alphabetic character, followed by 1 to 7 alphanumeric characters. maxLength: 8 minLength: 2 type: string dbSplitThreshold: description: The CPU value beyond which an Autonomous AI Database will be opened across multiple nodes. The default value of this attribute is 16 for OCPUs and 64 for ECPUs. type: integer dbUniqueName: description: '**Deprecated.** The `DB_UNIQUE_NAME` value is set by Oracle Cloud Infrastructure. Do not specify a value for this parameter. Specifying a value for this field will cause Terraform operations to fail. ' maxLength: 32 minLength: 1 type: string dbVersion: description: Oracle AI Database version of the Autonomous Container Database. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object displayName: description: The user-provided name for the Autonomous Container Database. maxLength: 255 minLength: 1 type: string distributionAffinity: description: Determines whether an Autonomous AI Database must be opened across the maximum number of nodes or the least number of nodes. By default, Minimum nodes is selected. enum: - MINIMUM_DISTRIBUTION - MAXIMUM_DISTRIBUTION type: string dstFileVersion: description: DST Time-Zone File version of the Autonomous Container Database. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the Autonomous Container Database. maxLength: 255 minLength: 1 type: string infrastructureType: description: The infrastructure type this resource belongs to. enum: - CLOUD - CLOUD_AT_CUSTOMER type: string isDataGuardEnabled: description: '**Deprecated.** Indicates whether the Autonomous AI Database has local (in-region) Data Guard enabled. Not applicable to cross-region Autonomous Data Guard associations, or to Autonomous AI Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure. ' type: boolean isDstFileUpdateEnabled: description: Indicates if an automatic DST Time Zone file update is enabled for the Autonomous Container Database. If enabled along with Release Update, patching will be done in a Non-Rolling manner. type: boolean isMultipleStandby: description: 'Indicates if it is multiple standby Autonomous Dataguard ' type: boolean keyHistoryEntry: description: Key History Entry. items: $ref: '#/components/schemas/AutonomousDatabaseKeyHistoryEntry' type: array keyStoreId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the key store of Oracle Vault. maxLength: 255 minLength: 1 type: string keyStoreWalletName: description: The wallet name for Oracle Key Vault. maxLength: 255 minLength: 1 type: string kmsKeyId: description: The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. maxLength: 255 minLength: 1 type: string kmsKeyVersionId: description: 'The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous AI Database Serverless does not use key versions, hence is not applicable for Autonomous AI Database Serverless instances. ' maxLength: 255 minLength: 1 type: string largestProvisionableAutonomousDatabaseInCpus: description: The largest Autonomous AI Database (CPU) that can be created in a new Autonomous Container Database. format: float type: number lastMaintenanceRunId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the last maintenance run. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: Additional information about the current lifecycle state. type: string lifecycleState: description: The current state of the Autonomous Container Database. enum: - PROVISIONING - AVAILABLE - UPDATING - TERMINATING - TERMINATED - FAILED - BACKUP_IN_PROGRESS - RESTORING - RESTORE_FAILED - RESTARTING - MAINTENANCE_IN_PROGRESS - ROLE_CHANGE_IN_PROGRESS - ENABLING_AUTONOMOUS_DATA_GUARD - UNAVAILABLE type: string listOneOffPatches: description: List of One-Off patches that has been successfully applied to Autonomous Container Database items: type: string type: array maintenanceWindow: $ref: '#/components/schemas/MaintenanceWindow' memoryPerOracleComputeUnitInGBs: description: 'The amount of memory (in GBs) enabled per ECPU or OCPU in the Autonomous VM Cluster. ' type: integer netServicesArchitecture: default: DEDICATED description: Enabling SHARED server architecture enables a database server to allow many client processes to share very few server processes, thereby increasing the number of supported users. enum: - DEDICATED - SHARED - DRCP type: string nextMaintenanceRunId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the next maintenance run. maxLength: 255 minLength: 1 type: string okvEndPointGroupName: description: 'The OKV End Point Group name for the Autonomous Container Database. ' maxLength: 128 minLength: 1 type: string patchId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the last patch applied on the system. maxLength: 255 minLength: 1 type: string patchModel: description: Database patch model preference. enum: - RELEASE_UPDATES - RELEASE_UPDATE_REVISIONS type: string provisionableCpus: description: 'An array of CPU values that can be used to successfully provision a single Autonomous AI Database. ' items: format: float type: number type: array provisionedCpus: description: The number of CPUs provisioned in an Autonomous Container Database. format: float type: number reclaimableCpus: description: 'CPUs that continue to be included in the count of CPUs available to the Autonomous Container Database even after one of its Autonomous AI Database is terminated or scaled down. You can release them to the available CPUs at its parent Autonomous VM Cluster level by restarting the Autonomous Container Database. ' format: float type: number recoveryApplianceDetails: $ref: '#/components/schemas/RecoveryApplianceDetails' reservedCpus: description: The number of CPUs reserved in an Autonomous Container Database. format: float type: number role: description: 'The Data Guard role of the Autonomous Container Database or Autonomous AI Database, if Autonomous Data Guard is enabled. ' enum: - PRIMARY - STANDBY - DISABLED_STANDBY - BACKUP_COPY - SNAPSHOT_STANDBY type: string serviceLevelAgreementType: description: The service level agreement type of the container database. The default is STANDARD. enum: - STANDARD - MISSION_CRITICAL - AUTONOMOUS_DATAGUARD type: string standbyMaintenanceBufferInDays: description: 'The scheduling detail for the quarterly maintenance window of the standby Autonomous Container Database. This value represents the number of days before scheduled maintenance of the primary database. ' maximum: 7 minimum: 1 type: integer systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object timeCreated: description: The date and time the Autonomous Container Database was created. format: date-time type: string timeOfLastBackup: description: The timestamp of last successful backup. Here NULL value represents either there are no successful backups or backups are not configured for this Autonomous Container Database. format: date-time type: string timeSnapshotStandbyRevert: description: The date and time the Autonomous Container Database will be reverted to Standby from Snapshot Standby. format: date-time type: string totalCpus: description: 'The number of CPUs allocated to the Autonomous VM cluster. ' type: integer vaultId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [vault](/Content/KeyManagement/Concepts/keyoverview.htm#concepts). This parameter and `secretId` are required for Customer Managed Keys. maxLength: 255 minLength: 1 type: string versionPreference: default: NEXT_RELEASE_UPDATE description: 'The next maintenance version preference. ' enum: - NEXT_RELEASE_UPDATE - LATEST_RELEASE_UPDATE type: string vmFailoverReservation: description: The percentage of CPUs reserved across nodes to support node failover. Allowed values are 0%, 25%, 50%, 75%, and 100%, with 50% being the default option. type: integer required: - id - compartmentId - lifecycleState - displayName - serviceLevelAgreementType - patchModel type: object ExadbVmClusterStorageDetails: description: 'Storage Details on the Exadata VM cluster. ' properties: totalSizeInGbs: description: 'Total Capacity ' format: int32 type: integer required: - totalSizeInGbs GranularMaintenanceHistoryDetails: description: Details of a granular maintenance history. properties: executionActions: description: The list of execution actions for this granular maintenance history. items: $ref: '#/components/schemas/ExecutionAction' type: array executionWindow: $ref: '#/components/schemas/ExecutionWindow' required: - executionWindow - executionActions type: object DbSystemUpgradeSummary: description: 'It describes the various upgrade properties such as component, osversion, giversion for any VM DB system. ' properties: component: description: The component on which upgrade is applicable. OS (Operating System upgrade), GI (Grid Infrastructure upgrade) or OS_GI (both Operating System and Grid Infrastructure upgrade) enum: - OS - OS_GI - GI type: string giVersion: description: The version of the grid infrastructure for this upgrade. This is only applicable for ASM based DbSystems type: string osVersion: description: The version of the OS for this upgrade eg. Oracle Linux Server release 7.9 type: string required: - component DatabaseStorageSizeResponseDetails: description: 'The database storage size details. This database option is supported for the Exadata VM cluster on Exascale Infrastructure. ' properties: dataStorageSizeInGBs: description: 'The DATA storage size, in gigabytes, that is applicable for the database. ' type: integer recoStorageSizeInGBs: description: 'The RECO storage size, in gigabytes, that is applicable for the database. ' type: integer redoLogStorageSizeInGBs: description: 'The REDO Log storage size, in gigabytes, that is applicable for the database. ' type: integer required: - dataStorageSizeInGBs - recoStorageSizeInGBs - redoLogStorageSizeInGBs ExadataIormConfigUpdateDetails: description: 'IORM Setting details for this Exadata System to be updated ' properties: dbPlans: description: 'Array of IORM Setting for all the database in this Exadata DB System ' items: $ref: '#/components/schemas/dbIormConfigUpdateDetail' type: array objective: description: 'Value for the IORM objective Default is "Auto" ' enum: - LOW_LATENCY - HIGH_THROUGHPUT - BALANCED - AUTO - BASIC type: string type: object EnableExternalDatabaseStackMonitoringDetailsBase: description: Details to enable Stack Monitoring on the external database. properties: externalDatabaseConnectorId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the [external database connector](#/en/database/latest/datatypes/CreateExternalDatabaseConnectorDetails). ' maxLength: 255 minLength: 1 type: string required: - externalDatabaseConnectorId AutonomousContainerDatabaseVersionSummary: description: 'The supported Autonomous AI Database version. ' properties: details: description: A URL that points to a detailed description of the Autonomous Container Database version. type: string supportedApps: description: The list of applications supported for the given version. items: $ref: '#/components/schemas/AppVersionSummary' type: array version: description: A valid Oracle AI Database version for provisioning an Autonomous Container Database. maxLength: 32 minLength: 1 type: string required: - version - supportedApps x-example: "{\n \"version\" : \"19.19.1.0.1\",\n \"supportedApps\" :\n [\n {\n \"releaseDate\": \"2022-09-23 06:24:34 +00:00\",\n \"endOfSupport\": \"2023-09-23 06:24:34 +00:00\",\n \"supportedAppName\" : \"ADBD_EBS\",\n \"isCertified\": true\n },\n {\n \"releaseDate\": \"2022-08-02 06:24:34 +00:00\",\n \"endOfSupport\": \"2023-08-02 06:24:34 +00:00\",\n \"supportedAppName\" : \"ADBD_GENERIC\",\n \"isCertified\": true\n }\n ]\n}\n" UpdateHistoryEntry: allOf: - $ref: '#/components/schemas/UpdateHistoryEntrySummary' CreateExternalNonContainerDatabaseDetails: allOf: - $ref: '#/components/schemas/CreateExternalDatabaseDetailsBase' description: 'Details for creating an external non-container database resource. ' UpdateDetails: description: 'Details specifying which maintenance update to apply to the cloud VM cluster and which actions are to be performed by the maintenance update. Applies to Exadata Cloud Service instances only. ' properties: giSoftwareImageId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of a grid infrastructure software image. This is a database software image of the type `GRID_IMAGE`. maxLength: 255 type: string updateAction: description: The update action. enum: - ROLLING_APPLY - NON_ROLLING_APPLY - PRECHECK - ROLLBACK type: string updateId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the maintenance update. maxLength: 255 minLength: 1 type: string CreateVmClusterDetails: description: 'Details for the create Exadata VM cluster operation. Applies to Exadata Cloud@Customer instances only. For details on the create cloud Exadata VM cluster operation used with Exadata Cloud Service instances, see [CreateCloudVmClusterDetails Reference](#/en/database/latest/datatypes/CreateCloudVmClusterDetails) ' properties: compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string cpuCoreCount: description: The number of ECPUs (X11M and higher) or number of OCPUs (X10M and earlier) to enable for the VM cluster. type: integer dataCollectionOptions: $ref: '#/components/schemas/DataCollectionOptions' dataStoragePercentage: description: 'The percentage assigned to DATA storage (user data and database files). See [Storage Configuration](/Content/Database/Concepts/exaoverview.htm#Exadata) in the Exadata documentation for details on the impact of the configuration settings on storage. ' format: int32 maximum: 100 minimum: 0 type: integer dataStorageSizeInGBs: description: The data disk group size to be allocated in GBs. format: double minimum: 32 type: number dataStorageSizeInTBs: description: The data disk group size to be allocated in TBs. format: double type: number dbNodeStorageSizeInGBs: description: The local node storage to be allocated in GBs. type: integer dbServers: description: The list of Db server. items: maxLength: 1024 minLength: 1 type: string type: array definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object displayName: description: The user-friendly name for the VM cluster. The name does not need to be unique. maxLength: 255 minLength: 1 type: string exadataInfrastructureId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure. maxLength: 255 minLength: 1 type: string fileSystemConfigurationDetails: description: Details of the file system configuration of the VM cluster. items: $ref: '#/components/schemas/FileSystemConfigurationDetail' maxItems: 1024 type: array freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object giVersion: description: The Oracle Grid Infrastructure software version for the VM cluster. maxLength: 255 minLength: 1 type: string isLocalBackupEnabled: description: 'If true, database backup on local Exadata storage is configured for the VM cluster. If false, database backup on local Exadata storage is not available in the VM cluster. ' type: boolean isSparseDiskgroupEnabled: description: 'If true, the sparse disk group is configured for the VM cluster. If false, the sparse disk group is not created. ' type: boolean licenseModel: description: 'The Oracle license model that applies to the VM cluster. The default is BRING_YOUR_OWN_LICENSE. ' enum: - LICENSE_INCLUDED - BRING_YOUR_OWN_LICENSE type: string memorySizeInGBs: description: The memory to be allocated in GBs. type: integer ocpuCount: description: The number of OCPU cores to enable for the VM cluster. Only one decimal place is allowed for the fractional part. format: float minimum: 0.1 type: number x-example: 0.2 recoStoragePercentage: description: 'The percentage assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). See [Storage Configuration](/Content/Database/Concepts/exaoverview.htm#Exadata) in the Exadata documentation for details on the impact of the configuration settings on storage. ' format: int32 maximum: 100 minimum: 0 type: integer sparseStoragePercentage: description: 'The percentage assigned to SPARSE storage (Exadata snapshots). See [Storage Configuration](/Content/Database/Concepts/exaoverview.htm#Exadata) in the Exadata documentation for details on the impact of the configuration settings on storage. ' format: int32 maximum: 100 minimum: 0 type: integer sshPublicKeys: description: The public key portion of one or more key pairs used for SSH access to the VM cluster. items: maxLength: 1024 minLength: 1 type: string type: array systemVersion: description: Operating system version of the image. maxLength: 255 minLength: 1 type: string timeZone: description: The time zone to use for the VM cluster. For details, see [DB System Time Zones](/Content/Database/References/timezones.htm). format: x-obmcs-time-zone maxLength: 255 minLength: 1 type: string vmBackupStorageType: default: - LOCAL description: Specifies the type of VM Backups Storage and supported values are LOCAL and EXASCALE. - LOCAL if selected then VM Backups storage will be on DB Servers. - EXASCALE if selected then VM Backups storage will be on Exascale Storage Servers. Default Value is LOCAL enum: - LOCAL - EXASCALE type: string vmClusterNetworkId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the VM cluster network. maxLength: 255 minLength: 1 type: string vmFileSystemStorageType: default: - LOCAL description: Specifies the type of file system storage and supported values are LOCAL and EXASCALE. - LOCAL if selected then file system storage will be on DB Servers. - EXASCALE if selected then file system storage will be on Exascale Storage Servers. Default Value is LOCAL enum: - LOCAL - EXASCALE type: string required: - compartmentId - displayName - exadataInfrastructureId - cpuCoreCount - vmClusterNetworkId - sshPublicKeys - giVersion AutonomousDatabaseEncryptionKeyDetails: description: Details of the Autonomous AI Database encryption key. discriminator: propertyName: provider properties: provider: description: The provider for the Autonomous AI Database encryption key. enum: - AWS - AZURE - OCI - ORACLE_MANAGED - OKV type: string VmClusterUpdateHistoryEntrySummary: description: 'The record of a maintenance update action performed on a specified VM cluster. Applies to Exadata Cloud@Customer instances only. ' properties: id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the maintenance update history entry. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: 'Descriptive text providing additional details about the lifecycle state. ' type: string lifecycleState: description: The current lifecycle state of the maintenance update operation. enum: - IN_PROGRESS - SUCCEEDED - FAILED type: string timeCompleted: description: The date and time when the maintenance update action completed. format: date-time type: string timeStarted: description: The date and time when the maintenance update action started. format: date-time type: string updateAction: description: The update action performed using this maintenance update. enum: - ROLLING_APPLY - PRECHECK - ROLLBACK type: string updateId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the maintenance update. maxLength: 255 minLength: 1 type: string updateType: description: The type of VM cluster maintenance update. enum: - GI_UPGRADE - GI_PATCH - OS_UPDATE type: string required: - id - updateId - lifecycleState - timeStarted - updateType EnableExternalContainerDatabaseStackMonitoringDetails: allOf: - $ref: '#/components/schemas/EnableExternalDatabaseStackMonitoringDetailsBase' description: Details to enable Stack Monitoring on the external container database. FailoverDataGuardDetails: description: 'The Data Guard failover parameters. ' properties: databaseAdminPassword: description: 'The administrator password of the primary database in this Data Guard association. **The password MUST be the same as the primary admin password.** ' format: password maxLength: 255 minLength: 1 type: string required: - databaseAdminPassword type: object ManagedSoftwareUpdateInputDetails: description: 'The database registered for Oracle Managed Database Software Updates. ' properties: isEnrolled: description: 'If true, database is registered for Oracle Managed Database Software Updates otherwise database is not registered for Oracle Managed Database Software Updates ' type: boolean preferenceDetails: $ref: '#/components/schemas/ManagedSoftwareUpdatePreferenceDetails' required: - isEnrolled SchedulingWindow: allOf: - $ref: '#/components/schemas/SchedulingWindowSummary' description: 'Details of a Scheduling Window. ' ExternalDatabaseBase: description: 'A resource that allows you to manage an Oracle Database located outside of Oracle Cloud using Oracle Cloud Infrastructure''s Console and APIs. ' properties: characterSet: description: The character set of the external database. maxLength: 255 minLength: 1 type: string compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string databaseConfiguration: description: The Oracle Database configuration enum: - RAC - SINGLE_INSTANCE type: string databaseEdition: description: 'The Oracle Database Edition that applies to all the databases on the DB system. Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE. ' enum: - STANDARD_EDITION - ENTERPRISE_EDITION - ENTERPRISE_EDITION_HIGH_PERFORMANCE - ENTERPRISE_EDITION_EXTREME_PERFORMANCE - ENTERPRISE_EDITION_DEVELOPER type: string databaseManagementConfig: $ref: '#/components/schemas/DatabaseManagementConfig' databaseVersion: description: The Oracle Database version. maxLength: 512 minLength: 1 type: string dbId: description: 'The Oracle Database ID, which identifies an Oracle Database located outside of Oracle Cloud. ' maxLength: 512 minLength: 1 type: string dbPacks: description: The database packs licensed for the external Oracle Database. maxLength: 512 minLength: 1 type: string dbUniqueName: description: The `DB_UNIQUE_NAME` of the external database. maxLength: 32 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object displayName: description: The user-friendly name for the external database. The name does not have to be unique. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure external database resource. ' maxLength: 255 minLength: 1 type: string lifecycleDetails: description: Additional information about the current lifecycle state. type: string lifecycleState: description: The current state of the Oracle Cloud Infrastructure external database resource. enum: - PROVISIONING - NOT_CONNECTED - AVAILABLE - UPDATING - TERMINATING - TERMINATED - FAILED type: string ncharacterSet: description: The national character of the external database. maxLength: 255 minLength: 1 type: string stackMonitoringConfig: $ref: '#/components/schemas/StackMonitoringConfig' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object timeCreated: description: The date and time the database was created. format: date-time type: string timeZone: description: 'The time zone of the external database. It is a time zone offset (a character type in the format ''[+|-]TZH:TZM'') or a time zone region name, depending on how the time zone value was specified when the database was created / last altered. ' maxLength: 512 minLength: 1 type: string required: - id - compartmentId - displayName - lifecycleState - timeCreated CloudDatabaseManagementConfig: description: The configuration of the Database Management service. properties: managementStatus: description: The status of the Database Management service. enum: - ENABLING - ENABLED - DISABLING - DISABLED - UPDATING - FAILED_ENABLING - FAILED_DISABLING - FAILED_UPDATING type: string managementType: default: BASIC description: The Database Management type. enum: - BASIC - ADVANCED type: string required: - managementStatus - managementType EnableExternalNonContainerDatabaseOperationsInsightsDetails: allOf: - $ref: '#/components/schemas/EnableExternalDatabaseOperationsInsightsDetailsBase' description: Details to enable Operations Insights on the external non-container database UpdateSchedulingPolicyDetails: description: 'Describes the modification parameters for the Scheduling Policy. ' properties: cadence: description: The cadence period. enum: - HALFYEARLY - QUARTERLY - MONTHLY type: string cadenceStartMonth: $ref: '#/components/schemas/Month' description: Start of the month to be followed during the cadence period. definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object displayName: description: The user-friendly name for the Scheduling Policy. The name does not need to be unique. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object RotateAutonomousVmClusterOrdsCertsDetails: description: 'The details for configuring the SSL certificates on Autonomous VM Cluster ' properties: caBundleId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the certificate bundle. ' maxLength: 255 minLength: 1 type: string certificateAuthorityId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the certificate authority. ' maxLength: 255 minLength: 1 type: string certificateGenerationType: description: Specify SYSTEM to use Oracle-managed certificates. Specify BYOC when you want to bring your own certificate. enum: - SYSTEM - BYOC type: string certificateId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the certificate to use. ' maxLength: 255 minLength: 1 type: string required: - certificateGenerationType UpdateAutonomousDatabaseWalletDetails: description: 'Details to update an Autonomous AI Database wallet. ' properties: gracePeriod: description: The number of hours that the old wallet can be used after it has been rotated. The old wallet will no longer be valid after the number of hours in the wallet rotation grace period has passed. During the grace period, both the old wallet and the current wallet can be used. maximum: 24 minimum: 1 type: integer shouldRotate: default: false description: Indicates whether to rotate the wallet or not. If `false`, the wallet will not be rotated. The default is `false`. type: boolean CreateExternalDatabaseDetailsBase: description: Details for creating an external database. properties: compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object displayName: description: The user-friendly name for the external database. The name does not have to be unique. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object required: - compartmentId - displayName DatabaseSoftwareImage: allOf: - $ref: '#/components/schemas/DatabaseSoftwareImageSummary' description: 'Database software images are created by specifying a patch set, one-off patches and patches for the database home (listed by `ls inventory`). ' ConsoleConnectionSummary: description: 'The `InstanceConsoleConnection` API provides you with console access to dbnode enabling you to troubleshoot malfunctioning dbnode. ' properties: compartmentId: description: The OCID of the compartment to contain the console connection. maxLength: 255 minLength: 1 type: string connectionString: description: The SSH connection string for the console connection. type: string dbNodeId: description: The OCID of the database node. maxLength: 255 minLength: 1 type: string fingerprint: description: The SSH public key fingerprint for the console connection. maxLength: 255 minLength: 1 type: string id: description: The OCID of the console connection. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of the console connection. enum: - ACTIVE - CREATING - DELETED - DELETING - FAILED type: string required: - id - compartmentId - dbNodeId - connectionString - fingerprint - lifecycleState x-example: "{\n \"id\": \"ocid1.instanceconsoleconnection.oc1.iad.exampleunique_ID\",\n \"compartmentId\": \"ocid1.compartment.oc1..exampleunique_ID\",\n \"dbNodeId\": \"ocid1.dbnode.oc1.iad.exampleunique_ID\",\n \"connectionString\": \"ssh -o ProxyCommand='ssh -W %h:%p -p 443 ocid1.ConsoleConnectionSummary.oc1.iad.exampleunique_ID@instance-console.us-ashburn-1.oraclecloud.com' ocid1.instance.oc1.iad.exampleunique_ID\",\n \"fingerprint\": \"4a:46:c1:72:14:de:9f:a8:fe:89:a9:6c:6c:63:77:83\",\n \"lifecycleState\": \"ACTIVE\"\n}\n" StackMonitoringConfig: description: The configuration of Stack Monitoring for the external database. properties: stackMonitoringConnectorId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the [external database connector](#/en/database/latest/datatypes/CreateExternalDatabaseConnectorDetails). ' maxLength: 255 minLength: 1 type: string stackMonitoringStatus: description: The status of Stack Monitoring. enum: - ENABLING - ENABLED - DISABLING - NOT_ENABLED - FAILED_ENABLING - FAILED_DISABLING type: string required: - stackMonitoringStatus OperationsInsightsConfig: description: The configuration of Operations Insights for the external database properties: operationsInsightsConnectorId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the [external database connector](#/en/database/latest/datatypes/CreateExternalDatabaseConnectorDetails). ' maxLength: 255 minLength: 1 type: string operationsInsightsStatus: description: The status of Operations Insights enum: - ENABLING - ENABLED - DISABLING - NOT_ENABLED - FAILED_ENABLING - FAILED_DISABLING type: string required: - operationsInsightsStatus OCPUs: description: 'The details of the available and consumed CPU cores of the Autonomous Exadata Infrastructure instance, including consumption by database workload type. ' properties: byWorkloadType: $ref: '#/components/schemas/WorkloadType' consumedCpu: description: The total number of consumed OCPUs in the Autonomous Exadata Infrastructure instance. format: float maximum: 92.0 minimum: 0.0 type: number totalCpu: description: The total number of OCPUs in the Autonomous Exadata Infrastructure instance. format: float maximum: 92.0 minimum: 0.0 type: number ChangeAutonomousDatabaseSoftwareImageCompartmentDetails: description: The configuration details for moving the resource. properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the resource to. maxLength: 255 minLength: 1 type: string required: - compartmentId CreateConsoleConnectionDetails: description: 'The details for creating a Db node console connection. The Db node console connection is created in the same compartment as the dbNode. ' properties: publicKey: description: The SSH public key used to authenticate the console connection. format: ssh-authorized-key maxLength: 900 minLength: 1 type: string required: - publicKey RestartAutonomousDatabaseDetails: description: Request details to restart an Autonomous Database with force option. properties: isForceRestart: description: If set to `true`, restarts the Autonomous Database with force option. type: boolean type: object ExadataDbSystemMigrationSummary: description: 'Information about the Exadata DB system migration. The migration is used to move the Exadata Cloud Service instance from the DB system resource model to the new cloud Exadata infrastructure resource model. ' properties: cloudExadataInfrastructureId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud Exadata infrastructure. maxLength: 255 minLength: 1 type: string cloudVmClusterId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud VM cluster. maxLength: 255 minLength: 1 type: string dbSystemId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the DB system. maxLength: 255 minLength: 1 type: string required: - dbSystemId - cloudVmClusterId - cloudExadataInfrastructureId UpdateKeyStoreDetails: description: Details for updating the key store. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object typeDetails: $ref: '#/components/schemas/KeyStoreTypeDetails' DbSystemUpgradeHistoryEntrySummary: description: 'The summary for the record of an OS upgrade action on a DB system. ' properties: action: description: The operating system upgrade action. enum: - PRECHECK - ROLLBACK - UPDATE_SNAPSHOT_RETENTION_DAYS - UPGRADE type: string id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the upgrade history entry. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: 'A descriptive text associated with the lifecycleState. Typically contains additional displayable text. ' type: string lifecycleState: description: The current state of the action. enum: - IN_PROGRESS - SUCCEEDED - FAILED - NEEDS_ATTENTION type: string newGiVersion: description: A valid Oracle Grid Infrastructure (GI) software version. maxLength: 255 minLength: 1 type: string newOsVersion: description: A valid Oracle Software (OS) version eg. Oracle Linux Server release 8 maxLength: 255 minLength: 1 type: string oldGiVersion: description: A valid Oracle Grid Infrastructure (GI) software version. maxLength: 255 minLength: 1 type: string oldOsVersion: description: A valid Oracle Software (OS) version eg. Oracle Linux Server release 8 maxLength: 255 minLength: 1 type: string snapshotRetentionPeriodInDays: default: 0 description: The retention period, in days, for the snapshot that allows you to perform a rollback of the upgrade operation. After this number of days passes, you cannot roll back the upgrade. maximum: 31 minimum: 0 type: integer timeEnded: description: The date and time when the upgrade action completed format: date-time type: string timeStarted: description: The date and time when the upgrade action started. format: date-time type: string required: - id - action - lifecycleState - snapshotRetentionPeriodInDays - timeStarted DbServerSummary: description: 'Details of the Db server. ' properties: autonomousVirtualMachineIds: description: 'The list of [OCIDs](/Content/General/Concepts/identifiers.htm) of the Autonomous Virtual Machines associated with the Db server. ' items: maxLength: 255 minLength: 1 type: string type: array autonomousVmClusterIds: description: 'The list of [OCIDs](/Content/General/Concepts/identifiers.htm) of the Autonomous VM Clusters associated with the Db server. ' items: maxLength: 255 minLength: 1 type: string type: array compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string computeModel: description: 'The compute model of the Base Database, Exadata Infrastructure, VM Cluster and Autonomous AI Database. ' enum: - ECPU - OCPU type: string x-default-description: Null used when unspecified. cpuCoreCount: description: The number of CPU cores enabled on the Db server. minimum: 0 type: integer dbNodeIds: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Db nodes associated with the Db server. ' items: maxLength: 1024 minLength: 1 type: string type: array dbNodeStorageSizeInGBs: description: The allocated local node storage in GBs on the Db server. minimum: 0 type: integer dbServerPatchingDetails: $ref: '#/components/schemas/DbServerPatchingDetails' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object displayName: description: The user-friendly name for the Db server. The name does not need to be unique. maxLength: 255 minLength: 1 type: string exadataInfrastructureId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Db server. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: Additional information about the current lifecycle state. type: string lifecycleState: description: The current state of the Db server. enum: - CREATING - AVAILABLE - UNAVAILABLE - DELETING - DELETED - MAINTENANCE_IN_PROGRESS type: string maxCpuCount: description: The total number of CPU cores available. type: integer maxDbNodeStorageInGBs: description: The total local node storage available in GBs. type: integer maxMemoryInGBs: description: The total memory available in GBs. type: integer memorySizeInGBs: description: The allocated memory in GBs on the Db server. minimum: 0 type: integer shape: description: 'The shape of the Db server. The shape determines the amount of CPU, storage, and memory resources available. ' maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object timeCreated: description: The date and time that the Db Server was created. format: date-time type: string vmClusterIds: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the VM Clusters associated with the Db server. ' items: maxLength: 1024 minLength: 1 type: string type: array ResourcePoolShapeCollection: description: Results of an Autonomous AI Database resouce pool shape collection that contains ResourcePoolShapeSummary items. properties: items: description: List of Autonomous AI Database resource pools Shapes. items: $ref: '#/components/schemas/ResourcePoolShapeSummary' type: array DbHome: allOf: - $ref: '#/components/schemas/DbHomeSummary' RestoreDatabaseDetails: properties: databaseSCN: description: 'Restores using the backup with the System Change Number (SCN) specified. This field is applicable for both use cases - Restoring Container Database or Restoring specific Pluggable Database. ' maxLength: 255 minLength: 1 type: string latest: description: 'Restores to the last known good state with the least possible data loss. ' type: boolean pluggableDatabaseName: description: 'Restores only the Pluggable Database (if specified) using the inputs provided in request. ' type: string timestamp: description: 'Restores to the timestamp specified. ' format: date-time type: string GenerateRecommendedNetworkDetails: description: 'Generates a recommended VM cluster network configuration for an Exadata Cloud@Customer system. Applies to Exadata Cloud@Customer instances only. ' properties: compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string dbServers: description: The list of Db server Ids to configure network. items: maxLength: 1024 minLength: 1 type: string maxItems: 32 type: array definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object displayName: description: The user-friendly name for the VM cluster network. The name does not need to be unique. maxLength: 255 minLength: 1 type: string dns: description: The list of DNS server IP addresses. Maximum of 3 allowed. items: maxLength: 1024 minLength: 1 type: string maxItems: 3 type: array drScanListenerPortTcp: description: The DR SCAN TCPIP port. Default is 1521. maximum: 8999 minimum: 1024 type: integer freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object networks: description: List of parameters for generation of the client and backup networks. items: $ref: '#/components/schemas/InfoForNetworkGenDetails' type: array ntp: description: The list of NTP server IP addresses. Maximum of 3 allowed. items: maxLength: 1024 minLength: 1 type: string maxItems: 3 type: array required: - compartmentId - displayName - networks UpdateAutonomousVmClusterDetails: description: Details for updating the Autonomous VM cluster. properties: autonomousDataStorageSizeInTBs: description: The new value of autonomous data storage (in TBs) for the Autonomous VM cluster. format: double type: number cpuCoreCountPerNode: description: The new value of cpus per Autonomous VM cluster per node for the Autonomous VM cluster. type: integer definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object distributionAlgorithm: description: The distribution algorithm used for the Autonomous VM cluster. enum: - RESOURCE_OPTIMIZED - DISTRIBUTION_OPTIMIZED type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object isMtlsEnabled: default: false description: Enable mutual TLS(mTLS) authentication for database. Default is TLS. type: boolean licenseModel: description: 'The Oracle license model that applies to the Autonomous VM cluster. The default is BRING_YOUR_OWN_LICENSE. ' enum: - LICENSE_INCLUDED - BRING_YOUR_OWN_LICENSE type: string maintenanceWindowDetails: $ref: '#/components/schemas/MaintenanceWindow' scanListenerPortNonTls: description: The SCAN Listener Non TLS port number. Default value is 1521. maximum: 8999 minimum: 1024 type: integer scanListenerPortTls: description: The SCAN Listener TLS port number. Default value is 2484. maximum: 8999 minimum: 1024 type: integer timeZone: description: The time zone to use for the Autonomous VM cluster. For details, see [DB System Time Zones](/Content/Database/References/timezones.htm). format: x-obmcs-time-zone maxLength: 255 minLength: 1 type: string totalContainerDatabases: description: The new value of maximum number of ACDs for the Autonomous VM cluster. type: integer EstimatedPatchingTime: description: 'The estimated total time required in minutes for all patching operations (database server, storage server, and network switch patching). ' properties: estimatedDbServerPatchingTime: description: The estimated time required in minutes for database server patching. maximum: 3000 minimum: 1 type: integer estimatedNetworkSwitchesPatchingTime: description: The estimated time required in minutes for network switch patching. maximum: 3000 minimum: 1 type: integer estimatedStorageServerPatchingTime: description: The estimated time required in minutes for storage server patching. maximum: 3000 minimum: 1 type: integer totalEstimatedPatchingTime: description: The estimated total time required in minutes for all patching operations. maximum: 3000 minimum: 1 type: integer CreateExadbVmClusterDetails: description: 'Details for the create Exadata VM cluster on Exascale Infrastructure operation. Applies to Exadata Database Service on Exascale Infrastructure only. ' properties: availabilityDomain: description: 'The name of the availability domain in which the Exadata VM cluster on Exascale Infrastructure is located. ' maxLength: 255 minLength: 1 type: string backupNetworkNsgIds: description: 'A list of the [OCIDs](/Content/General/Concepts/identifiers.htm) of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see [Security Rules](/Content/Network/Concepts/securityrules.htm). Applicable only to Exadata systems. ' items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array uniqueItems: true backupSubnetId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the backup network subnet associated with the Exadata VM cluster on Exascale Infrastructure. ' maxLength: 255 minLength: 1 type: string clusterName: description: 'The cluster name for Exadata VM cluster on Exascale Infrastructure. The cluster name must begin with an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive. ' maxLength: 11 minLength: 1 type: string compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string dataCollectionOptions: $ref: '#/components/schemas/DataCollectionOptions' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object displayName: description: The user-friendly name for the Exadata VM cluster on Exascale Infrastructure. The name does not need to be unique. maxLength: 255 minLength: 1 type: string domain: description: "A domain name used for the Exadata VM cluster on Exascale Infrastructure. If the Oracle-provided internet and VCN\nresolver is enabled for the specified subnet, then the domain name for the subnet is used\n(do not provide one). Otherwise, provide a valid DNS domain name. Hyphens (-) are not permitted. \nApplies to Exadata Database Service on Exascale Infrastructure only.\n" type: string enabledECpuCount: description: 'The number of ECPUs to enable for an Exadata VM cluster on Exascale Infrastructure. ' format: int32 minimum: 0 type: integer exascaleDbStorageVaultId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata Database Storage Vault. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object gridImageId: description: 'Grid Setup will be done using this grid image id. The grid image ID can be obtained using the API /20160918/giVersions/{majorVersion}/minorVersions?compartmentId=&shapeFamily=EXADB_XS&availabilityDomain=. The list of supported major versions can be obtained using the API /20160918/giVersions?compartmentId=&shape=ExaDbXS&availabilityDomain= ' maxLength: 255 minLength: 1 type: string hostname: description: "The hostname for the Exadata VM cluster on Exascale Infrastructure. The hostname must begin with an alphabetic character, and \ncan contain alphanumeric characters and hyphens (-). For Exadata systems, the maximum length of the hostname is 12 characters.\n\nThe maximum length of the combined hostname and domain is 63 characters.\n\n**Note:** The hostname must be unique within the subnet. If it is not unique, \nthen the Exadata VM cluster on Exascale Infrastructure will fail to provision.\n" type: string licenseModel: description: 'The Oracle license model that applies to the Exadata VM cluster on Exascale Infrastructure. The default is BRING_YOUR_OWN_LICENSE. ' enum: - LICENSE_INCLUDED - BRING_YOUR_OWN_LICENSE type: string nodeCount: description: 'The number of nodes in the Exadata VM cluster on Exascale Infrastructure. ' format: int32 minimum: 1 type: integer nsgIds: description: 'The list of [OCIDs](/Content/General/Concepts/identifiers.htm) for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see [Security Rules](/Content/Network/Concepts/securityrules.htm). ' items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array uniqueItems: true privateZoneId: description: 'The private zone ID in which you want DNS records to be created. ' maxLength: 255 minLength: 1 type: string scanListenerPortTcp: description: The TCP Single Client Access Name (SCAN) port. The default port is 1521. type: integer scanListenerPortTcpSsl: description: 'The Secured Communication (TCPS) protocol Single Client Access Name (SCAN) port. The default port is 2484. ' type: integer 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 [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}` ' type: object shape: description: 'The shape of the Exadata VM cluster on Exascale Infrastructure resource ' type: string shapeAttribute: description: 'The type of Exascale storage used for Exadata VM cluster. The default is SMART_STORAGE which supports Oracle Database 23ai and later ' enum: - SMART_STORAGE - BLOCK_STORAGE type: string sshPublicKeys: description: The public key portion of one or more key pairs used for SSH access to the Exadata VM cluster on Exascale Infrastructure. items: maxLength: 1024 minLength: 1 type: string type: array subnetId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet associated with the Exadata VM cluster on Exascale Infrastructure. ' maxLength: 255 minLength: 1 type: string subscriptionId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the subscription with which resource needs to be associated with. maxLength: 255 minLength: 1 type: string systemVersion: description: Operating system version of the image. maxLength: 255 minLength: 1 type: string timeZone: description: 'The time zone to use for the Exadata VM cluster on Exascale Infrastructure. For details, see [Time Zones](/Content/Database/References/timezones.htm). ' maxLength: 255 minLength: 1 type: string totalECpuCount: description: 'The number of Total ECPUs for an Exadata VM cluster on Exascale Infrastructure. ' format: int32 minimum: 2 type: integer vmFileSystemStorage: $ref: '#/components/schemas/ExadbVmClusterStorageDetails' required: - compartmentId - displayName - sshPublicKeys - gridImageId - hostname - subnetId - backupSubnetId - nodeCount - totalECpuCount - enabledECpuCount - vmFileSystemStorage - exascaleDbStorageVaultId - availabilityDomain - shape ChangeCloudVmClusterCompartmentDetails: description: 'The configuration details for moving the cloud VM cluster to another compartment. Applies to Exadata Cloud Service instances only. ' properties: compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string required: - compartmentId ExascaleDbStorageVaultSummary: description: 'Details of the Exadata Database Storage Vault. ' properties: additionalFlashCacheInPercent: description: 'The size of additional Flash Cache in percentage of High Capacity database storage. ' format: int32 minimum: 0 type: integer attachedShapeAttributes: description: 'The shapeAttribute of the Exadata VM cluster(s) associated with the Exadata Database Storage Vault. ' items: enum: - SMART_STORAGE - BLOCK_STORAGE maxItems: 2 type: string uniqueItems: true type: array autoscaleLimitInGBs: description: The maximum limit, in gigabytes, to which the Vault storage size can automatically scale when auto scaling is enabled for the Database Storage Vault type: integer availabilityDomain: description: The name of the availability domain in which the Exadata Database Storage Vault is located. maxLength: 255 minLength: 1 type: string clusterPlacementGroupId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cluster placement group of the Exadata Infrastructure. maxLength: 255 minLength: 1 type: string compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object description: description: Exadata Database Storage Vault description. maxLength: 400 minLength: 1 type: string displayName: description: The user-friendly name for the Exadata Database Storage Vault. The name does not need to be unique. maxLength: 255 minLength: 1 type: string exadataInfrastructureId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object highCapacityDatabaseStorage: $ref: '#/components/schemas/ExascaleDbStorageDetails' id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata Database Storage Vault. maxLength: 255 minLength: 1 type: string isAutoscaleEnabled: description: Indicates if autoscale feature is enabled for the Database Storage Vault. The default value is `FALSE`. type: boolean lifecycleDetails: description: Additional information about the current lifecycle state. type: string lifecycleState: description: The current state of the Exadata Database Storage Vault. type: string x-obmcs-enumref: '#/definitions/ExascaleDbStorageVault/lifecycleState' subscriptionId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the subscription with which resource needs to be associated with. maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object timeCreated: description: The date and time that the Exadata Database Storage Vault was created. format: date-time type: string timeZone: description: 'The time zone that you want to use for the Exadata Database Storage Vault. For details, see [Time Zones](/Content/Database/References/timezones.htm). ' maxLength: 255 minLength: 1 type: string vmClusterCount: description: 'The number of Exadata VM clusters used the Exadata Database Storage Vault. ' type: integer required: - id - compartmentId - availabilityDomain - lifecycleState - displayName - highCapacityDatabaseStorage CreateDatabaseBase: description: 'Details for creating a database. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' discriminator: propertyName: source properties: dbHomeId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Database Home. maxLength: 255 minLength: 1 type: string dbVersion: description: 'A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation. This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. ' type: string kmsKeyId: description: The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. maxLength: 255 minLength: 1 type: string kmsKeyVersionId: description: 'The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous AI Database Serverless does not use key versions, hence is not applicable for Autonomous AI Database Serverless instances. ' maxLength: 255 minLength: 1 type: string source: default: NONE description: 'The source of the database: Use `NONE` for creating a new database. Use `DB_BACKUP` for creating a new database by restoring from a backup. Use `DATAGUARD` for creating a new STANDBY database for a Data Guard setup.. The default is `NONE`. ' enum: - NONE - DB_BACKUP - DATABASE - DATAGUARD type: string required: - source ResourcePoolSummary: description: The configuration details for resource pool properties: availableComputeCapacity: description: Available capacity left for new elastic pool members provision type: integer isDisabled: description: "Indicates if the resource pool should be deleted for the Autonomous AI Database. \n" type: boolean poolSize: description: Resource pool size. type: integer totalComputeCapacity: description: Resource Pool total capacity, it's currently 4x of pool size type: integer type: object DbSystem: allOf: - $ref: '#/components/schemas/DbSystemSummary' - properties: iormConfigCache: $ref: '#/components/schemas/ExadataIormConfig' type: object ResizeVmClusterNetworkDetails: description: 'Details of Db server network nodes to extend or shrink the VM cluster network. Applies to Exadata Cloud@Customer instances only. ' properties: action: description: 'Actions that can be performed on the VM cluster network. ADD_DBSERVER_NETWORK - Provide Db server network details of network nodes to be added to the VM cluster network. REMOVE_DBSERVER_NETWORK - Provide Db server network details of network nodes to be removed from the VM cluster network. ' enum: - ADD_DBSERVER_NETWORK - REMOVE_DBSERVER_NETWORK type: string vmNetworks: description: Details of the client and backup networks. items: $ref: '#/components/schemas/VmNetworkDetails' type: array required: - vmNetworks - action DbNodeSummary: description: 'A server where Oracle Database software is running. 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). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' properties: additionalDetails: description: Additional information about the planned maintenance. type: string backupIpId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the backup IPv4 address associated with the database node. Use this OCID with either the [GetPrivateIp](#/en/iaas/20160918/PrivateIp/GetPrivateIp) or the [GetPublicIpByPrivateIpId](#/en/iaas/20160918/PublicIp/GetPublicIpByPrivateIpId) API to get the IPv4 address needed to make a database connection. **Note:** Applies only to Exadata Cloud Service. ' maxLength: 255 minLength: 1 type: string backupIpv6Id: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the backup IPv6 address associated with the database node. Use this OCID with the [GetIpv6](#/en/iaas/20160918/Ipv6/GetIpv6) API to get the IPv6 address needed to make a database connection. **Note:** Applies only to Exadata Cloud Service. ' maxLength: 255 minLength: 1 type: string backupVnic2Id: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the second backup VNIC. **Note:** Applies only to Exadata Cloud Service. ' maxLength: 255 minLength: 1 type: string backupVnicId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the backup VNIC. maxLength: 255 minLength: 1 type: string computeCount: description: The number of compute servers for the DB system. format: int32 type: integer computeModel: description: The compute model for Base Database Service. This is required if using the `computeCount` parameter. If using `cpuCoreCount` then it is an error to specify `computeModel` to a non-null value. The ECPU compute model is the recommended model, and the OCPU compute model is legacy. enum: - ECPU - OCPU type: string cpuCoreCount: description: The number of CPU cores enabled on the Db node. type: integer dbNodeStorageSizeInGBs: description: The allocated local node storage in GBs on the Db node. type: integer dbServerId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exacc Db server associated with the database node. maxLength: 255 minLength: 1 type: string dbSystemId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the DB system. maxLength: 255 minLength: 1 type: string faultDomain: description: The name of the Fault Domain the instance is contained in. maxLength: 255 minLength: 1 type: string hostIpId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the host IPv4 address associated with the database node. Use this OCID with either the [GetPrivateIp](#/en/iaas/20160918/PrivateIp/GetPrivateIp) or the [GetPublicIpByPrivateIpId](#/en/iaas/20160918/PublicIp/GetPublicIpByPrivateIpId) API to get the IPv4 address needed to make a database connection. **Note:** Applies only to Exadata Cloud Service. ' maxLength: 255 minLength: 1 type: string hostIpv6Id: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the host IPv6 address associated with the database node. Use this OCID with the [GetIpv6](#/en/iaas/20160918/Ipv6/GetIpv6) API to get the IPv6 address needed to make a database connection. **Note:** Applies only to Exadata Cloud Service. ' maxLength: 255 minLength: 1 type: string hostname: description: The host name for the database node. type: string id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the database node. maxLength: 255 minLength: 1 type: string isForceActionInProgress: description: Indicates whether the node is in the process of being forcefully stopped or rebooted. type: boolean isOsPatchRebootRequired: description: 'Indicates whether the database node must be rebooted after applying Operating System patches. This flag becomes true after operations such as OS/kernel updates to indicate that a reboot of the node is required. After a successful reboot, this value is expected to return to false. ' type: boolean lifecycleState: description: The current state of the database node. enum: - PROVISIONING - AVAILABLE - UPDATING - STOPPING - STOPPED - STARTING - TERMINATING - TERMINATED - FAILED type: string maintenanceType: description: The type of database node maintenance. enum: - VMDB_REBOOT_MIGRATION - EXADBXS_REBOOT_MIGRATION type: string memorySizeInGBs: description: The allocated memory in GBs on the Db node. type: integer softwareStorageSizeInGB: description: 'The size (in GB) of the block storage volume allocation for the DB system. This attribute applies only for virtual machine DB systems. ' type: integer timeCreated: description: The date and time that the database node was created. format: date-time type: string timeMaintenanceWindowEnd: description: End date and time of maintenance window. format: date-time type: string timeMaintenanceWindowStart: description: Start date and time of maintenance window. format: date-time type: string totalCpuCoreCount: description: The total number of CPU cores reserved on the Db node. type: integer vnic2Id: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the second VNIC. **Note:** Applies only to Exadata Cloud Service. ' maxLength: 255 minLength: 1 type: string vnicId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the VNIC. maxLength: 255 minLength: 1 type: string required: - id - dbSystemId - vnicId - lifecycleState - timeCreated UpgradeDbSystemDetails: description: 'Details for upgrading the operating system and Oracle Grid Infrastructure (GI) of a DB system. ' properties: action: description: The operating system upgrade action. enum: - PRECHECK - ROLLBACK - UPDATE_SNAPSHOT_RETENTION_DAYS - UPGRADE type: string isSnapshotRetentionDaysForceUpdated: description: If true, rollback time is updated even if operating system upgrade history contains errors. type: boolean newGiVersion: description: A valid Oracle Grid Infrastructure (GI) software version. maxLength: 255 minLength: 1 type: string newOsVersion: description: A valid Oracle Software (OS) version eg. Oracle Linux Server release 8 maxLength: 255 minLength: 1 type: string snapshotRetentionPeriodInDays: default: 0 description: The retention period, in days, for the snapshot that allows you to perform a rollback of the upgrade operation. After this number of days passes, you cannot roll back the upgrade. maximum: 31 minimum: 0 type: integer required: - action ConfigureAutonomousDatabaseVaultKeyDetails: description: Configuration details for the Autonomous AI Database [vault](/Content/KeyManagement/Concepts/keyoverview.htm#concepts) key. properties: isUsingOracleManagedKeys: description: True if disable Customer Managed Keys and use Oracle Managed Keys. type: boolean kmsKeyId: description: The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. maxLength: 255 minLength: 1 type: string vaultId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [vault](/Content/KeyManagement/Concepts/keyoverview.htm#concepts). This parameter and `secretId` are required for Customer Managed Keys. maxLength: 255 minLength: 1 type: string BackupDestination: allOf: - $ref: '#/components/schemas/BackupDestinationSummary' description: Backup destination details. ManagedSoftwareUpdateDayOfWeek: description: 'Day of the week. ' properties: dayOfWeek: description: 'Day of the week. ' enum: - SUNDAY - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY type: string required: - dayOfWeek type: string PdbConversionHistoryEntrySummary: description: 'Details of operations performed to convert a non-container database to pluggable database. ' properties: action: description: 'The operations used to convert a non-container database to a pluggable database. - Use `PRECHECK` to run a pre-check operation on non-container database prior to converting it into a pluggable database. - Use `CONVERT` to convert a non-container database into a pluggable database. - Use `SYNC` if the non-container database was manually converted into a pluggable database using the dbcli command-line utility. Databases may need to be converted manually if the CONVERT action fails when converting a non-container database using the API. - Use `SYNC_ROLLBACK` if the conversion of a non-container database into a pluggable database was manually rolled back using the dbcli command line utility. Conversions may need to be manually rolled back if the CONVERT action fails when converting a non-container database using the API. ' enum: - PRECHECK - CONVERT - SYNC - SYNC_ROLLBACK type: string additionalCdbParams: description: 'Additional container database parameter. ' type: string cdbName: description: The database name. The name must begin with an alphabetic character and can contain a maximum of 8 alphanumeric characters. Special characters are not permitted. The database name must be unique in the tenancy. maxLength: 8 minLength: 1 type: string id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the database conversion history. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: Additional information about the current lifecycle state for the conversion operation. type: string lifecycleState: description: Status of an operation performed during the conversion of a non-container database to a pluggable database. enum: - SUCCEEDED - FAILED - IN_PROGRESS type: string sourceDatabaseId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the database. maxLength: 255 minLength: 1 type: string target: description: "The target container database of the pluggable database created by the database conversion operation. Currently, the database conversion operation only supports creating the pluggable database in a new container database.\n - Use `NEW_DATABASE` to specify that the pluggable database be created within a new container database in the same database home.\n" enum: - NEW_DATABASE type: string targetDatabaseId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the database. maxLength: 255 minLength: 1 type: string timeEnded: description: The date and time when the database conversion operation ended. format: date-time type: string timeStarted: description: The date and time when the database conversion operation started. format: date-time type: string required: - id - action - sourceDatabaseId - lifecycleState - timeStarted - cdbName CloudVmCluster: allOf: - $ref: '#/components/schemas/CloudVmClusterSummary' - properties: iormConfigCache: $ref: '#/components/schemas/ExadataIormConfig' type: object description: 'Details of the cloud VM cluster. Applies to Exadata Cloud Service instances only. ' AddDbnodeSnapshotsForExadbVmClusterDetails: description: 'Details to create a Database Node Snapshot. ' properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object name: description: The user-friendly name for the Database Node Snapshot. The name should be unique. maxLength: 255 minLength: 1 type: string sourceDbnodeIds: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata Database Node. items: maxLength: 255 minLength: 1 type: string maxItems: 10 minItems: 1 type: array required: - name - sourceDbnodeIds AutonomousDatabaseCharacterSets: description: 'The Oracle Autonomous AI Database supported character sets. 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: name: description: A valid Oracle character set. maxLength: 255 minLength: 1 type: string VmClusterUpdateDetails: description: 'Details specifying which maintenance update to apply to the VM Cluster and which action is to be performed by the maintenance update. Applies to Exadata Cloud@Customer instances only. ' properties: giSoftwareImageId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of a grid infrastructure software image. This is a database software image of the type `GRID_IMAGE`. maxLength: 255 type: string updateAction: description: The update action to perform. enum: - ROLLING_APPLY - PRECHECK - ROLLBACK type: string updateId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the maintenance update. maxLength: 255 minLength: 1 type: string OneoffPatch: allOf: - $ref: '#/components/schemas/OneoffPatchSummary' description: 'One-off patches are created by specifying a database version, releaseUpdate and one-off patch number. ' CreateCloudAutonomousVmClusterDetails: description: 'Details for the create cloud Autonomous VM cluster operation. ' properties: autonomousDataStorageSizeInTBs: description: The data disk group size to be allocated for Autonomous AI Databases, in TBs. format: double type: number cloudExadataInfrastructureId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud Exadata infrastructure. maxLength: 255 minLength: 1 type: string clusterTimeZone: default: Etc/UTC description: The time zone to use for the Cloud Autonomous VM cluster. For details, see [DB System Time Zones](/Content/Database/References/timezones.htm). format: x-obmcs-time-zone maxLength: 255 minLength: 1 type: string compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string computeModel: default: ECPU description: 'The compute model of the Cloud Autonomous VM Cluster. ECPU compute model is the recommended model and OCPU compute model is legacy. ' enum: - ECPU - OCPU type: string cpuCoreCountPerNode: description: The number of CPU cores to be enabled per VM cluster node. type: integer dbServers: description: The list of database servers. items: maxLength: 1024 minLength: 1 type: string type: array definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object description: description: User defined description of the cloud Autonomous VM cluster. maxLength: 400 minLength: 1 type: string displayName: description: The user-friendly name for the cloud Autonomous VM cluster. The name does not need to be unique. maxLength: 255 minLength: 1 type: string distributionAlgorithm: description: The distribution algorithm used for the Autonomous VM cluster. enum: - RESOURCE_OPTIMIZED - DISTRIBUTION_OPTIMIZED type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object isMtlsEnabledVmCluster: default: false description: Enable mutual TLS(mTLS) authentication for database at time of provisioning a VMCluster. This is applicable to database TLS Certificates only. Default is TLS type: boolean licenseModel: description: 'The Oracle license model that applies to the Oracle Autonomous AI Database. Bring your own license (BYOL) allows you to apply your current on-premises Oracle software licenses to equivalent, highly automated Oracle services in the cloud. License Included allows you to subscribe to new Oracle AI Database software licenses and the Oracle AI Database service. Note that when provisioning an [Autonomous AI Database on dedicated Exadata infrastructure](https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html), this attribute must be null. It is already set at the Autonomous Exadata Infrastructure level. When provisioning an [Autonomous AI Database Serverless] (https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html) database, if a value is not specified, the system defaults the value to `BRING_YOUR_OWN_LICENSE`. Bring your own license (BYOL) also allows you to select the DB edition using the optional parameter. This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, dataStorageSizeInTBs, adminPassword, isMTLSConnectionRequired, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, dbName, scheduledOperations, dbToolsDetails, or isFreeTier. ' enum: - LICENSE_INCLUDED - BRING_YOUR_OWN_LICENSE type: string maintenanceWindowDetails: $ref: '#/components/schemas/MaintenanceWindow' memoryPerOracleComputeUnitInGBs: description: 'The amount of memory (in GBs) to be enabled per OCPU or ECPU. ' type: integer nsgIds: description: 'The list of [OCIDs](/Content/General/Concepts/identifiers.htm) for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see [Security Rules](/Content/Network/Concepts/securityrules.htm). ' items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array uniqueItems: true scanListenerPortNonTls: description: The SCAN Listener Non TLS port. Default is 1521. maximum: 8999 minimum: 1024 type: integer scanListenerPortTls: description: The SCAN Listener TLS port. Default is 2484. maximum: 8999 minimum: 1024 type: integer 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 [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}` ' type: object sgaPercentage: description: Percentage of ECPU memory allocated for SGA(System Global Area). format: float type: number subnetId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet the cloud Autonomous VM Cluster is associated with. ' maxLength: 255 minLength: 1 type: string totalContainerDatabases: description: The total number of Autonomous Container Databases that can be created. type: integer required: - compartmentId - displayName - cloudExadataInfrastructureId - subnetId RemoveVirtualMachineFromExadbVmClusterDetails: description: 'Details of removing Virtual Machines from the Exadata VM cluster on Exascale Infrastructure. Applies to Exadata Database Service on Exascale Infrastructure only. ' properties: dbNodes: description: The list of ExaCS DB nodes for the Exadata VM cluster on Exascale Infrastructure to be removed. items: $ref: '#/components/schemas/DbNodeDetails' type: array required: - dbNodes ChangeKeyStoreCompartmentDetails: description: 'The configuration details for moving the key store. ' properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the key store to. ' maxLength: 255 minLength: 1 type: string required: - compartmentId KeyStoreTypeDetails: description: Key store type details. discriminator: propertyName: type properties: type: description: The type of key store. enum: - ORACLE_KEY_VAULT type: string required: - type ConvertToStandaloneDetails: description: 'The properties for converting a standby database to a standalone. ' properties: databaseAdminPassword: description: 'The administrator password of the primary database in this Data Guard association. **The password MUST be the same as the primary admin password.** ' format: password maxLength: 255 minLength: 1 type: string required: - databaseAdminPassword type: object ActionParamValuesCollection: description: A list of Action Parameters. Contains ActionParamValues items. properties: items: description: List of Action Parameters and their possible values. items: $ref: '#/components/schemas/ActionParamValuesSummary' maxItems: 50 type: array required: - items ExternalBackupJob: description: 'Provides all the details that apply to an external backup job. ' properties: backupId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the associated backup resource. maxLength: 255 minLength: 1 type: string bucketName: description: The name of the Swift compartment bucket where the backup should be stored. maxLength: 255 minLength: 1 type: string provisioning: description: An indicator for the provisioning state of the resource. If `TRUE`, the resource is still being provisioned. type: boolean swiftPassword: description: 'The auth token to use for access to the Swift compartment bucket that will store the standalone backup. For information about auth tokens, see [Working with Auth Tokens](/Content/Identity/Tasks/managingcredentials.htm#two). ' maxLength: 255 minLength: 1 type: string swiftPath: description: The Swift path to use as a destination for the standalone backup. maxLength: 1024 minLength: 1 type: string tag: description: The tag for RMAN to apply to the backup. maxLength: 255 minLength: 10 type: string userName: description: The Swift user name to use for transferring the standalone backup to the designated Swift compartment bucket. maxLength: 255 minLength: 1 type: string required: - backupId - provisioning - swiftPath - bucketName - userName - tag VmNetworkDetails: description: 'Details of the client or backup networks in an Exadata VM cluster network. Applies to Exadata Cloud@Customer instances only. ' properties: domainName: description: The network domain name. maxLength: 255 minLength: 1 type: string gateway: description: The network gateway. maxLength: 255 minLength: 1 type: string netmask: description: The network netmask. maxLength: 255 minLength: 1 type: string networkType: description: The network type. enum: - CLIENT - BACKUP - DISASTER_RECOVERY type: string nodes: description: The list of node details. items: $ref: '#/components/schemas/NodeDetails' type: array vlanId: description: The network VLAN ID. maxLength: 255 minLength: 1 type: string required: - networkType - nodes UpdateDbHomeDetails: description: 'Describes the modification parameters for the Database Home. ' properties: dbVersion: $ref: '#/components/schemas/PatchDetails' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object oneOffPatches: description: List of one-off patches for Database Homes. items: type: string type: array WorkloadType: description: 'The number of consumed OCPUs, by database workload type. ' properties: adw: description: The total number of OCPU cores in use for Autonomous AI Lakehouse databases in the infrastructure instance. format: float maximum: 92.0 minimum: 0.0 type: number atp: description: The total number of OCPU cores in use for Autonomous AI Transaction Processing databases in the infrastructure instance. format: float maximum: 92.0 minimum: 0.0 type: number AutonomousVmClusterResourceDetails: description: Unallocated resource details of the AVM properties: id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure. maxLength: 255 minLength: 1 type: string unAllocatedAdbStorageInTBs: description: Total unallocated autonomous data storage in the AVM in TBs. format: double type: number required: - id - unAllocatedAdbStorageInTBs ReorderScheduledActionsDetails: description: 'Describes the re-order parameters for the Scheduled Action resources. ' properties: scheduledActionIdOrders: description: 'List of action resources in a specific order. Example: [{actionOrder: 1, actionResourceId: "resourceId1"}, {actionOrder: 2, actionResourceId: "resourceId2"}] ' items: $ref: '#/components/schemas/ActionOrderDetails' maxItems: 100 type: array required: - scheduledActionIdOrders AutonomousDatabaseSoftwareImageSummary: description: 'The Database service supports the creation of Autonomous AI Database Software Images for use in creating Autonomous Container Database. ' properties: autonomousDsiOneOffPatches: description: One-off patches included in the Autonomous AI Database Software Image items: type: string type: array compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string databaseVersion: description: The database version with which the Autonomous AI Database Software Image is to be built. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object displayName: description: The user-friendly name for the Autonomous AI Database Software Image. The name does not have to be unique. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Autonomous AI Database Software Image. maxLength: 255 minLength: 1 type: string imageShapeFamily: description: To what shape the image is meant for. type: string x-obmcs-enumref: '#/definitions/AutonomousDatabaseSoftwareImage/imageShapeFamily' lifecycleDetails: description: Detailed message for the lifecycle state. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of the Autonomous AI Database Software Image. type: string x-obmcs-enumref: '#/definitions/AutonomousDatabaseSoftwareImage/lifecycleState' releaseUpdate: description: The Release Updates. maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object timeCreated: description: The date and time the Autonomous AI Database Software Image was created. format: date-time type: string required: - id - compartmentId - lifecycleState - displayName - timeCreated - releaseUpdate - databaseVersion - imageShapeFamily ConvertToRegularPluggableDatabaseDetails: description: 'Parameters for converting Refreshable Clone Pluggable Database into Regular Pluggable Database. ' properties: containerDatabaseAdminPassword: description: The DB system administrator password of the Container Database. format: password maxLength: 255 minLength: 1 type: string shouldCreatePdbBackup: description: Indicates whether to take Pluggable Database Backup after the operation. type: boolean tdeWalletPassword: description: The existing TDE wallet password of the Container Database. format: password maxLength: 255 minLength: 1 type: string ExternalContainerDatabaseSummary: allOf: - $ref: '#/components/schemas/ExternalDatabaseBase' description: 'An Oracle Cloud Infrastructure resource that allows you to manage an external Oracle container database. ' UpdateVmClusterNetworkDetails: description: 'Details for an Exadata VM cluster network. Applies to Exadata Cloud@Customer instances only. ' properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object dns: description: The list of DNS server IP addresses. Maximum of 3 allowed. items: maxLength: 1024 minLength: 1 type: string maxItems: 3 type: array drScans: description: The SCAN details for DR network items: $ref: '#/components/schemas/DrScanDetails' maxItems: 3 type: array freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object ntp: description: The list of NTP server IP addresses. Maximum of 3 allowed. items: maxLength: 1024 minLength: 1 type: string maxItems: 3 type: array scans: description: The SCAN details. items: $ref: '#/components/schemas/ScanDetails' maxItems: 3 type: array vmNetworks: description: Details of the client and backup networks. items: $ref: '#/components/schemas/VmNetworkDetails' type: array ChangeDisasterRecoveryConfigurationDetails: allOf: - $ref: '#/components/schemas/DisasterRecoveryConfiguration' description: Details to update the cross-region disaster recovery (DR) details of the standby Autonomous AI Database Serverless instance. ActionMember: description: The details of an action member. properties: estimatedTimeInMins: description: The estimated time for the intended action member. maximum: 500000 minimum: 0 type: integer memberId: description: The ocid of the action member. maxLength: 255 minLength: 1 type: string memberOrder: description: The order of the action member in a scheduled action. maximum: 300 minimum: 1 type: integer required: - memberOrder - memberId type: object UpdateExadataInfrastructureDetails: description: 'Updates the Exadata infrastructure. Applies to Exadata Cloud@Customer instances only. See [UpdateCloudExadataInfrastructureDetails Reference](#/en/database/latest/datatypes/UpdateCloudExadataInfrastructureDetails) for information on updating Exadata Cloud Service cloud Exadata infrastructure resources. ' properties: additionalComputeCount: description: The requested number of additional compute servers for the Exadata infrastructure. type: integer additionalComputeSystemModel: description: 'Oracle Exadata System Model specification. The system model determines the amount of compute or storage server resources available for use. For more information, please see [System and Shape Configuration Options] (https://docs.oracle.com/en/engineered-systems/exadata-cloud-at-customer/ecccm/ecc-system-config-options.html#GUID-9E090174-5C57-4EB1-9243-B470F9F10D6B) ' enum: - X7 - X8 - X8M - X9M - X11M type: string additionalStorageCount: description: The requested number of additional storage servers for the Exadata infrastructure. type: integer adminNetworkCIDR: description: The CIDR block for the Exadata administration network. maxLength: 255 minLength: 1 type: string cloudControlPlaneServer1: description: The IP address for the first control plane server. maxLength: 255 minLength: 1 type: string cloudControlPlaneServer2: description: The IP address for the second control plane server. maxLength: 255 minLength: 1 type: string contacts: description: The list of contacts for the Exadata infrastructure. items: $ref: '#/components/schemas/ExadataInfrastructureContact' maxItems: 10 minItems: 1 type: array corporateProxy: description: The corporate network proxy for access to the control plane network. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object dnsServer: description: The list of DNS server IP addresses. Maximum of 3 allowed. items: maxLength: 1024 minLength: 1 type: string type: array freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object gateway: description: The gateway for the control plane network. maxLength: 255 minLength: 1 type: string infiniBandNetworkCIDR: description: The CIDR block for the Exadata InfiniBand interconnect. maxLength: 255 minLength: 1 type: string isMultiRackDeployment: description: Indicates if deployment is Multi-Rack or not. type: boolean maintenanceVersionPreferences: $ref: '#/components/schemas/MaintenanceVersionPreferenceDetails' maintenanceWindow: $ref: '#/components/schemas/MaintenanceWindow' multiRackConfigurationFile: description: The base64 encoded Multi-Rack configuration json file. format: byte type: string netmask: description: The netmask for the control plane network. maxLength: 255 minLength: 1 type: string networkBondingModeDetails: $ref: '#/components/schemas/NetworkBondingModeDetails' ntpServer: description: The list of NTP server IP addresses. Maximum of 3 allowed. items: maxLength: 1024 minLength: 1 type: string type: array timeZone: description: 'The time zone of the Exadata infrastructure. For details, see [Exadata Infrastructure Time Zones](/Content/Database/References/timezones.htm). ' format: x-obmcs-time-zone maxLength: 255 minLength: 1 type: string ConsoleHistorySummary: description: 'The details of the Db Node console history. ' properties: compartmentId: description: The OCID of the compartment containing the console history. maxLength: 255 minLength: 1 type: string dbNodeId: description: The OCID of the database node. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object displayName: description: The user-friendly name for the console history. The name does not need to be unique. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the console history. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: Additional information about the current lifecycle state. type: string lifecycleState: description: The current state of the console history. enum: - REQUESTED - GETTING_HISTORY - SUCCEEDED - FAILED - DELETED - DELETING type: string timeCreated: description: The date and time the console history was created. format: date-time type: string required: - id - compartmentId - dbNodeId - lifecycleState - timeCreated x-example: "{\n \"id\": \"ocid1.consolehistory.oc1.iad.exampleunique_ID\",\n \"displayName\" : \"console-history-20221202-1943\",\n \"compartmentId\": \"ocid1.compartment.oc1.iad.exampleunique_ID\",\n \"dbNodeId\": \"ocid1.dbnode.oc1.iad.exampleunique_ID\",\n \"lifecycleState\": \"REQUESTED\",\n \"definedTags\" : {},\n \"freeformTags\" : {},\n \"timeCreated\" : \"2022-12-03T03:43:24.342Z\"\n}\n" ExadbVmClusterSummary: description: 'Details of the Exadata VM cluster on Exascale Infrastructure. Applies to Exadata Database Service on Exascale Infrastructure only. ' properties: availabilityDomain: description: 'The name of the availability domain in which the Exadata VM cluster on Exascale Infrastructure is located. ' maxLength: 255 minLength: 1 type: string backupNetworkNsgIds: description: 'A list of the [OCIDs](/Content/General/Concepts/identifiers.htm) of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see [Security Rules](/Content/Network/Concepts/securityrules.htm). Applicable only to Exadata systems. ' items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array uniqueItems: true backupSubnetId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the backup network subnet associated with the Exadata VM cluster on Exascale Infrastructure. ' maxLength: 255 minLength: 1 type: string clusterName: description: 'The cluster name for Exadata VM cluster on Exascale Infrastructure. The cluster name must begin with an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive. ' maxLength: 11 minLength: 1 type: string clusterPlacementGroupId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cluster placement group of the Exadata Infrastructure. maxLength: 255 minLength: 1 type: string compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string dataCollectionOptions: $ref: '#/components/schemas/DataCollectionOptions' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object displayName: description: The user-friendly name for the Exadata VM cluster on Exascale Infrastructure. The name does not need to be unique. maxLength: 255 minLength: 1 type: string domain: description: "A domain name used for the Exadata VM cluster on Exascale Infrastructure. If the Oracle-provided internet and VCN\nresolver is enabled for the specified subnet, then the domain name for the subnet is used\n(do not provide one). Otherwise, provide a valid DNS domain name. Hyphens (-) are not permitted. \nApplies to Exadata Database Service on Exascale Infrastructure only.\n" type: string enabledECpuCount: description: 'The number of ECPUs to enable for an Exadata VM cluster on Exascale Infrastructure. ' format: int32 minimum: 0 type: integer exascaleDbStorageVaultId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata Database Storage Vault. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object giVersion: description: A valid Oracle Grid Infrastructure (GI) software version. maxLength: 255 minLength: 1 type: string gridImageId: description: 'Grid Setup will be done using this grid image id. The grid image ID can be obtained using the API /20160918/giVersions/{majorVersion}/minorVersions?compartmentId=&shapeFamily=EXADB_XS&availabilityDomain=. The list of supported major versions can be obtained using the API /20160918/giVersions?compartmentId=&shape=ExaDbXS&availabilityDomain= ' maxLength: 255 minLength: 1 type: string gridImageType: description: The type of Grid Image enum: - RELEASE_UPDATE - CUSTOM_IMAGE type: string hostname: description: "The hostname for the Exadata VM cluster on Exascale Infrastructure. The hostname must begin with an alphabetic character, and \ncan contain alphanumeric characters and hyphens (-). For Exadata systems, the maximum length of the hostname is 12 characters.\n\nThe maximum length of the combined hostname and domain is 63 characters.\n\n**Note:** The hostname must be unique within the subnet. If it is not unique, \nthen the Exadata VM cluster on Exascale Infrastructure will fail to provision.\n" type: string id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata VM cluster on Exascale Infrastructure. maxLength: 255 minLength: 1 type: string lastUpdateHistoryEntryId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the last maintenance update history entry. This value is updated when a maintenance update starts. maxLength: 255 minLength: 1 type: string licenseModel: description: 'The Oracle license model that applies to the Exadata VM cluster on Exascale Infrastructure. The default is BRING_YOUR_OWN_LICENSE. ' enum: - LICENSE_INCLUDED - BRING_YOUR_OWN_LICENSE type: string lifecycleDetails: description: Additional information about the current lifecycle state. type: string lifecycleState: description: The current state of the Exadata VM cluster on Exascale Infrastructure. enum: - PROVISIONING - AVAILABLE - UPDATING - TERMINATING - TERMINATED - FAILED - MAINTENANCE_IN_PROGRESS type: string listenerPort: description: The port number configured for the listener on the Exadata VM cluster on Exascale Infrastructure. format: int64 type: integer memorySizeInGBs: description: 'The memory that you want to be allocated in GBs. Memory is calculated based on 11 GB per VM core reserved. ' type: integer nodeCount: description: 'The number of nodes in the Exadata VM cluster on Exascale Infrastructure. ' format: int32 type: integer nsgIds: description: 'The list of [OCIDs](/Content/General/Concepts/identifiers.htm) for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see [Security Rules](/Content/Network/Concepts/securityrules.htm). ' items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array uniqueItems: true privateZoneId: description: 'The private zone ID in which you want DNS records to be created. ' maxLength: 255 minLength: 1 type: string scanDnsName: description: 'The FQDN of the DNS record for the SCAN IP addresses that are associated with the Exadata VM cluster on Exascale Infrastructure. ' maxLength: 72 minLength: 1 type: string scanDnsRecordId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the DNS record for the SCAN IP addresses that are associated with the Exadata VM cluster on Exascale Infrastructure. ' maxLength: 255 minLength: 1 type: string scanIpIds: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Single Client Access Name (SCAN) IP addresses associated with the Exadata VM cluster on Exascale Infrastructure. SCAN IP addresses are typically used for load balancing and are not assigned to any interface. Oracle Clusterware directs the requests to the appropriate nodes in the cluster. **Note:** For a single-node DB system, this list is empty. ' items: maxLength: 255 minLength: 1 type: string type: array scanListenerPortTcp: description: The TCP Single Client Access Name (SCAN) port. The default port is 1521. type: integer scanListenerPortTcpSsl: description: 'The Secured Communication (TCPS) protocol Single Client Access Name (SCAN) port. The default port is 2484. ' type: integer 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 [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}` ' type: object shape: description: 'The shape of the Exadata VM cluster on Exascale Infrastructure resource ' type: string shapeAttribute: description: 'The type of Exascale storage used for Exadata VM cluster. The default is SMART_STORAGE which supports Oracle Database 23ai and later ' enum: - SMART_STORAGE - BLOCK_STORAGE type: string snapshotFileSystemStorage: $ref: '#/components/schemas/ExadbVmClusterStorageDetails' sshPublicKeys: description: The public key portion of one or more key pairs used for SSH access to the Exadata VM cluster on Exascale Infrastructure. items: maxLength: 1024 minLength: 1 type: string type: array subnetId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet associated with the Exadata VM cluster on Exascale Infrastructure. ' maxLength: 255 minLength: 1 type: string subscriptionId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the subscription with which resource needs to be associated with. maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object systemVersion: description: Operating system version of the image. maxLength: 255 minLength: 1 type: string timeCreated: description: The date and time that the Exadata VM cluster on Exascale Infrastructure was created. format: date-time type: string timeZone: description: 'The time zone to use for the Exadata VM cluster on Exascale Infrastructure. For details, see [Time Zones](/Content/Database/References/timezones.htm). ' maxLength: 255 minLength: 1 type: string totalECpuCount: description: 'The number of Total ECPUs for an Exadata VM cluster on Exascale Infrastructure. ' format: int32 minimum: 2 type: integer totalFileSystemStorage: $ref: '#/components/schemas/ExadbVmClusterStorageDetails' vipIds: description: "The [OCID](/Content/General/Concepts/identifiers.htm) of the virtual IP (VIP) addresses associated with the Exadata VM cluster on Exascale Infrastructure. \nThe Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the Exadata Cloud Service instance to \nenable failover. If one node fails, then the VIP is reassigned to another active node in the cluster.\n" items: maxLength: 255 minLength: 1 type: string type: array vmFileSystemStorage: $ref: '#/components/schemas/ExadbVmClusterStorageDetails' zoneId: description: 'The OCID of the zone with which the Exadata VM cluster on Exascale Infrastructure is associated. ' maxLength: 255 minLength: 1 type: string required: - id - compartmentId - lifecycleState - displayName - availabilityDomain - subnetId - sshPublicKeys - hostname - domain - backupSubnetId - nodeCount - totalECpuCount - enabledECpuCount - vmFileSystemStorage - exascaleDbStorageVaultId - shape AutonomousVmResourceUsage: description: Autonomous VM usage statistics. properties: autonomousContainerDatabaseUsage: description: Associated Autonomous Container Database Usages. items: $ref: '#/components/schemas/AvmAcdResourceStats' maxItems: 1024 type: array availableCpus: description: The number of CPU cores available. format: float type: number displayName: description: The user-friendly name for the Autonomous VM cluster. The name does not need to be unique. type: string id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Autonomous VM Cluster. type: string provisionedCpus: description: The number of CPUs provisioned in an Autonomous VM Cluster. format: float type: number reclaimableCpus: description: 'CPU cores that continue to be included in the count of OCPUs available to the Autonomous Container Database even after one of its Autonomous AI Database is terminated or scaled down. You can release them to the available OCPUs at its parent AVMC level by restarting the Autonomous Container Database. ' format: float type: number reservedCpus: description: The number of CPUs reserved in an Autonomous VM Cluster. format: float type: number usedCpus: description: 'The number of CPU cores alloted to the Autonomous Container Databases in an Cloud Autonomous VM cluster. ' format: float type: number required: - displayName PluggableDatabase: allOf: - $ref: '#/components/schemas/PluggableDatabaseSummary' description: 'A pluggable database (PDB) is portable collection of schemas, schema objects, and non-schema objects that appears to an Oracle client as a non-container database. To use a PDB, it needs to be plugged into a CDB. To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to a tenancy administrator. If you are an administrator who needs to write policies to give users access, see [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' DatabaseUpgradeHistoryEntrySummary: description: 'The Database service supports the upgrade history of databases. To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm). For information about access control and compartments, see [Overview of the Identity Service](/Content/Identity/Concepts/overview.htm). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' properties: action: description: The database upgrade action. enum: - PRECHECK - UPGRADE - ROLLBACK type: string id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the database upgrade history. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: Additional information about the current lifecycle state. type: string lifecycleState: description: Status of database upgrade history SUCCEEDED|IN_PROGRESS|FAILED. enum: - SUCCEEDED - FAILED - IN_PROGRESS type: string options: description: 'Additional upgrade options supported by DBUA(Database Upgrade Assistant). Example: "-upgradeTimezone false -keepEvents" ' type: string source: description: "The source of the Oracle Database software to be used for the upgrade.\n - Use `DB_HOME` to specify an existing Database Home to upgrade the database. The database is moved to the target Database Home and makes use of the Oracle Database software version of the target Database Home.\n - Use `DB_VERSION` to specify a generally-available Oracle Database software version to upgrade the database.\n - Use `DB_SOFTWARE_IMAGE` to specify a [database software image](/iaas/Content/Database/Concepts/databasesoftwareimage.htm) to upgrade the database.\n" enum: - DB_HOME - DB_VERSION - DB_SOFTWARE_IMAGE type: string sourceDbHomeId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Database Home. maxLength: 255 minLength: 1 type: string targetDBVersion: description: 'A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation. This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. ' type: string targetDatabaseSoftwareImageId: description: the database software image used for upgrading database. maxLength: 255 minLength: 1 type: string targetDbHomeId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Database Home. maxLength: 255 minLength: 1 type: string timeEnded: description: The date and time when the database upgrade ended. format: date-time type: string timeStarted: description: The date and time when the database upgrade started. format: date-time type: string required: - id - action - lifecycleState - timeStarted PatchSummary: description: 'A Patch for a DB system or DB Home. 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: availableActions: description: Actions that can possibly be performed using this patch. items: enum: - APPLY - PRECHECK type: string type: array description: description: The text describing this patch package. maxLength: 255 minLength: 1 type: string id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the patch. maxLength: 255 minLength: 1 type: string lastAction: description: Action that is currently being performed or was completed last. enum: - APPLY - PRECHECK type: string lifecycleDetails: description: 'A descriptive text associated with the lifecycleState. Typically can contain additional displayable text. ' type: string lifecycleState: description: The current state of the patch as a result of lastAction. enum: - AVAILABLE - SUCCESS - IN_PROGRESS - FAILED type: string timeReleased: description: The date and time that the patch was released. format: date-time type: string version: description: The version of this patch package. maxLength: 255 minLength: 1 type: string required: - id - description - version - timeReleased - type AutonomousPatchSummary: description: 'A patch for an Autonomous Exadata Infrastructure or Autonomous Container Database. 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: autonomousPatchType: default: QUARTERLY description: 'Maintenance run type, either "QUARTERLY" or "TIMEZONE". ' enum: - QUARTERLY - TIMEZONE type: string description: description: The text describing this patch package. maxLength: 255 minLength: 1 type: string id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the patch. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: 'A descriptive text associated with the lifecycleState. Typically can contain additional displayable text. ' type: string lifecycleState: description: The current state of the patch as a result of lastAction. enum: - AVAILABLE - SUCCESS - IN_PROGRESS - FAILED type: string patchModel: description: Database patching model preference. See [My Oracle Support note 2285040.1](https://support.oracle.com/rs?type=doc&id=2285040.1) for information on the Release Update (RU) and Release Update Revision (RUR) patching models. enum: - RELEASE_UPDATES - RELEASE_UPDATE_REVISIONS type: string quarter: description: First month of the quarter in which the patch was released. maxLength: 20 minLength: 1 type: string timeReleased: description: The date and time that the patch was released. format: date-time type: string type: description: The type of patch. BUNDLE is one example. type: string version: description: The version of this patch package. maxLength: 255 minLength: 1 type: string year: description: Year in which the patch was released. maxLength: 10 minLength: 1 type: string required: - id - description - version - timeReleased - type CloudAutonomousVmClusterSummary: description: 'Details of the cloud Autonomous VM cluster. ' properties: autonomousDataStoragePercentage: description: The percentage of the data storage used for the Autonomous AI Databases in an Autonomous VM Cluster. format: float type: number autonomousDataStorageSizeInTBs: description: The data disk group size allocated for Autonomous AI Databases, in TBs. format: double type: number availabilityDomain: description: The name of the availability domain that the cloud Autonomous VM cluster is located in. maxLength: 255 minLength: 1 type: string availableAutonomousDataStorageSizeInTBs: description: The data disk group size available for Autonomous AI Databases, in TBs. format: double type: number availableContainerDatabases: description: The number of Autonomous Container Databases that can be created with the currently available local storage. type: integer availableCpus: description: CPU cores available for allocation to Autonomous AI Databases. format: float type: number cloudExadataInfrastructureId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud Exadata infrastructure. maxLength: 255 minLength: 1 type: string clusterTimeZone: description: The time zone of the Cloud Autonomous VM Cluster. format: x-obmcs-time-zone maxLength: 255 minLength: 1 type: string compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string computeModel: description: 'The compute model of the Cloud Autonomous VM Cluster. ECPU compute model is the recommended model and OCPU compute model is legacy. See [Compute Models in Autonomous AI Database on Dedicated Exadata #Infrastructure](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbak) for more details. ' enum: - ECPU - OCPU type: string cpuCoreCount: description: The number of CPU cores on the cloud Autonomous VM cluster. format: int32 minimum: 1 type: integer cpuCoreCountPerNode: description: The number of CPU cores enabled per VM cluster node. type: integer cpuPercentage: description: The percentage of total number of CPUs used in an Autonomous VM Cluster. format: float type: number dataStorageSizeInGBs: description: The total data storage allocated, in gigabytes (GB). format: double minimum: 32 type: number dataStorageSizeInTBs: description: The total data storage allocated, in terabytes (TB). format: double type: number dbNodeStorageSizeInGBs: description: The local node storage allocated in GBs. type: integer dbServers: description: The list of [OCIDs](/Content/General/Concepts/identifiers.htm) of the Db servers. items: maxLength: 255 minLength: 1 type: string maxItems: 255 type: array definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object description: description: User defined description of the cloud Autonomous VM cluster. maxLength: 400 minLength: 1 type: string displayName: description: The user-friendly name for the cloud Autonomous VM cluster. The name does not need to be unique. maxLength: 255 minLength: 1 type: string distributionAlgorithm: description: The distribution algorithm used for the Autonomous VM cluster. enum: - RESOURCE_OPTIMIZED - DISTRIBUTION_OPTIMIZED type: string domain: description: The domain name for the cloud Autonomous VM cluster. type: string exadataStorageInTBsLowestScaledValue: description: The lowest value to which exadataStorage (in TBs) can be scaled down. format: double type: number freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object hostname: description: The hostname for the cloud Autonomous VM cluster. type: string id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Cloud Autonomous VM cluster. maxLength: 255 minLength: 1 type: string isMtlsEnabledVmCluster: default: false description: Enable mutual TLS(mTLS) authentication for database at time of provisioning a VMCluster. This is applicable to database TLS Certificates only. Default is TLS type: boolean lastMaintenanceRunId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the last maintenance run. maxLength: 255 minLength: 1 type: string lastUpdateHistoryEntryId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the last maintenance update history. This value is updated when a maintenance update starts. maxLength: 255 minLength: 1 type: string licenseModel: description: 'The Oracle license model that applies to the Oracle Autonomous AI Database. Bring your own license (BYOL) allows you to apply your current on-premises Oracle software licenses to equivalent, highly automated Oracle services in the cloud. License Included allows you to subscribe to new Oracle AI Database software licenses and the Oracle AI Database service. Note that when provisioning an [Autonomous AI Database on dedicated Exadata infrastructure](https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html), this attribute must be null. It is already set at the Autonomous Exadata Infrastructure level. When provisioning an [Autonomous AI Database Serverless] (https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html) database, if a value is not specified, the system defaults the value to `BRING_YOUR_OWN_LICENSE`. Bring your own license (BYOL) also allows you to select the DB edition using the optional parameter. This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, dataStorageSizeInTBs, adminPassword, isMTLSConnectionRequired, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, dbName, scheduledOperations, dbToolsDetails, or isFreeTier. ' enum: - LICENSE_INCLUDED - BRING_YOUR_OWN_LICENSE type: string lifecycleDetails: description: Additional information about the current lifecycle state. type: string lifecycleState: description: The current state of the cloud Autonomous VM cluster. enum: - PROVISIONING - AVAILABLE - UPDATING - TERMINATING - TERMINATED - FAILED - MAINTENANCE_IN_PROGRESS type: string maintenanceWindow: $ref: '#/components/schemas/MaintenanceWindow' maxAcdsLowestScaledValue: description: The lowest value to which maximum number of ACDs can be scaled down. format: int32 type: integer memoryPerOracleComputeUnitInGBs: description: 'The amount of memory (in GBs) to be enabled per OCPU or ECPU. ' format: int32 type: integer memorySizeInGBs: description: The memory allocated in GBs. format: int32 type: integer nextMaintenanceRunId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the next maintenance run. maxLength: 255 minLength: 1 type: string nodeCount: description: 'The number of database servers in the cloud VM cluster. ' format: int32 minimum: 1 type: integer nonProvisionableAutonomousContainerDatabases: description: The number of non-provisionable Autonomous Container Databases in an Autonomous VM Cluster. type: integer nsgIds: description: 'The list of [OCIDs](/Content/General/Concepts/identifiers.htm) for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see [Security Rules](/Content/Network/Concepts/securityrules.htm). ' items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array uniqueItems: true ocpuCount: description: The number of CPU cores on the cloud Autonomous VM cluster. Only 1 decimal place is allowed for the fractional part. format: float minimum: 0.1 type: number x-example: 0.2 ocpusLowestScaledValue: description: The lowest value to which ocpus can be scaled down. format: int32 type: integer provisionableAutonomousContainerDatabases: description: The number of provisionable Autonomous Container Databases in an Autonomous VM Cluster. type: integer provisionedAutonomousContainerDatabases: description: The number of provisioned Autonomous Container Databases in an Autonomous VM Cluster. type: integer provisionedCpus: description: The number of CPUs provisioned in an Autonomous VM Cluster. format: float type: number reclaimableCpus: description: 'CPUs that continue to be included in the count of CPUs available to the Autonomous Container Database even after one of its Autonomous AI Database is terminated or scaled down. You can release them to the available CPUs at its parent Autonomous VM Cluster level by restarting the Autonomous Container Database. ' format: float type: number reservedCpus: description: The number of CPUs reserved in an Autonomous VM Cluster. format: float type: number scanListenerPortNonTls: description: The SCAN Listener Non TLS port. Default is 1521. maximum: 8999 minimum: 1024 type: integer scanListenerPortTls: description: The SCAN Listenenr TLS port. Default is 2484. maximum: 8999 minimum: 1024 type: integer 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 [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}` ' type: object sgaPercentage: description: Percentage of ECPU memory allocated for SGA(System Global Area). format: float type: number shape: description: 'The model name of the Exadata hardware running the cloud Autonomous VM cluster. ' maxLength: 255 minLength: 1 type: string subnetId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet the cloud Autonomous VM Cluster is associated with. **Subnet Restrictions:** - For Exadata and virtual machine 2-node RAC DB systems, do not use a subnet that overlaps with 192.168.128.0/20. These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and backup subnet. ' maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object timeCreated: description: The date and time that the cloud Autonomous VM cluster was created. format: date-time type: string timeDatabaseSslCertificateExpires: description: The date and time of Database SSL certificate expiration. format: date-time type: string timeOrdsCertificateExpires: description: The date and time of ORDS certificate expiration. format: date-time type: string timeUpdated: description: The last date and time that the cloud Autonomous VM cluster was updated. format: date-time type: string totalAutonomousDataStorageInTBs: description: The total data disk group size for Autonomous AI Databases, in TBs. format: float type: number totalContainerDatabases: description: The total number of Autonomous Container Databases that can be created with the allocated local storage. type: integer totalCpus: description: The total number of CPUs in an Autonomous VM Cluster. format: float type: number required: - id - cloudExadataInfrastructureId - compartmentId - lifecycleState - displayName - availabilityDomain - subnetId AutonomousDatabase: allOf: - $ref: '#/components/schemas/AutonomousDatabaseSummary' - properties: null type: object description: 'An Oracle Autonomous AI Database. ' DatabaseConnectionStrings: description: 'Connection strings to connect to an Oracle Database. ' properties: allConnectionStrings: additionalProperties: type: string description: All connection strings to use to connect to the Database. type: object cdbDefault: description: Host name based CDB Connection String. maxLength: 255 minLength: 10 type: string cdbIpDefault: description: IP based CDB Connection String. maxLength: 255 minLength: 10 type: string type: object ExadbVmCluster: allOf: - $ref: '#/components/schemas/ExadbVmClusterSummary' - properties: iormConfigCache: $ref: '#/components/schemas/ExadataIormConfig' type: object description: 'Details of the Exadata VM cluster on Exascale Infrastructure. Applies to Exadata Database Service on Exascale Infrastructure only. ' UpdateAutonomousContainerDatabaseDataGuardAssociationDetails: description: 'The configuration details for updating a Autonomous Container DatabaseData Guard association for a Autonomous Container Database. ' properties: fastStartFailOverLagLimitInSeconds: description: The lag time for my preference based on data loss tolerance in seconds. maximum: 3600 minimum: 5 type: integer isAutomaticFailoverEnabled: description: 'Indicates whether Automatic Failover is enabled for Autonomous Container Database Dataguard Association ' type: boolean protectionMode: description: 'The protection mode of this Autonomous Data Guard association. For more information, see [Oracle Data Guard Protection Modes](http://docs.oracle.com/database/122/SBYDB/oracle-data-guard-protection-modes.htm#SBYDB02000) in the Oracle Data Guard documentation. ' enum: - MAXIMUM_AVAILABILITY - MAXIMUM_PERFORMANCE type: string DatabaseCredentialDetails: description: 'Data for the credential used to connect to the database. ' properties: passwordSecretId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [secret](/Content/KeyManagement/Concepts/keyoverview.htm#concepts). maxLength: 255 minLength: 1 type: string userName: description: The name of the Oracle Database user that will be used to connect to the database. maxLength: 255 minLength: 1 type: string required: - userName - passwordSecretId AutonomousVirtualMachineSummary: description: 'Details of the Autonomous Virtual Machine. ' properties: autonomousVmClusterId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Autonomous VM Cluster associated with the Autonomous Virtual Machine. maxLength: 255 minLength: 1 type: string clientIpAddress: description: Client IP Address. maxLength: 255 minLength: 1 type: string cloudAutonomousVmClusterId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Cloud Autonomous VM Cluster associated with the Autonomous Virtual Machine. maxLength: 255 minLength: 1 type: string compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string cpuCoreCount: description: The number of CPU cores enabled on the Autonomous Virtual Machine. type: integer dbNodeStorageSizeInGBs: description: The allocated local node storage in GBs on the Autonomous Virtual Machine. type: integer dbServerDisplayName: description: The display name of the dbServer associated with the Autonomous Virtual Machine. maxLength: 255 minLength: 1 type: string dbServerId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Db server associated with the Autonomous Virtual Machine. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Autonomous Virtual Machine. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of the Autonomous Virtual Machine. enum: - PROVISIONING - AVAILABLE - UPDATING - TERMINATING - TERMINATED - FAILED - MAINTENANCE_IN_PROGRESS type: string memorySizeInGBs: description: The allocated memory in GBs on the Autonomous Virtual Machine. type: integer vmName: description: The name of the Autonomous Virtual Machine. maxLength: 255 minLength: 1 type: string required: - id - lifecycleState Patch: allOf: - $ref: '#/components/schemas/PatchSummary' CreatePluggableDatabaseSnapshotDetails: description: 'Details to create a Pluggable Database Snapshot. ' properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object name: description: The user-friendly name for the Database Snapshot. The name should be unique. maxLength: 255 minLength: 1 type: string pluggableDatabaseId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata Pluggable Database. maxLength: 255 minLength: 1 type: string required: - name - pluggableDatabaseId DbSystemOsPatchDetailsCollection: description: Results of OS patch details for a DB System. properties: items: description: Array of OS patch details for a DB System. items: $ref: '#/components/schemas/DbSystemOsPatchDetailsSummary' type: array required: - items type: object CreateExecutionActionDetails: description: 'Request to create execution action resource. ' properties: actionMembers: description: List of action members of this execution action. items: $ref: '#/components/schemas/ExecutionActionMember' maxItems: 200 type: array actionParams: additionalProperties: type: string description: 'Map where a key value pair describes the specific action parameter. Example: `{"count": "3"}` ' maxProperties: 100 type: object actionType: description: The action type of the execution action being performed enum: - DB_SERVER_FULL_SOFTWARE_UPDATE - STORAGE_SERVER_FULL_SOFTWARE_UPDATE - NETWORK_SWITCH_FULL_SOFTWARE_UPDATE - DB_SERVER_ONLINE_SOFTWARE_UPDATE type: string compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object executionWindowId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the execution window resource the execution action belongs to. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object required: - executionWindowId - actionType DbConnectionBundleSummary: description: Summary of a database connection bundle. properties: associatedResourceDetails: description: Details about the resources associated with the connection bundle. items: $ref: '#/components/schemas/AssociatedResourceDetails' type: array compartmentId: description: The OCID of the compartment containing the database connection bundle. maxLength: 255 minLength: 1 type: string dbConnectionBundleType: description: The type of the database connection bundle. enum: - TLS - MTLS type: string definedTags: additionalProperties: additionalProperties: type: string type: object description: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). type: object displayName: description: Display name for the connection bundle. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). type: object id: description: The OCID of the database connection bundle. maxLength: 255 minLength: 1 type: string isProtected: description: True for the default, service-created Database Connection Bundle. type: boolean lifecycleState: description: The current lifecycle state of the database connection bundle. enum: - CREATING - ACTIVE - INACTIVE - UPDATING - DELETING - DELETED - FAILED type: string systemTags: additionalProperties: additionalProperties: type: string readOnly: true type: object description: System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). type: object timeCreated: description: The time the database connection bundle was created. An RFC3339 formatted datetime string. format: date-time type: string timeLastRefreshed: description: The time the database connection bundle was last refreshed. An RFC3339 formatted datetime string. format: date-time type: string timeUpdated: description: The time the database connection bundle was updated. An RFC3339 formatted datetime string. format: date-time type: string required: - id - compartmentId - lifecycleState - timeCreated - timeUpdated - dbConnectionBundleType - isProtected - displayName - freeformTags - definedTags - systemTags type: object Backup: allOf: - $ref: '#/components/schemas/BackupSummary' SystemVersionSummary: description: List of compatible Exadata system versions for a given shape and GI version. properties: giVersion: description: Grid Infrastructure version. type: string shape: description: Exadata shape. type: string systemVersions: description: Compatible Exadata system versions for a given shape and GI version. items: type: string maxItems: 500 type: array required: - shape - giVersion type: object ExternalNonContainerDatabaseSummary: allOf: - $ref: '#/components/schemas/ExternalDatabaseBase' - properties: operationsInsightsConfig: $ref: '#/components/schemas/OperationsInsightsConfig' type: object description: 'An Oracle Cloud Infrastructure external non-container database resource. This resource is used to manage a non-container database located outside of Oracle Cloud. ' LaunchAutonomousExadataInfrastructureDetails: description: 'Describes the input parameters to launch a new Autonomous Exadata Infrastructure. ' properties: availabilityDomain: description: The availability domain where the Autonomous Exadata Infrastructure is located. maxLength: 255 minLength: 1 type: string compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment the Autonomous Exadata Infrastructure belongs in. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object displayName: description: The user-friendly name for the Autonomous Exadata Infrastructure. It does not have to be unique. maxLength: 255 minLength: 1 type: string domain: description: 'A domain name used for the Autonomous Exadata Infrastructure. If the Oracle-provided Internet and VCN Resolver is enabled for the specified subnet, the domain name for the subnet is used (don''t provide one). Otherwise, provide a valid DNS domain name. Hyphens (-) are not permitted. ' type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object licenseModel: description: 'The Oracle license model that applies to all the databases in the Autonomous Exadata Infrastructure. The default is BRING_YOUR_OWN_LICENSE. ' enum: - LICENSE_INCLUDED - BRING_YOUR_OWN_LICENSE type: string maintenanceWindowDetails: $ref: '#/components/schemas/MaintenanceWindow' nsgIds: description: 'The list of [OCIDs](/Content/General/Concepts/identifiers.htm) for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see [Security Rules](/Content/Network/Concepts/securityrules.htm). ' items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array uniqueItems: true shape: description: The shape of the Autonomous Exadata Infrastructure. The shape determines resources allocated to the Autonomous Exadata Infrastructure (CPU cores, memory and storage). To get a list of shapes, use the ListDbSystemShapes operation. maxLength: 255 minLength: 1 type: string subnetId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet the Autonomous Exadata Infrastructure is associated with. **Subnet Restrictions:** - For Autonomous Exadata Infrastructures, do not use a subnet that overlaps with 192.168.128.0/20 These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and backup subnet. ' maxLength: 255 minLength: 1 type: string required: - compartmentId - availabilityDomain - subnetId - shape type: object CreateExascaleDbStorageVaultDetails: description: 'Details to create a Exadata Database Storage Vault. ' properties: additionalFlashCacheInPercent: description: 'The size of additional Flash Cache in percentage of High Capacity database storage. ' format: int32 minimum: 0 type: integer autoscaleLimitInGBs: description: The maximum limit, in gigabytes, to which the Vault storage size can automatically scale when auto scaling is enabled for the Database Storage Vault type: integer availabilityDomain: description: The name of the availability domain in which the Exadata Database Storage Vault is located. maxLength: 255 minLength: 1 type: string clusterPlacementGroupId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cluster placement group of the Exadata Infrastructure. maxLength: 255 minLength: 1 type: string compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object description: description: Exadata Database Storage Vault description. maxLength: 400 minLength: 1 type: string displayName: description: The user-friendly name for the Exadata Database Storage Vault. The name does not need to be unique. maxLength: 255 minLength: 1 type: string exadataInfrastructureId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object highCapacityDatabaseStorage: $ref: '#/components/schemas/ExascaleDbStorageInputDetails' isAutoscaleEnabled: description: Indicates if autoscale feature is enabled for the Database Storage Vault. The default value is `FALSE`. type: boolean subscriptionId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the subscription with which resource needs to be associated with. maxLength: 255 minLength: 1 type: string timeZone: description: 'The time zone that you want to use for the Exadata Database Storage Vault. For details, see [Time Zones](/Content/Database/References/timezones.htm). ' maxLength: 255 minLength: 1 type: string required: - compartmentId - displayName - highCapacityDatabaseStorage - availabilityDomain ExecutionWindowSummary: description: 'Details of an execution window. ' properties: compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object description: description: Description of the execution window. maxLength: 255 minLength: 1 type: string displayName: description: The user-friendly name for the execution window. The name does not need to be unique. maxLength: 255 minLength: 1 type: string estimatedTimeInMins: description: The estimated time of the execution window in minutes. minimum: 0 type: integer executionResourceId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the execution resource the execution window belongs to. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the execution window. maxLength: 255 minLength: 1 type: string isEnforcedDuration: default: false description: Indicates if duration the user plans to allocate for scheduling window is strictly enforced. The default value is `FALSE`. type: boolean lifecycleDetails: description: Additional information about the current lifecycle state. type: string lifecycleState: description: 'The current state of the Schedule Policy. Valid states are CREATED, SCHEDULED, IN_PROGRESS, FAILED, CANCELED, UPDATING, DELETED, SUCCEEDED and PARTIAL_SUCCESS. ' enum: - CREATED - SCHEDULED - IN_PROGRESS - FAILED - CANCELED - UPDATING - DELETED - SUCCEEDED - PARTIAL_SUCCESS type: string lifecycleSubstate: description: 'The current sub-state of the execution window. Valid states are DURATION_EXCEEDED, MAINTENANCE_IN_PROGRESS and WAITING. ' enum: - DURATION_EXCEEDED - MAINTENANCE_IN_PROGRESS - WAITING type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object timeCreated: description: The date and time the execution window was created. format: date-time type: string timeEnded: description: The date and time that the execution window ended. format: date-time type: string timeScheduled: description: The scheduled start date and time of the execution window. format: date-time type: string timeStarted: description: The date and time that the execution window was started. format: date-time type: string timeUpdated: description: The last date and time that the execution window was updated. format: date-time type: string windowDurationInMins: description: 'Duration window allows user to set a duration they plan to allocate for Scheduling window. The duration is in minutes. ' minimum: 120 type: integer windowType: description: The execution window is of PLANNED or UNPLANNED type. enum: - PLANNED - UNPLANNED type: string required: - id - compartmentId - displayName - lifecycleState - timeScheduled - executionResourceId - windowDurationInMins type: object VmClusterUpdateHistoryEntry: allOf: - $ref: '#/components/schemas/VmClusterUpdateHistoryEntrySummary' description: 'The record of a maintenance update action performed on a specified VM cluster. Applies to Exadata Cloud@Customer instances only. ' ResourcePoolMemberSummary: description: An Autonomous AI Database resource pool member summary. properties: id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Autonomous AI Database. maxLength: 255 minLength: 1 type: string required: - id AddVirtualMachineToVmClusterDetails: description: 'Details of adding Virtual Machines to the VM Cluster. Applies to Exadata Cloud@Customer instances only. ' properties: dbServers: description: The list of Exacc DB servers for the cluster to be added. items: $ref: '#/components/schemas/DbServerDetails' type: array required: - dbServers PrincipalTokenDetails: description: 'This is a JsonWebToken JWT containing all the mapping information between the instance and the resource. ' properties: resourcePrincipalToken: description: The base64 encoded intermediate Resource Principal Token. type: string servicePrincipalSessionToken: description: The base64 encoded Session Token of the Service Principal that provided the intermediate Resource Principal Token. type: string required: - resourcePrincipalToken - servicePrincipalSessionToken ChangeExascaleDbStorageVaultSubscriptionDetails: allOf: - $ref: '#/components/schemas/ChangeSubscriptionDetails' description: 'The configuration details for associating the Exadata Database Storage Vault with a different subscription. ' CreateApplicationVipDetails: description: 'Details to create an application virtual IP (VIP) address on a cloud VM cluster. ' properties: cloudVmClusterId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud VM cluster associated with the application virtual IP (VIP) address. maxLength: 255 minLength: 1 type: string dbNodeId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the DB node associated with the application virtual IP (VIP) address. maxLength: 255 minLength: 1 type: string hostnameLabel: description: The hostname of the application virtual IP (VIP) address. maxLength: 63 minLength: 1 type: string ipAddress: description: The application virtual IP (VIP) IPv4 address. maxLength: 32 minLength: 1 type: string ipv6Address: description: The application virtual IP (VIP) IPv6 address. maxLength: 45 minLength: 1 type: string subnetId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet associated with the application virtual IP (VIP) address. maxLength: 255 minLength: 1 type: string required: - hostnameLabel - cloudVmClusterId RotateCloudAutonomousVmClusterSslCertsDetails: description: 'The details for configuring the SSL certificates on Cloud Autonomous VM Cluster ' properties: caBundleId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the certificate bundle. ' maxLength: 255 minLength: 1 type: string certificateAuthorityId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the certificate authority. ' maxLength: 255 minLength: 1 type: string certificateGenerationType: description: Specify SYSTEM to use Oracle-managed certificates. Specify BYOC when you want to bring your own certificate. enum: - SYSTEM - BYOC type: string certificateId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the certificate to use. ' maxLength: 255 minLength: 1 type: string required: - certificateGenerationType UpdateBackupDetails: description: 'Describes the parameters for updating the backup details. ' properties: retentionPeriodInDays: description: The retention period of the long term backup in days. maximum: 3650 minimum: 90 type: integer retentionPeriodInYears: description: The retention period of the long term backup in years. maximum: 10 minimum: 1 type: integer AutonomousContainerDatabaseBackupCollection: description: A list of all of the Autonomous Container Database Backups in the specified compartment. properties: items: description: List of Autonomous container database backups. items: $ref: '#/components/schemas/AutonomousContainerDatabaseBackupSummary' type: array required: - items RotateCloudAutonomousVmClusterOrdsCertsDetails: description: 'The details for configuring the ORDS certificates on Cloud Autonomous VM Cluster ' properties: caBundleId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the certificate bundle. ' maxLength: 255 minLength: 1 type: string certificateAuthorityId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the certificate authority. ' maxLength: 255 minLength: 1 type: string certificateGenerationType: description: Specify SYSTEM to use Oracle-managed certificates. Specify BYOC when you want to bring your own certificate. enum: - SYSTEM - BYOC type: string certificateId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the certificate to use. ' maxLength: 255 minLength: 1 type: string required: - certificateGenerationType CreateConsoleHistoryDetails: description: 'The details for creating a Db node console history. The Db node console history is created in the same compartment as the dbNode. ' properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object displayName: description: 'The user-friendly name for the console history. The name does not need to be unique. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object required: - displayName AutonomousContainerDatabaseDataguardAssociation: description: 'The properties that define Autonomous Data Guard association between two different Autonomous Container Databases. ' properties: applyLag: description: 'The lag time between updates to the primary Autonomous Container Database and application of the redo data on the standby Autonomous Container Database, as computed by the reporting database. Example: `9 seconds` ' type: string applyRate: description: 'The rate at which redo logs are synchronized between the associated Autonomous Container Databases. Example: `180 Mb per second` ' type: string autonomousContainerDatabaseId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Autonomous Container Database that has a relationship with the peer Autonomous Container Database. Used only by Autonomous AI Database on Dedicated Exadata Infrastructure. ' maxLength: 255 minLength: 1 type: string fastStartFailOverLagLimitInSeconds: description: The lag time for my preference based on data loss tolerance in seconds. maximum: 3600 minimum: 5 type: integer id: description: The OCID of the Autonomous Data Guard created for a given Autonomous Container Database. maxLength: 255 minLength: 1 type: string isAutomaticFailoverEnabled: description: 'Indicates whether Automatic Failover is enabled for Autonomous Container Database Dataguard Association ' type: boolean lifecycleDetails: description: 'Additional information about the current lifecycleState, if available. ' type: string lifecycleState: description: The current state of Autonomous Data Guard. enum: - PROVISIONING - AVAILABLE - ROLE_CHANGE_IN_PROGRESS - TERMINATING - TERMINATED - FAILED - UNAVAILABLE - UPDATING type: string peerAutonomousContainerDatabaseDataguardAssociationId: description: The OCID of the peer Autonomous Container Database-Autonomous Data Guard association. maxLength: 255 minLength: 1 type: string peerAutonomousContainerDatabaseId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the peer Autonomous Container Database. ' maxLength: 255 minLength: 1 type: string peerLifecycleState: description: The current state of the Autonomous Container Database. enum: - PROVISIONING - AVAILABLE - UPDATING - TERMINATING - TERMINATED - FAILED - BACKUP_IN_PROGRESS - RESTORING - RESTORE_FAILED - RESTARTING - MAINTENANCE_IN_PROGRESS - ROLE_CHANGE_IN_PROGRESS - ENABLING_AUTONOMOUS_DATA_GUARD - UNAVAILABLE type: string peerRole: description: 'The Data Guard role of the Autonomous Container Database or Autonomous AI Database, if Autonomous Data Guard is enabled. ' enum: - PRIMARY - STANDBY - DISABLED_STANDBY - BACKUP_COPY - SNAPSHOT_STANDBY type: string protectionMode: description: 'The protection mode of this Autonomous Data Guard association. For more information, see [Oracle Data Guard Protection Modes](http://docs.oracle.com/database/122/SBYDB/oracle-data-guard-protection-modes.htm#SBYDB02000) in the Oracle Data Guard documentation. ' enum: - MAXIMUM_AVAILABILITY - MAXIMUM_PERFORMANCE type: string role: description: 'The Data Guard role of the Autonomous Container Database or Autonomous AI Database, if Autonomous Data Guard is enabled. ' enum: - PRIMARY - STANDBY - DISABLED_STANDBY - BACKUP_COPY - SNAPSHOT_STANDBY type: string timeCreated: description: The date and time the Autonomous DataGuard association was created. format: date-time type: string timeLastRoleChanged: description: The date and time when the last role change action happened. format: date-time type: string timeLastSynced: description: The date and time of the last update to the apply lag, apply rate, and transport lag values. format: date-time type: string transportLag: description: 'The approximate number of seconds of redo data not yet available on the standby Autonomous Container Database, as computed by the reporting database. Example: `7 seconds` ' type: string required: - id - lifecycleState - autonomousContainerDatabaseId - role - peerRole DefinedFileSystemConfiguration: description: Details of the file system configuration of the Exadata infrastructure. properties: isBackupPartition: description: If true, the file system is used to create a backup prior to Exadata VM OS update. type: boolean isResizable: description: If true, the file system resize is allowed for the Exadata Infrastructure cluster. If false, the file system resize is not allowed. type: boolean minSizeGb: description: The minimum size of file system. type: integer mountPoint: description: The mount point of file system. type: string DbNodeDetails: description: 'Details of the ExaCS Db node. Applies to Exadata Database Service on Exascale Infrastructure only. ' properties: dbNodeId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of ExaCS Db node. maxLength: 255 minLength: 1 type: string required: - dbNodeId AutonomousDatabaseSoftwareImageCollection: description: Result of List Autonomous AI Database Software Images. properties: items: description: List of Autonomous AI Database Software Images. items: $ref: '#/components/schemas/AutonomousDatabaseSoftwareImageSummary' type: array required: - items type: object EnableExternalContainerDatabaseDatabaseManagementDetails: allOf: - $ref: '#/components/schemas/EnableExternalDatabaseManagementDetailsBase' - properties: licenseModel: description: 'The Oracle license model that applies to the external database. ' enum: - LICENSE_INCLUDED - BRING_YOUR_OWN_LICENSE type: string required: - licenseModel type: object description: 'Details to enable Database Management on an external container database. ' SourceDatabaseDetails: description: Source Autonomous AI Database details. properties: autonomousContainerDatabaseCustomerContacts: description: 'Customer Contacts for the Autonomous Container Database. Setting this to an empty list removes all customer contacts. ' items: $ref: '#/components/schemas/CustomerContact' type: array autonomousContainerDatabaseDisplayName: description: The user-provided name for the Autonomous Container Database. maxLength: 255 minLength: 1 type: string autonomousContainerDatabaseDstFileVersion: description: DST Time-Zone File version of the Autonomous Container Database. maxLength: 255 minLength: 1 type: string autonomousContainerDatabaseName: description: Autonomous Container Database name. maxLength: 8 minLength: 2 type: string autonomousDatabaseCustomerContacts: description: Customer Contacts for the Autonomous AI Database. items: $ref: '#/components/schemas/CustomerContact' type: array autonomousDatabaseName: description: Autonomous AI Database's name. maxLength: 14 minLength: 1 type: string autonomousVmClusterDisplayName: description: Autonomous VM cluster's user-friendly name. maxLength: 255 minLength: 1 type: string dbWorkload: description: 'The Autonomous AI Database workload type. The following values are valid: - OLTP - indicates an Autonomous AI Transaction Processing database - DW - indicates an Autonomous AI Lakehouse database - AJD - indicates an Autonomous AI JSON Database - APEX - indicates an Autonomous AI Database with the Oracle APEX AI Application Development workload type. - LH - indicates an Oracle Autonomous AI Lakehouse database **Note** Starting December 2026, DW will not be supported as a valid value for this parameter. When creating an Autonomous AI Database, if this parameter is not specified, the default value is `OLTP`. This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. ' enum: - OLTP - DW - AJD - APEX - LH type: string EstimateCostSavingSummary: description: Autonomous AI Database cost savings. properties: costSavingsWithElasticPool: description: Estimated cost savings in percentage with elastic pool utilization. format: double type: number estimatedUsageWithoutElasticPool: description: CPU cost for a given time period under regular billing plan, in ECPU hours. format: int64 type: integer isCpuAutoscale: description: Indicates if CPU autoscaling is applied. type: boolean timeEnded: description: The epoch time at which cost aggregation ends. format: date-time type: string timeStarted: description: The epoch time at which cost aggregation starts. format: date-time type: string usageWithElasticPool: description: CPU cost for a given time period under elastic pool billing plan, in ECPU hours. format: int64 type: integer type: object EncryptionKeyLocationDetails: description: Types of providers supported for managing database encryption keys discriminator: propertyName: providerType properties: providerType: description: 'Use ''EXTERNAL'' for creating a new database or migrating a database key to an External HSM. Use ''AZURE'' for creating a new database or migrating a database key to Azure. ' enum: - EXTERNAL - AZURE type: string x-default-description: 'null' required: - providerType EnableDatabaseManagementDetails: description: 'Data to enable the Database Management service for the database. ' properties: credentialDetails: $ref: '#/components/schemas/DatabaseCredentialDetails' managementType: default: BASIC description: The Database Management type. enum: - BASIC - ADVANCED type: string privateEndPointId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the private endpoint. ' maxLength: 255 minLength: 1 type: string serviceName: description: The name of the Oracle Database service that will be used to connect to the database. maxLength: 255 minLength: 1 type: string required: - credentialDetails - privateEndPointId - serviceName AutonomousExadataInfrastructureSummary: description: '**Deprecated** These APIs are deprecated with the introduction of the Autonomous Exadata VM Cluster resource and a shift to a common Exadata Infrastructure resource for all Exadata Cloud-based services, including Autonomous AI Database on dedicated Exadata infrastructure. For more details, see [Latest Resource Model](https://docs.oracle.com/en/cloud/paas/autonomous-database/flddd/#articletitle). Infrastructure that enables the running of multiple Autonomous AI Databases within a dedicated DB system. For more information about Autonomous Exadata Infrastructure, see [Oracle Autonomous AI Database](https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html). 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). For information about access control and compartments, see [Overview of the Identity Service](/Content/Identity/Concepts/overview.htm). For information about availability domains, see [Regions and Availability Domains](/Content/General/Concepts/regions.htm). To get a list of availability domains, use the ListAvailabilityDomains operation in the Identity service API. ' properties: availabilityDomain: description: The name of the availability domain that the Autonomous Exadata Infrastructure is located in. maxLength: 255 minLength: 1 type: string compartmentId: description: The OCID of the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object displayName: description: The user-friendly name for the Autonomous Exadata Infrastructure. maxLength: 255 minLength: 1 type: string domain: description: The domain name for the Autonomous Exadata Infrastructure. type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object hostname: description: The host name for the Autonomous Exadata Infrastructure node. type: string id: description: The OCID of the Autonomous Exadata Infrastructure. maxLength: 255 minLength: 1 type: string lastMaintenanceRunId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the last maintenance run. maxLength: 255 minLength: 1 type: string licenseModel: description: 'The Oracle license model that applies to all databases in the Autonomous Exadata Infrastructure. The default is BRING_YOUR_OWN_LICENSE. ' enum: - LICENSE_INCLUDED - BRING_YOUR_OWN_LICENSE type: string lifecycleDetails: description: Additional information about the current lifecycle state of the Autonomous Exadata Infrastructure. type: string lifecycleState: description: The current lifecycle state of the Autonomous Exadata Infrastructure. enum: - PROVISIONING - AVAILABLE - UPDATING - TERMINATING - TERMINATED - FAILED - MAINTENANCE_IN_PROGRESS type: string maintenanceWindow: $ref: '#/components/schemas/MaintenanceWindow' nextMaintenanceRunId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the next maintenance run. maxLength: 255 minLength: 1 type: string nsgIds: description: 'The list of [OCIDs](/Content/General/Concepts/identifiers.htm) for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see [Security Rules](/Content/Network/Concepts/securityrules.htm). ' items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array uniqueItems: true scanDnsName: description: 'The FQDN of the DNS record for the SCAN IP addresses that are associated with the Autonomous Exadata Infrastructure. ' maxLength: 72 minLength: 1 type: string shape: description: The shape of the Autonomous Exadata Infrastructure. The shape determines resources to allocate to the Autonomous Exadata Infrastructure (CPU cores, memory and storage). maxLength: 255 minLength: 1 type: string subnetId: description: 'The OCID of the subnet the Autonomous Exadata Infrastructure is associated with. **Subnet Restrictions:** - For Autonomous AI Databases with Autonomous Exadata Infrastructure, do not use a subnet that overlaps with 192.168.128.0/20 These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and backup subnet. ' maxLength: 255 minLength: 1 type: string timeCreated: description: The date and time the Autonomous Exadata Infrastructure was created. format: date-time type: string zoneId: description: 'The OCID of the zone the Autonomous Exadata Infrastructure is associated with. ' maxLength: 255 minLength: 1 type: string required: - id - compartmentId - lifecycleState - displayName - availabilityDomain - subnetId - shape - hostname - domain - maintenanceWindow ExascaleDbStorageDetails: description: 'Exadata Database Storage Details ' properties: availableSizeInGbs: description: 'Available Capacity ' format: int32 type: integer totalSizeInGbs: description: 'Total Capacity ' format: int32 type: integer BackupDestinationDetailsSummary: allOf: - $ref: '#/components/schemas/BackupDestinationDetails' - properties: backupDestinationAttachHistory: description: The timestamps at which this backup destination is used as the preferred destination to host the Autonomous Container Database backups. items: format: date-time type: string type: array spaceUtilizedInGBs: description: The total space utilized (in GBs) by this Autonomous Container Database on this backup destination, rounded to the nearest integer. type: integer timeAtWhichStorageDetailsAreUpdated: description: The latest timestamp when the backup destination details, such as 'spaceUtilized,' are updated. format: date-time type: string type: object description: Information about the backup destination associated with the Autonomous Container Database. ExadataIormConfig: description: 'The IORM settings of the Exadata DB system. ' properties: dbPlans: description: 'An array of IORM settings for all the database in the Exadata DB system. ' items: $ref: '#/components/schemas/dbIormConfig' type: array lifecycleDetails: description: 'Additional information about the current `lifecycleState`. ' type: string lifecycleState: description: 'The current state of IORM configuration for the Exadata DB system. ' enum: - BOOTSTRAPPING - ENABLED - DISABLED - UPDATING - FAILED type: string objective: description: 'The current value for the IORM objective. The default is `AUTO`. ' enum: - LOW_LATENCY - HIGH_THROUGHPUT - BALANCED - AUTO - BASIC type: string type: object CloudExadataInfrastructureUnallocatedResources: description: 'Details of unallocated resources of the Cloud Exadata infrastructure. Applies to Cloud Exadata infrastructure instances only. ' properties: cloudAutonomousVmClusters: description: The list of Cloud Autonomous VM Clusters on the Infrastructure and their associated unallocated resources details. items: $ref: '#/components/schemas/CloudAutonomousVmClusterResourceDetails' type: array cloudExadataInfrastructureDisplayName: description: The user-friendly name for the Cloud Exadata infrastructure. The name does not need to be unique. maxLength: 255 minLength: 1 type: string cloudExadataInfrastructureId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Cloud Exadata infrastructure. maxLength: 255 minLength: 1 type: string exadataStorageInTBs: description: Total unallocated exadata storage in the infrastructure in TBs. format: double type: number localStorageInGbs: description: The minimum amount of unallocated storage available across all nodes in the infrastructure. type: integer memoryInGBs: description: The minimum amount of unallocated memory available across all nodes in the infrastructure. type: integer ocpus: description: The minimum amount of unallocated ocpus available across all nodes in the infrastructure. type: integer required: - cloudExadataInfrastructureId - cloudExadataInfrastructureDisplayName ScheduledAction: allOf: - $ref: '#/components/schemas/ScheduledActionSummary' description: 'Details of a Scheduled Action. ' ExternalContainerDatabase: allOf: - $ref: '#/components/schemas/ExternalDatabaseBase' description: 'An Oracle Cloud Infrastructure resource that allows you to manage an external container database. ' DataGuardGroupMember: description: The member of a Data Guard group. Represents either a PRIMARY or a STANDBY Data Guard instance. properties: applyLag: description: 'The lag time between updates to the primary database and application of the redo data on the standby database, as computed by the reporting database. Example: `1 second` ' type: string applyRate: description: 'The rate at which redo logs are synced between the associated databases. Example: `102.96 MByte/s` ' type: string databaseId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Database. type: string dbSystemId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the DB system, Cloud VM cluster or VM cluster. type: string isActiveDataGuardEnabled: description: True if active Data Guard is enabled. type: boolean role: description: The role of the reporting database in this Data Guard association. enum: - PRIMARY - STANDBY - DISABLED_STANDBY type: string transportLag: description: 'The rate at which redo logs are transported between the associated databases. Example: `1 second` ' type: string transportLagRefresh: description: The date and time when last redo transport has been done. type: string transportType: description: 'The redo transport type to use for this Data Guard association. Valid values depend on the specified `protectionMode`: * MAXIMUM_AVAILABILITY - SYNC or FASTSYNC * MAXIMUM_PERFORMANCE - ASYNC * MAXIMUM_PROTECTION - SYNC For more information, see [Redo Transport Services](http://docs.oracle.com/database/122/SBYDB/oracle-data-guard-redo-transport-services.htm#SBYDB00400) in the Oracle Data Guard documentation. **IMPORTANT** - The only transport type currently supported by the Database service is ASYNC. ' enum: - SYNC - ASYNC - FASTSYNC type: string required: - dbSystemId - databaseId - role type: object CreateExternalDatabaseConnectorDetails: description: 'Details for creating an external database connector resource. ' discriminator: propertyName: connectorType properties: connectorType: default: MACS description: The type of connector used by the external database resource. enum: - MACS type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object displayName: description: 'The user-friendly name for the [external database connector](#/en/database/latest/datatypes/CreateExternalDatabaseConnectorDetails). The name does not have to be unique. ' maxLength: 255 minLength: 1 type: string externalDatabaseId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external database resource. type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object required: - displayName - externalDatabaseId ExternalDatabaseConnectorSummary: description: 'An Oracle Cloud Infrastructure resource used to connect to an external Oracle Database. This resource stores the database connection string, user credentials, and related details that allow you to manage your external database using the Oracle Cloud Infrastructure Console and API interfaces. ' discriminator: propertyName: connectorType properties: compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string connectionStatus: description: The status of connectivity to the external database. type: string connectorType: default: MACS description: The type of connector used by the external database resource. enum: - MACS type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object displayName: description: 'The user-friendly name for the [external database connector](#/en/database/latest/datatypes/CreateExternalDatabaseConnectorDetails). The name does not have to be unique. ' maxLength: 255 minLength: 1 type: string externalDatabaseId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external database resource. type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the [external database connector](#/en/database/latest/datatypes/CreateExternalDatabaseConnectorDetails). ' maxLength: 255 minLength: 1 type: string lifecycleDetails: description: Additional information about the current lifecycle state. type: string lifecycleState: description: The current lifecycle state of the external database connector resource. type: string x-obmcs-enumref: '#/definitions/ExternalDatabaseConnector/lifecycleState' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object timeConnectionStatusLastUpdated: description: The date and time the `connectionStatus` of this external connector was last updated. format: date-time type: string timeCreated: description: The date and time the external connector was created. format: date-time type: string required: - id - compartmentId - displayName - lifecycleState - timeCreated - connectorType - externalDatabaseId - connectionStatus - timeConnectionStatusLastUpdated AddStandbyAutonomousContainerDatabaseDetails: description: 'Create Standby Autonomous Container Database to an existing Autonomous Container Database ' properties: fastStartFailOverLagLimitInSeconds: description: The lag time for my preference based on data loss tolerance in seconds. maximum: 3600 minimum: 5 type: integer isAutomaticFailoverEnabled: description: 'Indicates whether Automatic Failover is enabled for Autonomous Container Database Dataguard Association ' type: boolean peerAutonomousContainerDatabaseBackupConfig: $ref: '#/components/schemas/PeerAutonomousContainerDatabaseBackupConfig' peerAutonomousContainerDatabaseCompartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment where the standby Autonomous Container Database will be created. ' maxLength: 255 minLength: 1 type: string peerAutonomousContainerDatabaseDisplayName: description: The display name for the peer Autonomous Container Database. maxLength: 255 minLength: 1 type: string peerAutonomousVmClusterId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the peer Autonomous Exadata VM Cluster. maxLength: 255 minLength: 1 type: string peerCloudAutonomousVmClusterId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the peer cloud Autonomous Exadata VM Cluster. maxLength: 255 minLength: 1 type: string peerDbUniqueName: description: 'Specifies the `DB_UNIQUE_NAME` of the peer database to be created. ' maxLength: 32 minLength: 1 type: string protectionMode: description: 'The protection mode of this Autonomous Data Guard association. For more information, see [Oracle Data Guard Protection Modes](http://docs.oracle.com/database/122/SBYDB/oracle-data-guard-protection-modes.htm#SBYDB02000) in the Oracle Data Guard documentation. ' enum: - MAXIMUM_AVAILABILITY - MAXIMUM_PERFORMANCE type: string standbyMaintenanceBufferInDays: description: 'The scheduling detail for the quarterly maintenance window of the standby Autonomous Container Database. This value represents the number of days before scheduled maintenance of the primary database. ' maximum: 7 minimum: 1 type: integer UpdateExternalDatabaseConnectorDetails: description: 'Details for updating an external database connector. ' discriminator: propertyName: connectorType properties: connectorType: default: MACS description: The type of connector used by the external database resource. enum: - MACS type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object displayName: description: 'The user-friendly name for the [external database connector](#/en/database/latest/datatypes/CreateExternalDatabaseConnectorDetails). The name does not have to be unique. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object DayOfWeek: description: Day of the week. properties: name: description: Name of the day of the week. enum: - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY - SUNDAY type: string required: - name type: object AutonomousDatabaseBackup: allOf: - $ref: '#/components/schemas/AutonomousDatabaseBackupSummary' description: 'An Autonomous AI Database backup. ' CreateExternalPluggableDatabaseDetails: allOf: - $ref: '#/components/schemas/CreateExternalDatabaseDetailsBase' - properties: externalContainerDatabaseId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the [external container database](#/en/database/latest/datatypes/CreateExternalContainerDatabaseDetails) that contains the specified [external pluggable database](#/en/database/latest/datatypes/CreateExternalPluggableDatabaseDetails) resource. ' type: string sourceId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the the non-container database that was converted to a pluggable database to create this resource. ' type: string required: - externalContainerDatabaseId type: object description: 'Details for creating an external pluggable database resource. ' UpdateScheduledActionDetails: description: 'Describes the modification parameters for the Scheduled Action. ' properties: actionMembers: description: The list of action members in a scheduled action. items: $ref: '#/components/schemas/ActionMember' maxItems: 200 type: array actionParams: additionalProperties: type: string description: 'Map where a key value pair describes the specific action parameter. Example: `{"count": "3"}` ' maxProperties: 100 type: object ApplicationVipSummary: description: 'Details of an application virtual IP (VIP) address. ' properties: cloudVmClusterId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud VM cluster associated with the application virtual IP (VIP) address. maxLength: 255 minLength: 1 type: string compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object hostnameLabel: description: The hostname of the application virtual IP (VIP) address. maxLength: 63 minLength: 1 type: string id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the application virtual IP (VIP) address. maxLength: 255 minLength: 1 type: string ipAddress: description: The application virtual IP (VIP) IPv4 address. maxLength: 32 minLength: 1 type: string ipv6Address: description: The application virtual IP (VIP) IPv6 address. maxLength: 45 minLength: 1 type: string lifecycleDetails: description: Additional information about the current lifecycle state of the application virtual IP (VIP) address. type: string lifecycleState: description: The current lifecycle state of the application virtual IP (VIP) address. enum: - PROVISIONING - AVAILABLE - TERMINATING - TERMINATED - FAILED type: string subnetId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet associated with the application virtual IP (VIP) address. maxLength: 255 minLength: 1 type: string timeAssigned: description: The date and time when the create operation for the application virtual IP (VIP) address completed. format: date-time type: string required: - id - cloudVmClusterId - hostnameLabel - lifecycleState - timeAssigned RemoveVirtualMachineFromCloudVmClusterDetails: description: 'Details of removing Virtual Machines from the Cloud VM Cluster. Applies to Exadata Cloud instances only. ' properties: dbServers: description: The list of ExaDB-D DB server for the cluster to be removed. items: $ref: '#/components/schemas/CloudDbServerDetails' type: array required: - dbServers AutonomousDatabaseWallet: description: 'The Autonomous AI Database wallet details. ' properties: lifecycleState: description: The current lifecycle state of the Autonomous AI Database wallet. enum: - ACTIVE - UPDATING type: string timeDownloaded: description: The date and time the Autonomous AI Database wallet was downloaded. format: date-time type: string timeRotated: description: The date and time the wallet was last rotated. format: date-time type: string AppVersionSummary: description: 'The version details specific to an app. ' properties: endOfSupport: description: The Autonomous Container Database version end of support date. type: string isCertified: description: Indicates if the image is certified. type: boolean releaseDate: description: The Autonomous Container Database version release date. type: string supportedAppName: description: The name of the supported application. type: string required: - releaseDate - endOfSupport - supportedAppName - isCertified x-example: "{\n \"releaseDate\": \"2022-09-23 06:24:34 +00:00\",\n \"endOfSupport\": \"2023-09-23 06:24:34 +00:00\",\n \"supportedAppName\" : \"ADBD_EBS\",\n \"isCertified\": true\n}\n" CreateAutonomousDatabaseSoftwareImageDetails: description: 'Parameters for creating a Autonomous AI Database Software Image ' properties: compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object displayName: description: The user-friendly name for the Autonomous AI Database Software Image. The name does not have to be unique. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object imageShapeFamily: description: To what shape the image is meant for. enum: - EXADATA_SHAPE - EXACC_SHAPE type: string sourceCdbId: description: The source Autonomous Container Database [OCID](/Content/General/Concepts/identifiers.htm) from which to create Autonomous AI Database Software Image. maxLength: 255 minLength: 1 type: string required: - compartmentId - displayName - sourceCdbId - imageShapeFamily ChangeSchedulingPlanCompartmentDetails: description: 'The configuration details for moving the Scheduling Plan. ' properties: compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string required: - compartmentId DataGuardAssociation: allOf: - $ref: '#/components/schemas/DataGuardAssociationSummary' ApplicationVip: allOf: - $ref: '#/components/schemas/ApplicationVipSummary' description: Details of an application virtual IP (VIP) address. DatabaseStorageSizeDetails: description: 'The database storage size details. This database option is supported for the Exadata VM cluster on Exascale Infrastructure. ' properties: dataStorageSizeInGBs: description: 'The DATA storage size, in gigabytes, that is applicable for the database. ' type: integer recoStorageSizeInGBs: description: 'The RECO storage size, in gigabytes, that is applicable for the database. ' type: integer required: - dataStorageSizeInGBs - recoStorageSizeInGBs DbSystemOsPatchDetailsSummary: description: The details of available/applied OS patch on a DB Node. properties: dbNodeId: description: The OCID of the DB node targeted for this patch action. maxLength: 255 minLength: 1 type: string isRebootRequired: description: Indicates whether a reboot is required after applying the patch. type: boolean rpms: description: List of OS package identifiers (e.g., RPM strings). items: type: string maxItems: 2048 type: array required: - rpms - isRebootRequired - dbNodeId type: object UpgradeDatabaseDetails: description: 'Details for upgrading a database to a specific Oracle Database version. ' properties: action: description: The database upgrade action. enum: - PRECHECK - UPGRADE - ROLLBACK type: string databaseUpgradeSourceDetails: $ref: '#/components/schemas/DatabaseUpgradeSourceBase' required: - action SchedulingPolicySummary: description: 'Details of a Scheduling Policy. ' properties: cadence: description: The cadence period. enum: - HALFYEARLY - QUARTERLY - MONTHLY type: string cadenceStartMonth: $ref: '#/components/schemas/Month' description: Start of the month to be followed during the cadence period. compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object displayName: description: The user-friendly name for the Scheduling Policy. The name does not need to be unique. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Scheduling Policy. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: Additional information about the current lifecycle state. type: string lifecycleState: description: 'The current state of the Scheduling Policy. Valid states are CREATING, NEEDS_ATTENTION, ACTIVE, UPDATING, FAILED, DELETING and DELETED. ' enum: - CREATING - NEEDS_ATTENTION - AVAILABLE - UPDATING - FAILED - DELETING - DELETED type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object timeCreated: description: The date and time the Scheduling Policy was created. format: date-time type: string timeNextWindowStarts: description: The date and time of the next scheduling window associated with the schedulingPolicy is planned to start. format: date-time type: string timeUpdated: description: The last date and time that the Scheduling Policy was updated. format: date-time type: string required: - id - compartmentId - displayName - lifecycleState - cadence type: object CloudAutonomousVmCluster: allOf: - $ref: '#/components/schemas/CloudAutonomousVmClusterSummary' - type: object description: 'Details of the cloud Autonomous VM cluster. ' BackupDestinationSummary: description: Backup destination details, including the list of databases using the backup destination. properties: associatedDatabases: description: List of databases associated with the backup destination. items: $ref: '#/components/schemas/AssociatedDatabaseDetails' type: array associatedLongTermBackupCount: description: Indicates the number of long term backups of Autonomous AI Databases associated with this backup destination. type: integer associatedLongTermBackups: description: List of long term backups of Autonomous AI Databases associated with this backup destination.The maximum associated number of long term backup listed here would be 1024. items: $ref: '#/components/schemas/AssociatedLongTermBackup' maxItems: 1024 minItems: 0 type: array compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string connectionString: description: For a RECOVERY_APPLIANCE backup destination, the connection string for connecting to the Recovery Appliance. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object displayName: description: The user-provided name of the backup destination. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the backup destination. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: 'A descriptive text associated with the lifecycleState. Typically contains additional displayable text ' type: string lifecycleState: description: The current lifecycle state of the backup destination. enum: - ACTIVE - FAILED - DELETED type: string localMountPointPath: description: 'The local directory path on each VM cluster node where the NFS server location is mounted. The local directory path and the NFS server location must each be the same across all of the VM cluster nodes. Ensure that the NFS mount is maintained continuously on all of the VM cluster nodes. ' type: string nfsMountType: description: NFS Mount type for backup destination. enum: - SELF_MOUNT - AUTOMATED_MOUNT type: string nfsServer: description: Host names or IP addresses for NFS Auto mount. items: type: string maxItems: 4 minItems: 1 type: array nfsServerExport: description: Specifies the directory on which to mount the file system type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object timeAtWhichStorageDetailsAreUpdated: description: The time when the total storage size and the utilized storage size of the backup destination are updated. format: date-time type: string timeCreated: description: The date and time the backup destination was created. format: date-time type: string totalStorageSizeInGBs: description: The total storage size of the backup destination in GBs, rounded to the nearest integer. type: integer type: description: Type of the backup destination. enum: - NFS - RECOVERY_APPLIANCE type: string utilizedStorageSizeInGBs: description: The total amount of space utilized on the backup destination (in GBs), rounded to the nearest integer. type: integer vpcUsers: description: For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) users that are used to access the Recovery Appliance. items: type: string maxItems: 50 type: array ChangeCloudAutonomousVmClusterCompartmentDetails: description: 'The configuration details for moving the cloud Autonomous VM cluster. ' properties: compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string required: - compartmentId AutonomousDatabasePeerCollection: description: 'The object holds details about the peer Autonomous AI Databases for an Oracle Autonomous AI Database. ' properties: items: description: This array holds details about Autonomous AI Database Peers for Oracle an Autonomous AI Database. items: $ref: '#/components/schemas/AutonomousDatabasePeerSummary' maxItems: 1000 minItems: 0 type: array required: - items type: object DbSystemOsPatchHistoryEntrySummary: description: The summary of an OS patch action history on a DB system. properties: action: description: The action being performed or was completed. enum: - PRECHECK - APPLY type: string dbSystemId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the DB system. maxLength: 255 minLength: 1 type: string id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the OS patch history entry. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: 'A descriptive text associated with the lifecycleState. Typically contains additional displayable text. ' type: string lifecycleState: description: The current state of the action. enum: - IN_PROGRESS - SUCCEEDED - FAILED type: string osPatchDetails: $ref: '#/components/schemas/DbSystemOsPatchDetailsCollection' timeEnded: description: The date and time when the patch action completed format: date-time type: string timeStarted: description: The date and time when the patch action started. format: date-time type: string required: - action - dbSystemId - id - osPatchDetails - lifecycleState - timeStarted type: object UnregisterCloudVmClusterPkcsDetails: description: 'Details of unregistering PKCS11 driver. ' properties: tdeKeyStoreType: description: TDE keystore type enum: - AZURE - OCI type: string x-default-description: 'null' required: - tdeKeyStoreType ActionOrderDetails: description: 'Describes the ordering list of action resources. ' properties: actionOrder: description: The priority order of the action resource. minimum: 1 type: integer actionResourceId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the action resource. maxLength: 255 minLength: 1 type: string UpdateAutonomousContainerDatabaseDetails: description: 'Describes the modification parameters for the Autonomous Container Database. ' properties: backupConfig: $ref: '#/components/schemas/AutonomousContainerDatabaseBackupConfig' customerContacts: description: 'Customer Contacts. Setting this to an empty list removes all customer contacts. ' items: $ref: '#/components/schemas/CustomerContact' type: array dbSplitThreshold: description: The CPU value beyond which an Autonomous AI Database will be opened across multiple nodes. The default value of this attribute is 16 for OCPUs and 64 for ECPUs. minimum: 1 type: integer definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object displayName: description: The display name for the Autonomous Container Database. maxLength: 255 minLength: 1 type: string distributionAffinity: description: Determines whether an Autonomous AI Database must be opened across a minimum or maximum of nodes. By default, Minimum nodes is selected. enum: - MINIMUM_DISTRIBUTION - MAXIMUM_DISTRIBUTION type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object isDstFileUpdateEnabled: description: Indicates if an automatic DST Time Zone file update is enabled for the Autonomous Container Database. If enabled along with Release Update, patching will be done in a Non-Rolling manner. type: boolean maintenanceWindowDetails: $ref: '#/components/schemas/MaintenanceWindow' netServicesArchitecture: default: DEDICATED description: Enabling SHARED server architecture enables a database server to allow many client processes to share very few server processes, thereby increasing the number of supported users. enum: - DEDICATED - SHARED - DRCP type: string okvEndPointGroupName: description: 'The OKV End Point Group name for the Autonomous Container Database. ' maxLength: 128 minLength: 1 type: string patchModel: description: Database Patch model preference. enum: - RELEASE_UPDATES - RELEASE_UPDATE_REVISIONS type: string standbyMaintenanceBufferInDays: description: 'The scheduling detail for the quarterly maintenance window of the standby Autonomous Container Database. This value represents the number of days before schedlued maintenance of the primary database. ' maximum: 7 minimum: 1 type: integer versionPreference: default: NEXT_RELEASE_UPDATE description: 'The next maintenance version preference. ' enum: - NEXT_RELEASE_UPDATE - LATEST_RELEASE_UPDATE type: string vmFailoverReservation: default: 50 description: The percentage of CPUs reserved across nodes to support node failover. Allowed values are 0%, 25%, 50%, 75%, and 100%, with 50% being the default option. type: integer type: object NodeDetails: description: Node details associated with a network. properties: dbServerId: description: The Db server associated with the node. maxLength: 255 minLength: 1 type: string hostname: description: The node host name. maxLength: 255 minLength: 1 type: string ip: description: The node IP address. maxLength: 255 minLength: 1 type: string lifecycleState: description: 'The current state of the VM cluster network nodes. CREATING - The resource is being created REQUIRES_VALIDATION - The resource is created and may not be usable until it is validated. VALIDATING - The resource is being validated and not available to use. VALIDATED - The resource is validated and is available for consumption by VM cluster. VALIDATION_FAILED - The resource validation has failed and might require user input to be corrected. UPDATING - The resource is being updated and not available to use. ALLOCATED - The resource is currently being used by VM cluster. TERMINATING - The resource is being deleted and not available to use. TERMINATED - The resource is deleted and unavailable. FAILED - The resource is in a failed state due to validation or other errors. ' enum: - CREATING - REQUIRES_VALIDATION - VALIDATING - VALIDATED - VALIDATION_FAILED - UPDATING - ALLOCATED - TERMINATING - TERMINATED - FAILED type: string vip: description: The node virtual IP (VIP) address. maxLength: 255 minLength: 1 type: string vipHostname: description: The node virtual IP (VIP) host name. maxLength: 255 minLength: 1 type: string required: - hostname - ip DbSystemUpgradeHistoryEntry: allOf: - $ref: '#/components/schemas/DbSystemUpgradeHistoryEntrySummary' description: 'The record of an OS upgrade action on a DB system. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' ConvertStandbyAutonomousContainerDatabaseDetails: description: 'The configuration details for change Autonomous Container Database Dataguard role ' properties: connectionStringsType: description: type of connection strings when converting database to snapshot mode enum: - SNAPSHOT_SERVICES - PRIMARY_SERVICES type: string role: description: 'The Data Guard role of the Autonomous Container Database or Autonomous AI Database, if Autonomous Data Guard is enabled. ' enum: - PRIMARY - STANDBY - DISABLED_STANDBY - BACKUP_COPY - SNAPSHOT_STANDBY type: string required: - role RotateAutonomousVmClusterSslCertsDetails: description: 'Details for configuring the ORDS certificates on Autonomous Exadata VM Cluster ' properties: caBundleId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the certificate bundle. ' maxLength: 255 minLength: 1 type: string certificateAuthorityId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the certificate authority. ' maxLength: 255 minLength: 1 type: string certificateGenerationType: description: Specify SYSTEM to use Oracle-managed certificates. Specify BYOC when you want to bring your own certificate. enum: - SYSTEM - BYOC type: string certificateId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the certificate to use. ' maxLength: 255 minLength: 1 type: string required: - certificateGenerationType VmCluster: allOf: - $ref: '#/components/schemas/VmClusterSummary' description: 'Details of the VM cluster resource. Applies to Exadata Cloud@Customer instances only. ' EnableExternalPluggableDatabaseDatabaseManagementDetails: allOf: - $ref: '#/components/schemas/EnableExternalDatabaseManagementDetailsBase' description: 'Details to enable Database Management on an external pluggable database. ' MountPointDetails: description: 'Details of the Mount Point. ' properties: dbNodeId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata Database Node where snapshot was mounted. maxLength: 255 minLength: 1 type: string name: description: Mount Point Name maxLength: 255 minLength: 1 type: string required: - name - dbNodeId type: object RefreshableCloneSummary: description: An Autonomous AI Database refreshable clone properties: id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Autonomous AI Database. maxLength: 255 minLength: 1 type: string region: description: The name of the region where the refreshable clone exists. type: string required: - id - region DbSystemOsPatchHistoryEntry: allOf: - $ref: '#/components/schemas/DbSystemOsPatchHistoryEntrySummary' description: 'The record of an OS patch action on a DB system. ' MaintenanceRunHistorySummary: description: Details of a maintenance run history. properties: dbServersHistoryDetails: description: List of database server history details. items: $ref: '#/components/schemas/DbServerHistorySummary' type: array granularMaintenanceHistory: description: The list of granular maintenance history details. items: $ref: '#/components/schemas/GranularMaintenanceHistoryDetails' type: array id: description: The OCID of the maintenance run history. maxLength: 255 minLength: 1 type: string maintenanceRunDetails: $ref: '#/components/schemas/MaintenanceRunSummary' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object required: - id type: object ScheduledActionCollection: description: Results of Scheduled Action resources lists. Contains ScheduledActionSummary items. properties: items: description: List of Scheduled Action resources. items: $ref: '#/components/schemas/ScheduledActionSummary' type: array required: - items type: object ChangeDataguardRoleDetails: description: 'The configuration details for change Autonomous Container Database Dataguard role ' properties: autonomousContainerDatabaseDataguardAssociationId: description: The Autonomous Container Database-Autonomous Data Guard association [OCID](/Content/General/Concepts/identifiers.htm). maxLength: 255 minLength: 1 type: string connectionStringsType: description: type of connection strings when converting database to snapshot mode enum: - SNAPSHOT_SERVICES - PRIMARY_SERVICES type: string role: description: 'The Data Guard role of the Autonomous Container Database or Autonomous AI Database, if Autonomous Data Guard is enabled. ' enum: - PRIMARY - STANDBY - DISABLED_STANDBY - BACKUP_COPY - SNAPSHOT_STANDBY type: string required: - role - autonomousContainerDatabaseDataguardAssociationId CreateSchedulingWindowDetails: description: 'Request to create Scheduling Window resource. ' properties: compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object windowPreference: $ref: '#/components/schemas/WindowPreferenceDetail' required: - windowPreference ExadataInfrastructureUnAllocatedResources: description: 'Displays details of unallocated resources for the Exadata Cloud@Customer infrastructure. Applies to Exadata Cloud@Customer instances only. ' properties: autonomousVmClusters: description: The list of Autonomous VM Clusters on the Infra and their associated unallocated resources details items: $ref: '#/components/schemas/AutonomousVmClusterResourceDetails' type: array displayName: description: The user-friendly name for the Exadata Cloud@Customer infrastructure. The name does not need to be unique. maxLength: 255 minLength: 1 type: string exadataStorageInTBs: description: Total unallocated exadata storage in the infrastructure in TBs. format: double type: number id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure. maxLength: 255 minLength: 1 type: string localStorageInGbs: description: The minimum amount of un allocated storage that is available across all nodes in the infrastructure. type: integer memoryInGBs: description: The minimum amount of un allocated memory that is available across all nodes in the infrastructure. type: integer ocpus: description: The minimum amount of un allocated ocpus that is available across all nodes in the infrastructure. type: integer required: - id - displayName AutonomousDatabaseSummary: description: "An Oracle Autonomous AI Database.\n \n**Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.\n" properties: accessTypes: description: List of access types for an Autonomous AI Database. items: maxLength: 1024 minLength: 1 type: string maxItems: 1024 minItems: 1 type: array actualUsedDataStorageSizeInTBs: description: 'The current amount of storage in use for user and system data, in terabytes (TB). ' format: double type: number allocatedStorageSizeInTBs: description: 'The amount of storage currently allocated for the database tables and billed for, rounded up. When auto-scaling is not enabled, this value is equal to the `dataStorageSizeInTBs` value. You can compare this value to the `actualUsedDataStorageSizeInTBs` value to determine if a manual shrink operation is appropriate for your allocated storage. **Note:** Auto-scaling does not automatically decrease allocated storage when data is deleted from the database. ' format: double type: number apexDetails: $ref: '#/components/schemas/AutonomousDatabaseApex' description: Information about Oracle APEX AI Application Development. arePrimaryWhitelistedIpsUsed: description: 'This field will be null if the Autonomous AI Database is not Data Guard enabled or Access Control is disabled. It''s value would be `TRUE` if Autonomous AI Database is Data Guard enabled and Access Control is enabled and if the Autonomous AI Database uses primary IP access control list (ACL) for standby. It''s value would be `FALSE` if Autonomous AI Database is Data Guard enabled and Access Control is enabled and if the Autonomous AI Database uses different IP access control list (ACL) for standby compared to primary. ' type: boolean autoRefreshFrequencyInSeconds: description: The frequency a refreshable clone is refreshed after auto-refresh is enabled. The minimum is 1 hour. The maximum is 7 days. The date and time that auto-refresh is enabled is controlled by the `timeOfAutoRefreshStart` parameter. maximum: 604800 minimum: 3600 type: integer autoRefreshPointLagInSeconds: description: The time, in seconds, the data of the refreshable clone lags the primary database at the point of refresh. The minimum is 0 minutes (0 mins means refresh to the latest available timestamp). The maximum is 7 days. The lag time increases after refreshing until the next data refresh happens. maximum: 604800 minimum: 0 type: integer autonomousContainerDatabaseId: description: The Autonomous Container Database [OCID](/Content/General/Concepts/identifiers.htm). Used only by Autonomous AI Database on Dedicated Exadata Infrastructure. maxLength: 255 minLength: 1 type: string autonomousMaintenanceScheduleType: description: 'The maintenance schedule type of the Autonomous AI Database Serverless. An EARLY maintenance schedule follows a schedule applying patches prior to the REGULAR schedule. A REGULAR maintenance schedule follows the normal cycle ' enum: - EARLY - REGULAR type: string availabilityDomain: description: The availability domain where the Autonomous AI Database Serverless instance is located. maxLength: 255 minLength: 1 type: string availableUpgradeVersions: description: List of Oracle AI Database versions available for a database upgrade. If there are no version upgrades available, this list is empty. items: maxLength: 255 minLength: 1 type: string type: array backupConfig: $ref: '#/components/schemas/AutonomousDatabaseBackupConfig' byolComputeCountLimit: description: The maximum number of CPUs allowed with a Bring Your Own License (BYOL), including those used for auto-scaling, disaster recovery, tools, etc. Any CPU usage above this limit is considered as License Included and billed. format: float minimum: 2 type: number characterSet: description: 'The character set for the Autonomous AI Database. The default is AL32UTF8. Allowed values are: AL32UTF8, AR8ADOS710, AR8ADOS720, AR8APTEC715, AR8ARABICMACS, AR8ASMO8X, AR8ISO8859P6, AR8MSWIN1256, AR8MUSSAD768, AR8NAFITHA711, AR8NAFITHA721, AR8SAKHR706, AR8SAKHR707, AZ8ISO8859P9E, BG8MSWIN, BG8PC437S, BLT8CP921, BLT8ISO8859P13, BLT8MSWIN1257, BLT8PC775, BN8BSCII, CDN8PC863, CEL8ISO8859P14, CL8ISO8859P5, CL8ISOIR111, CL8KOI8R, CL8KOI8U, CL8MACCYRILLICS, CL8MSWIN1251, EE8ISO8859P2, EE8MACCES, EE8MACCROATIANS, EE8MSWIN1250, EE8PC852, EL8DEC, EL8ISO8859P7, EL8MACGREEKS, EL8MSWIN1253, EL8PC437S, EL8PC851, EL8PC869, ET8MSWIN923, HU8ABMOD, HU8CWI2, IN8ISCII, IS8PC861, IW8ISO8859P8, IW8MACHEBREWS, IW8MSWIN1255, IW8PC1507, JA16EUC, JA16EUCTILDE, JA16SJIS, JA16SJISTILDE, JA16VMS, KO16KSC5601, KO16KSCCS, KO16MSWIN949, LA8ISO6937, LA8PASSPORT, LT8MSWIN921, LT8PC772, LT8PC774, LV8PC1117, LV8PC8LR, LV8RST104090, N8PC865, NE8ISO8859P10, NEE8ISO8859P4, RU8BESTA, RU8PC855, RU8PC866, SE8ISO8859P3, TH8MACTHAIS, TH8TISASCII, TR8DEC, TR8MACTURKISHS, TR8MSWIN1254, TR8PC857, US7ASCII, US8PC437, UTF8, VN8MSWIN1258, VN8VN3, WE8DEC, WE8DG, WE8ISO8859P1, WE8ISO8859P15, WE8ISO8859P9, WE8MACROMAN8S, WE8MSWIN1252, WE8NCR4970, WE8NEXTSTEP, WE8PC850, WE8PC858, WE8PC860, WE8ROMAN8, ZHS16CGB231280, ZHS16GBK, ZHT16BIG5, ZHT16CCDC, ZHT16DBT, ZHT16HKSCS, ZHT16MSWIN950, ZHT32EUC, ZHT32SOPS, ZHT32TRIS ' maxLength: 255 minLength: 1 type: string cloneTableSpaceList: description: A list of the source Autonomous AI Database's table space number(s) used to create this partial clone from the backup. items: type: integer type: array cloneType: description: The Autonomous AI Database clone type. enum: - FULL - METADATA - PARTIAL type: string clusterPlacementGroupId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cluster placement group of the Autonomous Serverless Database. maxLength: 255 minLength: 1 type: string compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string computeCount: description: 'The compute amount (CPUs) available to the database. Minimum and maximum values depend on the compute model and whether the database is an Autonomous AI Database Serverless instance or an Autonomous AI Database on Dedicated Exadata Infrastructure. The ''ECPU'' compute model requires a minimum value of one, for databases in the elastic resource pool and minimum value of two, otherwise. Required when using the `computeModel` parameter. When using `cpuCoreCount` parameter, it is an error to specify computeCount to a non-null value. Providing `computeModel` and `computeCount` is the preferred method for both OCPU and ECPU. ' format: float type: number x-default-description: Null used when unspecified. computeModel: description: 'The compute model of the Base Database, Exadata Infrastructure, VM Cluster and Autonomous AI Database. ' enum: - ECPU - OCPU type: string x-default-description: Null used when unspecified. connectionStrings: $ref: '#/components/schemas/AutonomousDatabaseConnectionStrings' description: The connection string used to connect to the Autonomous AI Database. The username for the Service Console is ADMIN. Use the password you entered when creating the Autonomous AI Database for the password value. connectionUrls: $ref: '#/components/schemas/AutonomousDatabaseConnectionUrls' cpuCoreCount: description: 'The number of CPU cores to be made available to the database. When the ECPU is selected, the value for cpuCoreCount is 0. For Autonomous AI Database on Dedicated Exadata infrastructure, the maximum number of cores is determined by the infrastructure shape. See [Characteristics of Infrastructure Shapes](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbde/) for shape details. **Note:** This parameter cannot be used with the `ocpuCount` parameter. ' maximum: 128 minimum: 1 type: integer customerContacts: description: Customer Contacts. items: $ref: '#/components/schemas/CustomerContact' type: array dataSafeStatus: description: Status of the Data Safe registration for this Autonomous AI Database. enum: - REGISTERING - REGISTERED - DEREGISTERING - NOT_REGISTERED - FAILED type: string dataStorageSizeInGBs: description: 'The quantity of data in the database, in gigabytes. For Autonomous AI Transaction Processing databases using ECPUs on Serverless Infrastructure, this value is always populated. In all the other cases, this value will be null and `dataStorageSizeInTBs` will be populated instead. ' type: integer dataStorageSizeInTBs: description: 'The quantity of data in the database, in terabytes. The following points apply to Autonomous AI Databases on Serverless Infrastructure: - This is an integer field whose value remains null when the data size is in GBs and cannot be converted to TBs (by dividing the GB value by 1024) without rounding error. - To get the exact value of data storage size without rounding error, please see `dataStorageSizeInGBs` of Autonomous AI Database. ' type: integer databaseEdition: description: 'The Oracle AI Database Edition that applies to the Autonomous AI Databases. ' enum: - STANDARD_EDITION - ENTERPRISE_EDITION type: string databaseManagementStatus: description: Status of Database Management for this Autonomous AI Database. enum: - ENABLING - ENABLED - DISABLING - NOT_ENABLED - FAILED_ENABLING - FAILED_DISABLING type: string dataguardRegionType: description: '**Deprecated.** The Autonomous Data Guard region type of the Autonomous AI Database. For Autonomous AI Database Serverless, Autonomous Data Guard associations have designated primary and standby regions, and these region types do not change when the database changes roles. The standby regions in Autonomous Data Guard associations can be the same region designated as the primary region, or they can be remote regions. Certain database administrative operations may be available only in the primary region of the Autonomous Data Guard association, and cannot be performed when the database using the primary role is operating in a remote Autonomous Data Guard standby region. ' enum: - PRIMARY_DG_REGION - REMOTE_STANDBY_DG_REGION type: string dbName: description: The database name. maxLength: 14 minLength: 1 type: string dbToolsDetails: description: 'The list of database tools details. This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, isLocalDataGuardEnabled, or isFreeTier. ' items: $ref: '#/components/schemas/DatabaseTool' type: array x-default-description: 'null' dbVersion: description: 'A valid Oracle AI Database version for Autonomous AI Database. When you specify 23ai for dbversion, the system will provision a 23ai database, but the UI will display it as 26ai. When you specify 26ai for dbversion, the system will provision and display a 26ai database as expected. For new databases, it is recommended to use either 19c or 26ai. **Note** Starting December 2026, 23ai will not be supported as a valid value for this parameter. ' maxLength: 255 minLength: 1 type: string dbWorkload: description: 'The Autonomous AI Database workload type. The following values are valid: - OLTP - indicates an Autonomous AI Transaction Processing database - DW - indicates an Autonomous AI Lakehouse database - AJD - indicates an Autonomous AI JSON Database - APEX - indicates an Autonomous AI Database with the Oracle APEX AI Application Development workload type. - LH - indicates an Oracle Autonomous AI Lakehouse database **Note** Starting December 2026, DW will not be supported as a valid value for this parameter. When creating an Autonomous AI Database, if this parameter is not specified, the default value is `OLTP`. This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. ' enum: - OLTP - DW - AJD - APEX - LH type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object disasterRecoveryRegionType: description: '**Deprecated.** The disaster recovery (DR) region type of the Autonomous AI Database. For Autonomous AI Database Serverless instances, DR associations have designated primary and standby regions. These region types do not change when the database changes roles. The standby region in DR associations can be the same region as the primary region, or they can be in a remote regions. Some database administration operations may be available only in the primary region of the DR association, and cannot be performed when the database using the primary role is operating in a remote region. ' enum: - PRIMARY - REMOTE type: string displayName: description: The user-friendly name for the Autonomous AI Database. The name does not have to be unique. maxLength: 255 minLength: 1 type: string encryptionKey: $ref: '#/components/schemas/AutonomousDatabaseEncryptionKeyDetails' encryptionKeyHistoryEntry: description: Key History Entry. items: $ref: '#/components/schemas/AutonomousDatabaseEncryptionKeyHistoryEntry' type: array failedDataRecoveryInSeconds: description: Indicates the number of seconds of data loss for a Data Guard failover. type: integer freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Autonomous AI Database. maxLength: 255 minLength: 1 type: string inMemoryAreaInGBs: description: The area assigned to In-Memory tables in Autonomous AI Database. type: integer inMemoryPercentage: description: The percentage of the System Global Area(SGA) assigned to In-Memory tables in Autonomous AI Database. This property is applicable only to Autonomous AI Databases on the Exadata Cloud@Customer platform. minimum: 0 type: integer infrastructureType: description: 'The infrastructure type this resource belongs to. ' enum: - CLOUD - CLOUD_AT_CUSTOMER type: string isAccessControlEnabled: description: "Indicates if the database-level access control is enabled.\nIf disabled, database access is defined by the network security rules.\nIf enabled, database access is restricted to the IP addresses defined by the rules specified with the `whitelistedIps` property. While specifying `whitelistedIps` rules is optional,\n if database-level access control is enabled and no rules are specified, the database will become inaccessible. The rules can be added later using the `UpdateAutonomousDatabase` API operation or edit option in console.\nWhen creating a database clone, the desired access control setting should be specified. By default, database-level access control will be disabled for the clone.\n\nThis property is applicable only to Autonomous AI Databases on the Exadata Cloud@Customer platform. For Autonomous AI Database Serverless instances, `whitelistedIps` is used.\n" type: boolean isAutoScalingEnabled: description: 'Indicates if auto scaling is enabled for the Autonomous AI Database CPU core count. The default value is `FALSE`. ' type: boolean isAutoScalingForStorageEnabled: description: 'Indicates if auto scaling is enabled for the Autonomous AI Database storage. The default value is `FALSE`. ' type: boolean isBackupRetentionLocked: description: Indicates if the Autonomous AI Database is backup retention locked. type: boolean isDataGuardEnabled: description: '**Deprecated.** Indicates whether the Autonomous AI Database has local (in-region) Data Guard enabled. Not applicable to cross-region Autonomous Data Guard associations, or to Autonomous AI Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure. ' type: boolean isDedicated: description: 'True if the database uses [dedicated Exadata infrastructure](https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html). ' type: boolean isDevTier: default: false description: 'Autonomous AI Database for Developers are fixed-shape Autonomous AI Databases that developers can use to build and test new applications. On Serverless, these are low-cost and billed per instance, on Dedicated and Cloud@Customer there is no additional cost to create Developer databases. Developer databases come with limited resources and is not intended for large-scale testing and production deployments. When you need more compute or storage resources, you may upgrade to a full paid production database. ' type: boolean isFreeTier: default: false description: 'Indicates if this is an Always Free resource. The default value is false. Note that Always Free Autonomous AI Databases have 1 CPU and 20GB of memory. For Always Free databases, memory and CPU cannot be scaled. This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, or isLocalDataGuardEnabled ' type: boolean isLocalDataGuardEnabled: description: Indicates whether the Autonomous AI Database has local (in-region) Data Guard enabled. Not applicable to cross-region Autonomous Data Guard associations, or to Autonomous AI Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure. type: boolean isMtlsConnectionRequired: description: 'Specifies if the Autonomous AI Database requires mTLS connections. This may not be updated in parallel with any of the following: licenseModel, databaseEdition, cpuCoreCount, computeCount, dataStorageSizeInTBs, whitelistedIps, openMode, permissionLevel, db-workload, privateEndpointLabel, nsgIds, customerContacts, dbVersion, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. Service Change: The default value of the isMTLSConnectionRequired attribute will change from true to false on July 1, 2023 in the following APIs: - CreateAutonomousDatabase - GetAutonomousDatabase - UpdateAutonomousDatabase Details: Prior to the July 1, 2023 change, the isMTLSConnectionRequired attribute default value was true. This applies to Autonomous AI Database Serverless. Does this impact me? If you use or maintain custom scripts or Terraform scripts referencing the CreateAutonomousDatabase, GetAutonomousDatabase, or UpdateAutonomousDatabase APIs, you want to check, and possibly modify, the scripts for the changed default value of the attribute. Should you choose not to leave your scripts unchanged, the API calls containing this attribute will continue to work, but the default value will switch from true to false. How do I make this change? Using either OCI SDKs or command line tools, update your custom scripts to explicitly set the isMTLSConnectionRequired attribute to true. ' type: boolean isPreview: description: Indicates if the Autonomous AI Database version is a preview version. type: boolean isReconnectCloneEnabled: description: Indicates if the refreshable clone can be reconnected to its source database. type: boolean isRefreshableClone: description: 'Indicates if the Autonomous AI Database is a refreshable clone. This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. ' type: boolean isRemoteDataGuardEnabled: description: Indicates whether the Autonomous AI Database has Cross Region Data Guard enabled. Not applicable to Autonomous AI Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure. type: boolean keyHistoryEntry: description: Key History Entry. items: $ref: '#/components/schemas/AutonomousDatabaseKeyHistoryEntry' type: array keyStoreId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the key store of Oracle Vault. maxLength: 255 minLength: 1 type: string keyStoreWalletName: description: The wallet name for Oracle Key Vault. maxLength: 255 minLength: 1 type: string kmsKeyId: description: The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. maxLength: 255 minLength: 1 type: string kmsKeyLifecycleDetails: description: KMS key lifecycle details. type: string kmsKeyVersionId: description: 'The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous AI Database Serverless does not use key versions, hence is not applicable for Autonomous AI Database Serverless instances. ' maxLength: 255 minLength: 1 type: string licenseModel: description: 'The Oracle license model that applies to the Oracle Autonomous AI Database. Bring your own license (BYOL) allows you to apply your current on-premises Oracle software licenses to equivalent, highly automated Oracle services in the cloud. License Included allows you to subscribe to new Oracle AI Database software licenses and the Oracle AI Database service. Note that when provisioning an [Autonomous AI Database on dedicated Exadata infrastructure](https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html), this attribute must be null. It is already set at the Autonomous Exadata Infrastructure level. When provisioning an [Autonomous AI Database Serverless] (https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html) database, if a value is not specified, the system defaults the value to `BRING_YOUR_OWN_LICENSE`. Bring your own license (BYOL) also allows you to select the DB edition using the optional parameter. This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, dataStorageSizeInTBs, adminPassword, isMTLSConnectionRequired, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, dbName, scheduledOperations, dbToolsDetails, or isFreeTier. ' enum: - LICENSE_INCLUDED - BRING_YOUR_OWN_LICENSE type: string lifecycleDetails: description: Information about the current lifecycle state. type: string lifecycleState: description: The current state of the Autonomous AI Database. enum: - PROVISIONING - AVAILABLE - STOPPING - STOPPED - STARTING - TERMINATING - TERMINATED - UNAVAILABLE - RESTORE_IN_PROGRESS - RESTORE_FAILED - BACKUP_IN_PROGRESS - SCALE_IN_PROGRESS - AVAILABLE_NEEDS_ATTENTION - UPDATING - MAINTENANCE_IN_PROGRESS - RESTARTING - RECREATING - ROLE_CHANGE_IN_PROGRESS - UPGRADING - INACCESSIBLE - STANDBY - TRANSPORTING type: string localAdgAutoFailoverMaxDataLossLimit: description: Parameter that allows users to select an acceptable maximum data loss limit in seconds, up to which Automatic Failover will be triggered when necessary for a Local Autonomous Data Guard maximum: 3600 minimum: 0 type: integer localDisasterRecoveryType: description: 'Indicates the local disaster recovery (DR) type of the Autonomous AI Database Serverless instance. Autonomous Data Guard (ADG) DR type provides business critical DR with a faster recovery time objective (RTO) during failover or switchover. Backup-based DR type provides lower cost DR with a slower RTO during failover or switchover. ' type: string x-obmcs-enumref: '#/definitions/DisasterRecoveryConfiguration/disasterRecoveryType' localStandbyDb: $ref: '#/components/schemas/AutonomousDatabaseStandbySummary' longTermBackupSchedule: $ref: '#/components/schemas/LongTermBackUpScheduleDetails' maintenanceTargetComponent: description: The component chosen for maintenance. type: string memoryPerOracleComputeUnitInGBs: description: 'The amount of memory (in GBs) to be enabled per OCPU or ECPU. ' type: integer ncharacterSet: description: 'The national character set for the Autonomous AI Database. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8. ' maxLength: 255 minLength: 1 type: string netServicesArchitecture: description: 'Enabling SHARED server architecture enables a database server to allow many client processes to share very few server processes, thereby increasing the number of supported users. ' enum: - DEDICATED - SHARED type: string nextLongTermBackupTimeStamp: description: The date and time when the next long-term backup would be created. format: date-time type: string nsgIds: description: 'The list of [OCIDs](/Content/General/Concepts/identifiers.htm) for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see [Security Rules](/Content/Network/Concepts/securityrules.htm). ' items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array uniqueItems: true ocpuCount: description: 'The number of OCPU cores to be made available to the database. The following points apply: - For Autonomous AI Databases on Dedicated Exadata Infrastructure, to provision less than 1 core, enter a fractional value in an increment of 0.1. For example, you can provision 0.3 or 0.4 cores, but not 0.35 cores. (Note that fractional OCPU values are not supported for Autonomous AI Database Serverless instances.) - To provision cores, enter an integer between 1 and the maximum number of cores available for the infrastructure shape. For example, you can provision 2 cores or 3 cores, but not 2.5 cores. This applies to Autonomous AI Databases on both serverless and dedicated Exadata infrastructure. - For Autonomous AI Database Serverless instances, this parameter is not used. For Autonomous AI Databases on Dedicated Exadata Infrastructure, the maximum number of cores is determined by the infrastructure shape. See [Characteristics of Infrastructure Shapes](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbde/index.html) for shape details. **Note:** This parameter cannot be used with the `cpuCoreCount` parameter. ' format: float minimum: 0.1 type: number openMode: description: 'Indicates the Autonomous AI Database mode. The database can be opened in `READ_ONLY` or `READ_WRITE` mode. This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, or isFreeTier. ' enum: - READ_ONLY - READ_WRITE type: string x-default-description: 'null' operationsInsightsStatus: description: Status of Operations Insights for this Autonomous AI Database. enum: - ENABLING - ENABLED - DISABLING - NOT_ENABLED - FAILED_ENABLING - FAILED_DISABLING type: string peerDbIds: description: The list of [OCIDs](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of standby databases located in Autonomous Data Guard remote regions that are associated with the source database. Note that for Autonomous AI Database Serverless instances, standby databases located in the same region as the source primary database do not have OCIDs. items: type: string type: array permissionLevel: description: 'The Autonomous AI Database permission level. Restricted mode allows access only by admin users. This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, or isFreeTier. ' enum: - RESTRICTED - UNRESTRICTED type: string x-default-description: 'null' privateEndpoint: description: The private endpoint for the resource. type: string privateEndpointIp: description: The private endpoint Ip address for the resource. type: string privateEndpointLabel: description: 'The resource''s private endpoint label. - Setting the endpoint label to a non-empty string creates a private endpoint database. - Resetting the endpoint label to an empty string, after the creation of the private endpoint database, changes the private endpoint database to a public endpoint database. - Setting the endpoint label to a non-empty string value, updates to a new private endpoint database, when the database is disabled and re-enabled. This setting cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, dbWorkload, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, or isFreeTier. ' type: string provisionableCpus: description: An array of CPU values that an Autonomous AI Database can be scaled to. items: format: float type: number type: array publicConnectionUrls: $ref: '#/components/schemas/AutonomousDatabaseConnectionUrls' description: The Public URLs of Private Endpoint database for accessing Oracle Application Express (APEX) and SQL Developer Web with a browser from a Compute instance within your VCN or that has a direct connection to your VCN. publicEndpoint: description: The public endpoint for the private endpoint enabled resource. type: string refreshableMode: description: The refresh mode of the clone. AUTOMATIC indicates that the clone is automatically being refreshed with data from the source Autonomous AI Database. enum: - AUTOMATIC - MANUAL type: string refreshableStatus: description: The refresh status of the clone. REFRESHING indicates that the clone is currently being refreshed with data from the source Autonomous AI Database. enum: - REFRESHING - NOT_REFRESHING type: string x-default-description: This property is only valid for refreshable clones and is null for for databases that are not refreshable clones. remoteDisasterRecoveryConfiguration: $ref: '#/components/schemas/DisasterRecoveryConfiguration' resourcePoolLeaderId: description: The unique identifier for leader Autonomous AI Database OCID [OCID](/Content/General/Concepts/identifiers.htm). maxLength: 255 minLength: 1 type: string resourcePoolSummary: $ref: '#/components/schemas/ResourcePoolSummary' role: description: 'The Data Guard role of the Autonomous Container Database or Autonomous AI Database, if Autonomous Data Guard is enabled. ' enum: - PRIMARY - STANDBY - DISABLED_STANDBY - BACKUP_COPY - SNAPSHOT_STANDBY type: string scheduledOperations: description: 'The list of scheduled operations. Consists of values such as dayOfWeek, scheduledStartTime, scheduledStopTime. This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. ' items: $ref: '#/components/schemas/ScheduledOperationDetails' type: array 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 [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}` ' type: object serviceConsoleUrl: description: The URL of the Service Console for the Autonomous AI Database. maxLength: 255 minLength: 10 type: string sourceId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the source Autonomous AI Database that was cloned to create the current Autonomous AI Database. maxLength: 255 minLength: 1 type: string sqlWebDeveloperUrl: description: The SQL Web Developer URL for the Oracle Autonomous AI Database. The sqlWebDeveloperUrl is only returned if isSqlWebDeveloperEnabled boolean is set to TRUE. maxLength: 2048 minLength: 10 type: string standbyDb: $ref: '#/components/schemas/AutonomousDatabaseStandbySummary' description: '**Deprecated** Autonomous Data Guard standby database details. ' standbyWhitelistedIps: description: 'The client IP access control list (ACL). This feature is available for [Autonomous AI Database Serverless] (https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html) and on Exadata Cloud@Customer. Only clients connecting from an IP address included in the ACL may access the Autonomous AI Database instance. If `arePrimaryWhitelistedIpsUsed` is ''TRUE'' then Autonomous AI Database uses this primary''s IP access control list (ACL) for the disaster recovery peer called `standbywhitelistedips`. For Autonomous AI Database Serverless, this is an array of CIDR (classless inter-domain routing) notations for a subnet or VCN OCID (virtual cloud network Oracle Cloud ID). Multiple IPs and VCN OCIDs should be separate strings separated by commas, but if it’s other configurations that need multiple pieces of information then its each piece is connected with semicolon (;) as a delimiter. Example: `["1.1.1.1","1.1.1.0/24","ocid1.vcn.oc1.sea.","ocid1.vcn.oc1.sea.;1.1.1.1","ocid1.vcn.oc1.sea.;1.1.0.0/16"]` For Exadata Cloud@Customer, this is an array of IP addresses or CIDR notations. Example: `["1.1.1.1","1.1.1.0/24","1.1.2.25"]` For an update operation, if you want to delete all the IPs in the ACL, use an array with a single empty string entry. This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. ' items: maxLength: 1024 minLength: 0 type: string type: array subnetId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet the resource is associated with. **Subnet Restrictions:** - For bare metal DB systems and for single node virtual machine DB systems, do not use a subnet that overlaps with 192.168.16.16/28. - For Exadata and virtual machine 2-node RAC systems, do not use a subnet that overlaps with 192.168.128.0/20. - For Autonomous AI Database, setting this will disable public secure access to the database. These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and the backup subnet. ' maxLength: 255 minLength: 1 type: string subscriptionId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the subscription with which resource needs to be associated with. maxLength: 255 minLength: 1 type: string supportedRegionsToCloneTo: description: 'The list of regions that support the creation of an Autonomous AI Database clone or an Autonomous Data Guard standby database. ' items: maxLength: 50 minLength: 1 type: string type: array systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object timeCreated: description: The date and time the Autonomous AI Database was created. format: date-time type: string timeDataGuardRoleChanged: description: The date and time the Autonomous Data Guard role was switched for the Autonomous AI Database. For databases that have standbys in both the primary Data Guard region and a remote Data Guard standby region, this is the latest timestamp of either the database using the "primary" role in the primary Data Guard region, or database located in the remote Data Guard standby region. format: date-time type: string timeDeletionOfFreeAutonomousDatabase: description: 'The date and time the Always Free database will be automatically deleted because of inactivity. If the database is in the STOPPED state and without activity until this time, it will be deleted. ' format: date-time type: string timeDisasterRecoveryRoleChanged: description: The date and time the Disaster Recovery role was switched for the standby Autonomous AI Database. format: date-time type: string timeLocalDataGuardEnabled: description: The date and time that Autonomous Data Guard was enabled for an Autonomous AI Database where the standby was provisioned in the same region as the primary database. format: date-time type: string timeMaintenanceBegin: description: The date and time when maintenance will begin. format: date-time type: string timeMaintenanceEnd: description: The date and time when maintenance will end. format: date-time type: string timeOfAutoRefreshStart: description: The the date and time that auto-refreshing will begin for an Autonomous AI Database refreshable clone. This value controls only the start time for the first refresh operation. Subsequent (ongoing) refresh operations have start times controlled by the value of the `autoRefreshFrequencyInSeconds` parameter. format: date-time type: string timeOfJoiningResourcePool: description: The time the member joined the resource pool. format: date-time type: string timeOfLastFailover: description: The timestamp of the last failover operation. format: date-time type: string timeOfLastRefresh: description: The date and time when last refresh happened. format: date-time type: string timeOfLastRefreshPoint: description: The refresh point timestamp (UTC). The refresh point is the time to which the database was most recently refreshed. Data created after the refresh point is not included in the refresh. format: date-time type: string timeOfLastSwitchover: description: The timestamp of the last switchover operation for the Autonomous AI Database. format: date-time type: string timeOfNextRefresh: description: The date and time of next refresh. format: date-time type: string timeReclamationOfFreeAutonomousDatabase: description: 'The date and time the Always Free database will be stopped because of inactivity. If this time is reached without any database activity, the database will automatically be put into the STOPPED state. ' format: date-time type: string timeUndeleted: description: 'The date and time the Autonomous AI Database was most recently undeleted. ' format: date-time type: string timeUntilReconnectCloneEnabled: description: The time and date as an RFC3339 formatted string, e.g., 2022-01-01T12:00:00.000Z, to set the limit for a refreshable clone to be reconnected to its source database. format: date-time type: string usedDataStorageSizeInGBs: description: The storage space consumed by Autonomous AI Database in GBs. type: integer usedDataStorageSizeInTBs: description: The amount of storage that has been used for Autonomous AI Databases in dedicated infrastructure, in terabytes. type: integer vaultId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [vault](/Content/KeyManagement/Concepts/keyoverview.htm#concepts). This parameter and `secretId` are required for Customer Managed Keys. maxLength: 255 minLength: 1 type: string whitelistedIps: description: 'The client IP access control list (ACL). This feature is available for [Autonomous AI Database Serverless] (https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html) and on Exadata Cloud@Customer. Only clients connecting from an IP address included in the ACL may access the Autonomous AI Database instance. If `arePrimaryWhitelistedIpsUsed` is ''TRUE'' then Autonomous AI Database uses this primary''s IP access control list (ACL) for the disaster recovery peer called `standbywhitelistedips`. For Autonomous AI Database Serverless, this is an array of CIDR (classless inter-domain routing) notations for a subnet or VCN OCID (virtual cloud network Oracle Cloud ID). Multiple IPs and VCN OCIDs should be separate strings separated by commas, but if it’s other configurations that need multiple pieces of information then its each piece is connected with semicolon (;) as a delimiter. Example: `["1.1.1.1","1.1.1.0/24","ocid1.vcn.oc1.sea.","ocid1.vcn.oc1.sea.;1.1.1.1","ocid1.vcn.oc1.sea.;1.1.0.0/16"]` For Exadata Cloud@Customer, this is an array of IP addresses or CIDR notations. Example: `["1.1.1.1","1.1.1.0/24","1.1.2.25"]` For an update operation, if you want to delete all the IPs in the ACL, use an array with a single empty string entry. This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. ' items: maxLength: 1024 minLength: 0 type: string type: array required: - id - compartmentId - lifecycleState - dbName - cpuCoreCount - dataStorageSizeInTBs AutonomousDbVersionSummary: description: 'The supported Autonomous AI Database version. ' properties: dbWorkload: description: 'The Autonomous AI Database workload type. The following values are valid: - OLTP - indicates an Autonomous AI Transaction Processing database - DW - indicates an Autonomous AI Lakehouse database - AJD - indicates an Autonomous AI JSON Database - APEX - indicates an Autonomous AI Database with the Oracle APEX AI Application Development workload type. - LH - indicates an Oracle Autonomous AI Lakehouse database **Note** Starting December 2026, DW will not be supported as a valid value for this parameter. When creating an Autonomous AI Database, if this parameter is not specified, the default value is `OLTP`. This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. ' enum: - OLTP - DW - AJD - APEX - LH type: string details: description: A URL that points to a detailed description of the Autonomous AI Database version. type: string isDedicated: description: 'True if the database uses [dedicated Exadata infrastructure](https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html). ' type: boolean isDefaultForFree: description: True if this version of the Oracle AI Database software's default is free. type: boolean isDefaultForPaid: description: True if this version of the Oracle AI Database software's default is paid. type: boolean isFreeTierEnabled: description: True if this version of the Oracle AI Database software can be used for Always-Free Autonomous AI Databases. type: boolean isPaidEnabled: description: True if this version of the Oracle AI Database software has payments enabled. type: boolean version: description: 'A valid Oracle AI Database version for Autonomous AI Database. When you specify 23ai for dbversion, the system will provision a 23ai database, but the UI will display it as 26ai. When you specify 26ai for dbversion, the system will provision and display a 26ai database as expected. For new databases, it is recommended to use either 19c or 26ai. **Note** Starting December 2026, 23ai will not be supported as a valid value for this parameter. ' maxLength: 255 minLength: 1 type: string required: - version SchedulingPlan: allOf: - $ref: '#/components/schemas/SchedulingPlanSummary' description: 'Details of a Scheduling Plan. ' PluggableDatabaseSnapshotSummary: description: 'Details of the Exadata Pluggable Database Snapshot. ' properties: clusterId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the VM cluster. maxLength: 255 minLength: 1 type: string compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata Pluggable Database Snapshot. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: Additional information about the current lifecycle state of the Exadata Pluggable Database Snapshot. type: string lifecycleState: description: The current state of the Exadata Pluggable Database Snapshot. type: string x-obmcs-enumref: '#/definitions/PluggableDatabaseSnapshot/lifecycleState' name: description: The user-friendly name for the Database Snapshot. The name should be unique. maxLength: 255 minLength: 1 type: string pluggableDatabaseId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata Pluggable Database. maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object timeCreated: description: 'The date and time that the Exadata Pluggable Database Snapshot was created, as expressed in RFC 3339 format. For example: 2023-06-27T21:10:29Z ' format: date-time type: string required: - id - name - pluggableDatabaseId ExadataInfrastructureContact: description: Contact details for Exadata Infrastructure. properties: email: description: The email for the Exadata Infrastructure contact. maxLength: 255 minLength: 1 type: string isContactMosValidated: description: If `true`, this Exadata Infrastructure contact is a valid My Oracle Support (MOS) contact. If `false`, this Exadata Infrastructure contact is not a valid MOS contact. type: boolean isPrimary: description: If `true`, this Exadata Infrastructure contact is a primary contact. If `false`, this Exadata Infrastructure is a secondary contact. type: boolean name: description: The name of the Exadata Infrastructure contact. maxLength: 255 minLength: 1 type: string phoneNumber: description: The phone number for the Exadata Infrastructure contact. maxLength: 255 type: string required: - name - email - isPrimary AssociatedLongTermBackup: description: Long Term Backups associated with a backup destination properties: displayName: description: The display name for the long term backup for the Autonomous AI Database. maxLength: 255 minLength: 1 type: string id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Autonomous AI Database backup. maxLength: 255 minLength: 1 type: string PluggableDatabaseSummary: description: 'A pluggable database (PDB) is portable collection of schemas, schema objects, and non-schema objects that appears to an Oracle client as a non-container database. To use a PDB, it needs to be plugged into a CDB. To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to a tenancy administrator. If you are an administrator who needs to write policies to give users access, see [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' properties: compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string connectionStrings: $ref: '#/components/schemas/PluggableDatabaseConnectionStrings' containerDatabaseId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the CDB. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the pluggable database. maxLength: 255 minLength: 1 type: string isRestricted: description: 'The restricted mode of the pluggable database. If a pluggable database is opened in restricted mode, the user needs both create a session and have restricted session privileges to connect to it. ' type: boolean lifecycleDetails: description: Detailed message for the lifecycle state. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of the pluggable database. enum: - PROVISIONING - AVAILABLE - TERMINATING - TERMINATED - UPDATING - FAILED - RELOCATING - RELOCATED - REFRESHING - RESTORE_IN_PROGRESS - RESTORE_FAILED - BACKUP_IN_PROGRESS - DISABLED type: string openMode: description: '**Deprecated.** Use [PluggableDatabaseNodeLevelDetails](#/en/database/latest/datatypes/PluggableDatabaseNodeLevelDetails) for OpenMode details. The mode that pluggable database is in. Open mode can only be changed to READ_ONLY or MIGRATE directly from the backend (within the Oracle Database software). ' enum: - READ_ONLY - READ_WRITE - MOUNTED - MIGRATE type: string pdbName: description: The name for the pluggable database (PDB). The name is unique in the context of a [container database](#/en/database/latest/Database/). The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. The pluggable database name should not be same as the container database name. maxLength: 30 minLength: 1 type: string pdbNodeLevelDetails: description: 'Pluggable Database Node Level Details. Example: [{"nodeName" : "node1", "openMode" : "READ_WRITE"}, {"nodeName" : "node2", "openMode" : "READ_ONLY"}] ' items: $ref: '#/components/schemas/PluggableDatabaseNodeLevelDetails' type: array refreshableCloneConfig: $ref: '#/components/schemas/PluggableDatabaseRefreshableCloneConfig' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object timeCreated: description: The date and time the pluggable database was created. format: date-time type: string required: - id - lifecycleState - pdbName - timeCreated - containerDatabaseId - openMode - compartmentId RecommendedScheduledActionsCollection: description: A list of scheduled actions. Contains RecommendedScheduledAction items. properties: items: description: List of scheduled actions. items: $ref: '#/components/schemas/RecommendedScheduledActionSummary' maxItems: 100 type: array required: - items VmClusterUpdate: allOf: - $ref: '#/components/schemas/VmClusterUpdateSummary' description: 'A maintenance update for a VM cluster. Applies to Exadata Cloud@Customer instances only. 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). ' MaintenanceRunHistory: allOf: - $ref: '#/components/schemas/MaintenanceRunHistorySummary' description: 'Details of a maintenance run history. ' SchedulingPlanCollection: description: Results of Scheduling Plan resources lists. Contains ScheduledActionSummary items. properties: items: description: List of Scheduling Plan resources. items: $ref: '#/components/schemas/SchedulingPlanSummary' type: array required: - items type: object MaintenanceVersionPreferenceDetails: description: 'The preferences for target versions of future maintenance runs. Currently these preferences are only supported for Monthly maintenance runs created via scheduling plans If no preferences are specified then the version will be set by default to "Latest". Changing preferences will not change versions for an already existing maintenance run. ' properties: referenceResourceIdForImageUpdates: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the resource the maintenance run will refer to when trying to fetch target versions. maxLength: 255 minLength: 1 type: string Error: 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 VersionSchemeDetails: description: 'The update should be applied on the database for the selected version scheme. ' discriminator: propertyName: source properties: source: description: 'The update should be applied on the database for the selected version scheme. ' enum: - VERSION_SERIES type: string required: - source DataGuardAssociationSummary: description: 'The properties that define a Data Guard association. 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). For information about endpoints and signing API requests, see [About the API](/Content/API/Concepts/usingapi.htm). For information about available SDKs and tools, see [SDKS and Other Tools](/Content/API/Concepts/sdks.htm). ' properties: applyLag: description: 'The lag time between updates to the primary database and application of the redo data on the standby database, as computed by the reporting database. Example: `9 seconds` ' type: string applyRate: description: 'The rate at which redo logs are synced between the associated databases. Example: `180 Mb per second` ' type: string databaseId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the reporting database. maxLength: 255 minLength: 1 type: string id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Data Guard association. maxLength: 255 minLength: 1 type: string isActiveDataGuardEnabled: description: True if active Data Guard is enabled. type: boolean lifecycleDetails: description: 'Additional information about the current lifecycleState, if available. ' type: string lifecycleState: description: The current state of the Data Guard association. enum: - PROVISIONING - AVAILABLE - UPDATING - TERMINATING - TERMINATED - FAILED - UPGRADING type: string peerDataGuardAssociationId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the peer database's Data Guard association. maxLength: 255 minLength: 1 type: string peerDatabaseId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the associated peer database. maxLength: 255 minLength: 1 type: string peerDbHomeId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Database Home containing the associated peer database. ' maxLength: 255 minLength: 1 type: string peerDbSystemId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the DB system containing the associated peer database. ' maxLength: 255 minLength: 1 type: string peerRole: description: The role of the peer database in this Data Guard association. enum: - PRIMARY - STANDBY - DISABLED_STANDBY type: string protectionMode: description: 'The protection mode of this Data Guard association. For more information, see [Oracle Data Guard Protection Modes](http://docs.oracle.com/database/122/SBYDB/oracle-data-guard-protection-modes.htm#SBYDB02000) in the Oracle Data Guard documentation. ' enum: - MAXIMUM_AVAILABILITY - MAXIMUM_PERFORMANCE - MAXIMUM_PROTECTION type: string role: description: The role of the reporting database in this Data Guard association. enum: - PRIMARY - STANDBY - DISABLED_STANDBY type: string timeCreated: description: The date and time the Data Guard association was created. format: date-time type: string transportType: description: 'The redo transport type used by this Data Guard association. For more information, see [Redo Transport Services](http://docs.oracle.com/database/122/SBYDB/oracle-data-guard-redo-transport-services.htm#SBYDB00400) in the Oracle Data Guard documentation. ' enum: - SYNC - ASYNC - FASTSYNC type: string required: - id - databaseId - role - peerDbSystemId - peerRole - protectionMode - lifecycleState DbServerPatchingDetails: description: 'The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window. ' properties: estimatedPatchDuration: description: Estimated time, in minutes, to patch one database server. maximum: 3000 minimum: 1 type: integer patchingStatus: description: The status of the patching operation. enum: - SCHEDULED - MAINTENANCE_IN_PROGRESS - FAILED - COMPLETE type: string timePatchingEnded: description: The time when the patching operation ended. format: date-time type: string timePatchingStarted: description: The time when the patching operation started. format: date-time type: string DbServerHistorySummary: description: Details of a database server maintenance history. properties: dbServerPatchingDetails: $ref: '#/components/schemas/DbServerPatchingDetails' displayName: description: The user-friendly name for the database server. The name does not need to be unique. maxLength: 255 minLength: 1 type: string id: description: The OCID of the database server. maxLength: 255 minLength: 1 type: string required: - id type: object DeregisterAutonomousDatabaseDataSafeDetails: description: 'Details to deregister an Autonomous AI Database with Data Safe. ' properties: pdbAdminPassword: description: The admin password provided during the creation of the database. This password is between 12 and 30 characters long, and must contain at least 1 uppercase, 1 lowercase, and 1 numeric character. It cannot contain the double quote symbol (") or the username "admin", regardless of casing. maxLength: 30 minLength: 12 type: string required: - pdbAdminPassword AutonomousContainerDatabase: allOf: - $ref: '#/components/schemas/AutonomousContainerDatabaseSummary' UpdateConsoleHistoryDetails: description: 'The details for updating a Db node console history. ' properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object displayName: description: 'The user-friendly name for the console history. The name does not need to be unique. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object DatabaseSummary: description: 'An Oracle Database on a bare metal or virtual machine DB system. For more information, see [Bare Metal and Virtual Machine DB Systems](/Content/Database/Concepts/overview.htm). 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). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' properties: characterSet: description: The character set for the database. maxLength: 255 minLength: 1 type: string compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string connectionStrings: $ref: '#/components/schemas/DatabaseConnectionStrings' description: The Connection strings used to connect to the Oracle Database. dataGuardGroup: $ref: '#/components/schemas/DataGuardGroup' databaseManagementConfig: $ref: '#/components/schemas/CloudDatabaseManagementConfig' databaseSoftwareImageId: description: The database software image [OCID](/Content/General/Concepts/identifiers.htm) maxLength: 255 minLength: 1 type: string dbBackupConfig: $ref: '#/components/schemas/DbBackupConfig' dbHomeId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Database Home. maxLength: 255 minLength: 1 type: string dbName: description: The database name. maxLength: 255 minLength: 1 type: string dbSystemId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the DB system. maxLength: 255 minLength: 1 type: string dbUniqueName: description: 'A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed. ' maxLength: 30 minLength: 1 type: string dbWorkload: description: '**Deprecated.** The dbWorkload field has been deprecated for Exadata Database Service on Dedicated Infrastructure, Exadata Database Service on Cloud@Customer, and Base Database Service. Support for this attribute will end in November 2023. You may choose to update your custom scripts to exclude the dbWorkload attribute. After November 2023 if you pass a value to the dbWorkload attribute, it will be ignored. The database workload type. ' type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object encryptionKeyLocationDetails: $ref: '#/components/schemas/EncryptionKeyLocationDetails' freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object homeType: description: 'Represents database will be under oracle managed home or customer managed home ' enum: - ORACLE_MANAGED - CUSTOMER_MANAGED type: string id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the database. maxLength: 255 minLength: 1 type: string isCdb: description: True if the database is a container database. type: boolean kmsKeyId: description: The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. maxLength: 255 minLength: 1 type: string kmsKeyVersionId: description: 'The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous AI Database Serverless does not use key versions, hence is not applicable for Autonomous AI Database Serverless instances. ' maxLength: 255 minLength: 1 type: string lastBackupDurationInSeconds: description: The duration when the latest database backup created. type: integer lastBackupTimestamp: description: The date and time when the latest database backup was created. format: date-time type: string lastFailedBackupTimestamp: description: The date and time when the latest database backup failed. format: date-time type: string lifecycleDetails: description: Additional information about the current lifecycle state. type: string lifecycleState: description: The current state of the database. enum: - PROVISIONING - AVAILABLE - UPDATING - BACKUP_IN_PROGRESS - UPGRADING - CONVERTING - TERMINATING - TERMINATED - RESTORE_FAILED - FAILED type: string managedSoftwareUpdateDetails: $ref: '#/components/schemas/ManagedSoftwareUpdateDetails' ncharacterSet: description: The national character set for the database. maxLength: 255 minLength: 1 type: string pdbName: description: The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name. maxLength: 30 minLength: 1 type: string sidPrefix: description: 'Specifies a prefix for the `Oracle SID` of the database to be created. ' maxLength: 12 minLength: 1 type: string sourceDatabasePointInTimeRecoveryTimestamp: description: Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format: date-time type: string storageSizeDetails: $ref: '#/components/schemas/DatabaseStorageSizeResponseDetails' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object timeCreated: description: The date and time the database was created. format: date-time type: string vaultId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [vault](/Content/KeyManagement/Concepts/keyoverview.htm#concepts). This parameter and `secretId` are required for Customer Managed Keys. maxLength: 255 minLength: 1 type: string vmClusterId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the VM cluster. maxLength: 255 minLength: 1 type: string required: - id - compartmentId - lifecycleState - dbName - dbUniqueName UpdateExternalDatabaseDetailsBase: description: 'Details for updating an external database. This API is not currently supported. ' properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object displayName: description: The user-friendly name for the external database. The name does not have to be unique. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object required: - displayName AutonomousContainerDatabaseResourceUsage: description: Associated autonomous container databases usages. properties: autonomousContainerDatabaseVmUsage: description: List of autonomous container database resource usage per autonomous virtual machine. items: $ref: '#/components/schemas/AcdAvmResourceStats' maxItems: 1024 type: array availableCpus: description: CPUs available for provisioning or scaling an Autonomous AI Database in the Autonomous Container Database. format: float type: number definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object displayName: description: The user-friendly name for the Autonomous Container Database. The name does not need to be unique. type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Autonomous Container Database. type: string largestProvisionableAutonomousDatabaseInCpus: description: Largest provisionable ADB in the Autonomous Container Database. format: float type: number provisionableCpus: description: Valid list of provisionable CPUs for Autonomous AI Database. items: format: float type: number type: array provisionedCpus: description: CPUs / cores assigned to ADBs in the Autonomous Container Database. format: float type: number reclaimableCpus: description: Number of CPUs that are reclaimable or released to the AVMC on Autonomous Container Database restart. format: float type: number reservedCpus: description: 'CPUs / cores reserved for scalability, resilliency and other overheads. This includes failover, autoscaling and idle instance overhead. ' format: float type: number usedCpus: description: 'CPUs / cores assigned to the Autonomous Container Database. Sum of provisioned, reserved and reclaimable CPUs/ cores. ' format: float type: number required: - displayName UpdateDbSystemDetails: description: 'Describes the parameters for updating the DB system. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' properties: backupNetworkNsgIds: description: 'A list of the [OCIDs](/Content/General/Concepts/identifiers.htm) of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see [Security Rules](/Content/Network/Concepts/securityrules.htm). Applicable only to Exadata systems. ' items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array uniqueItems: true computeCount: description: The number of compute servers for the DB system. format: int32 type: integer computeModel: description: The compute model for Base Database Service. This is required if using the `computeCount` parameter. If using `cpuCoreCount` then it is an error to specify `computeModel` to a non-null value. The ECPU compute model is the recommended model, and the OCPU compute model is legacy. enum: - ECPU - OCPU type: string cpuCoreCount: description: The new number of CPU cores to set for the DB system. Not applicable for INTEL based virtual machine DB systems. minimum: 1 type: integer dataCollectionOptions: $ref: '#/components/schemas/DataCollectionOptions' dataStorageSizeInGBs: description: 'The size, in gigabytes, to scale the attached storage up to for this virtual machine DB system. This value must be greater than current storage size. Note that the resulting total storage size attached will be greater than the amount requested to allow for REDO/RECO space and software volume. Applies only to virtual machine DB systems. ' type: integer definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object licenseModel: description: 'The Oracle Database license model that applies to all databases on the DB system. The default is LICENSE_INCLUDED. ' enum: - LICENSE_INCLUDED - BRING_YOUR_OWN_LICENSE type: string maintenanceWindowDetails: $ref: '#/components/schemas/MaintenanceWindow' nsgIds: description: 'The list of [OCIDs](/Content/General/Concepts/identifiers.htm) for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see [Security Rules](/Content/Network/Concepts/securityrules.htm). ' items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array uniqueItems: true 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 [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}` ' type: object shape: description: 'The shape of the DB system. The shape determines resources allocated to the DB system. - For virtual machine shapes, the number of CPU cores and memory To get a list of shapes, use the [ListDbSystemShapes](#/en/database/latest/DbSystemShapeSummary/ListDbSystemShapes) operation. ' maxLength: 255 minLength: 1 type: string sshPublicKeys: description: The public key portion of the key pair to use for SSH access to the DB system. Multiple public keys can be provided. The length of the combined keys cannot exceed 40,000 characters. items: maxLength: 1024 minLength: 1 type: string type: array version: $ref: '#/components/schemas/PatchDetails' EstimateCostSavingsSummaryCollection: description: A list of estimate cost savings. properties: items: description: List of estimate cost saving summary. items: $ref: '#/components/schemas/EstimateCostSavingSummary' type: array required: - items GiMinorVersionSummary: description: 'The Oracle Grid Infrastructure (GI) minor version. 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: gridImageId: description: Grid Infrastructure Image Id maxLength: 255 minLength: 1 type: string version: description: A valid Oracle Grid Infrastructure (GI) software version. maxLength: 255 minLength: 1 type: string required: - version SwitchoverDataGuardAssociationDetails: description: 'The Data Guard association switchover parameters. ' properties: databaseAdminPassword: description: The DB system administrator password. maxLength: 255 minLength: 1 type: string required: - databaseAdminPassword AutonomousDatabaseInBackup: description: 'Details of Autonomous AI Database in Autonomous Container Database ' properties: compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string displayName: description: The user-friendly name for the Autonomous AI Database. The name does not have to be unique. maxLength: 255 minLength: 1 type: string required: - compartmentId - displayName ExadataDbSystemMigration: description: 'Information about the Exadata DB system migration. The migration is used to move the Exadata Cloud Service instance from the DB system resource model to the new cloud Exadata infrastructure resource model. ' properties: additionalMigrations: description: The details of addtional resources related to the migration. items: $ref: '#/components/schemas/ExadataDbSystemMigrationSummary' type: array cloudExadataInfrastructureId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud Exadata infrastructure. maxLength: 255 minLength: 1 type: string cloudVmClusterId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud VM cluster. maxLength: 255 minLength: 1 type: string dbSystemId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the DB system. maxLength: 255 minLength: 1 type: string required: - dbSystemId - cloudVmClusterId - cloudExadataInfrastructureId ConvertToPdbDetails: description: 'Details for converting a non-container database to pluggable database. ' properties: action: description: 'The operations used to convert a non-container database to a pluggable database. - Use `PRECHECK` to run a pre-check operation on non-container database prior to converting it into a pluggable database. - Use `CONVERT` to convert a non-container database into a pluggable database. - Use `SYNC` if the non-container database was manually converted into a pluggable database using the dbcli command-line utility. Databases may need to be converted manually if the CONVERT action fails when converting a non-container database using the API. - Use `SYNC_ROLLBACK` if the conversion of a non-container database into a pluggable database was manually rolled back using the dbcli command line utility. Conversions may need to be manually rolled back if the CONVERT action fails when converting a non-container database using the API. ' enum: - PRECHECK - CONVERT - SYNC - SYNC_ROLLBACK type: string convertToPdbTargetDetails: $ref: '#/components/schemas/ConvertToPdbTargetBase' required: - action StoragePerformanceDetails: description: 'Representation of storage performance detail parameters. ' properties: balancedDiskPerformance: $ref: '#/components/schemas/DiskPerformanceDetails' highDiskPerformance: $ref: '#/components/schemas/DiskPerformanceDetails' sizeInGBs: description: Size in GBs. type: integer required: - sizeInGBs - balancedDiskPerformance - highDiskPerformance CreateAutonomousDatabaseBase: description: "Details to create an Oracle Autonomous AI Database.\n \n**Notes:**\n- To specify OCPU core count, you must use either `ocpuCount` or `cpuCoreCount`. You cannot use both parameters at the same time. For Autonomous AI Database Serverless instances, `ocpuCount` is not used.\n- To specify a storage allocation, you must use either `dataStorageSizeInGBs` or `dataStorageSizeInTBs`.\n- See the individual parameter discriptions for more information on the OCPU and storage value parameters.\n \n**Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.\n" discriminator: propertyName: source properties: adminPassword: description: '**Important** The `adminPassword` or `secretId` must be specified for all Autonomous AI Databases except for refreshable clones. The password must be between 12 and 30 characters long, and must contain at least 1 uppercase, 1 lowercase, and 1 numeric character. It cannot contain the double quote symbol (") or the username "admin", regardless of casing. This cannot be used in conjunction with with OCI vault secrets (secretId). ' maxLength: 30 minLength: 12 type: string arePrimaryWhitelistedIpsUsed: description: 'This field will be null if the Autonomous AI Database is not Data Guard enabled or Access Control is disabled. It''s value would be `TRUE` if Autonomous AI Database is Data Guard enabled and Access Control is enabled and if the Autonomous AI Database uses primary IP access control list (ACL) for standby. It''s value would be `FALSE` if Autonomous AI Database is Data Guard enabled and Access Control is enabled and if the Autonomous AI Database uses different IP access control list (ACL) for standby compared to primary. ' type: boolean x-default-description: 'This field will be used only if Autonomous AI Database is Data Guard enabled and Access Control is enabled. ' autonomousContainerDatabaseId: description: The Autonomous Container Database [OCID](/Content/General/Concepts/identifiers.htm). Used only by Autonomous AI Database on Dedicated Exadata Infrastructure. maxLength: 255 minLength: 1 type: string autonomousMaintenanceScheduleType: description: 'The maintenance schedule type of the Autonomous AI Database Serverless. An EARLY maintenance schedule follows a schedule applying patches prior to the REGULAR schedule. A REGULAR maintenance schedule follows the normal cycle ' enum: - EARLY - REGULAR type: string byolComputeCountLimit: description: The maximum number of CPUs allowed with a Bring Your Own License (BYOL), including those used for auto-scaling, disaster recovery, tools, etc. Any CPU usage above this limit is considered as License Included and billed. format: float minimum: 2 type: number characterSet: description: 'The character set for the Autonomous AI Database. The default is AL32UTF8. Allowed values for an Autonomous AI Database Serverless instance as as returned by [List Autonomous AI Database Character Sets](https://docs.oracle.com/iaas/autonomous-database-serverless/doc/autonomous-character-set-selection.html) For an Autonomous AI Database on dedicated infrastructure, the allowed values are: AL32UTF8, AR8ADOS710, AR8ADOS720, AR8APTEC715, AR8ARABICMACS, AR8ASMO8X, AR8ISO8859P6, AR8MSWIN1256, AR8MUSSAD768, AR8NAFITHA711, AR8NAFITHA721, AR8SAKHR706, AR8SAKHR707, AZ8ISO8859P9E, BG8MSWIN, BG8PC437S, BLT8CP921, BLT8ISO8859P13, BLT8MSWIN1257, BLT8PC775, BN8BSCII, CDN8PC863, CEL8ISO8859P14, CL8ISO8859P5, CL8ISOIR111, CL8KOI8R, CL8KOI8U, CL8MACCYRILLICS, CL8MSWIN1251, EE8ISO8859P2, EE8MACCES, EE8MACCROATIANS, EE8MSWIN1250, EE8PC852, EL8DEC, EL8ISO8859P7, EL8MACGREEKS, EL8MSWIN1253, EL8PC437S, EL8PC851, EL8PC869, ET8MSWIN923, HU8ABMOD, HU8CWI2, IN8ISCII, IS8PC861, IW8ISO8859P8, IW8MACHEBREWS, IW8MSWIN1255, IW8PC1507, JA16EUC, JA16EUCTILDE, JA16SJIS, JA16SJISTILDE, JA16VMS, KO16KSC5601, KO16KSCCS, KO16MSWIN949, LA8ISO6937, LA8PASSPORT, LT8MSWIN921, LT8PC772, LT8PC774, LV8PC1117, LV8PC8LR, LV8RST104090, N8PC865, NE8ISO8859P10, NEE8ISO8859P4, RU8BESTA, RU8PC855, RU8PC866, SE8ISO8859P3, TH8MACTHAIS, TH8TISASCII, TR8DEC, TR8MACTURKISHS, TR8MSWIN1254, TR8PC857, US7ASCII, US8PC437, UTF8, VN8MSWIN1258, VN8VN3, WE8DEC, WE8DG, WE8ISO8859P1, WE8ISO8859P15, WE8ISO8859P9, WE8MACROMAN8S, WE8MSWIN1252, WE8NCR4970, WE8NEXTSTEP, WE8PC850, WE8PC858, WE8PC860, WE8ROMAN8, ZHS16CGB231280, ZHS16GBK, ZHT16BIG5, ZHT16CCDC, ZHT16DBT, ZHT16HKSCS, ZHT16MSWIN950, ZHT32EUC, ZHT32SOPS, ZHT32TRIS ' maxLength: 255 minLength: 1 type: string compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment of the Autonomous AI Database. maxLength: 255 minLength: 1 type: string computeCount: description: 'The compute amount (CPUs) available to the database. Minimum and maximum values depend on the compute model and whether the database is an Autonomous AI Database Serverless instance or an Autonomous AI Database on Dedicated Exadata Infrastructure. The ''ECPU'' compute model requires a minimum value of one, for databases in the elastic resource pool and minimum value of two, otherwise. Required when using the `computeModel` parameter. When using `cpuCoreCount` parameter, it is an error to specify computeCount to a non-null value. Providing `computeModel` and `computeCount` is the preferred method for both OCPU and ECPU. ' format: float maximum: 512 minimum: 0.1 type: number computeModel: description: 'The compute model of the Base Database, Exadata Infrastructure, VM Cluster and Autonomous AI Database. ' enum: - ECPU - OCPU type: string x-default-description: Null used when unspecified. cpuCoreCount: description: 'The number of CPU cores to be made available to the database. For Autonomous AI Databases on dedicated Exadata infrastructure, the maximum number of cores is determined by the infrastructure shape. See [Characteristics of Infrastructure Shapes](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbde/) for shape details. **Note:** This parameter cannot be used with the `ocpuCount` parameter. ' maximum: 128 minimum: 1 type: integer customerContacts: description: Customer Contacts. items: $ref: '#/components/schemas/CustomerContact' type: array dataStorageSizeInGBs: description: 'The size, in gigabytes, of the data volume that will be created and attached to the database. This storage can later be scaled up if needed. The maximum storage value is determined by the infrastructure shape. See [Characteristics of Infrastructure Shapes](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbde/) for shape details. **Notes** - This parameter is only supported for dedicated Exadata infrastructure. - This parameter cannot be used with the `dataStorageSizeInTBs` parameter. ' maximum: 131072 minimum: 32 type: integer dataStorageSizeInTBs: description: 'The size, in terabytes, of the data volume that will be created and attached to the database. This storage can later be scaled up if needed. For Autonomous AI Databases on dedicated Exadata infrastructure, the maximum storage value is determined by the infrastructure shape. See [Characteristics of Infrastructure Shapes](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbde/) for shape details. A full Exadata service is allocated when the Autonomous AI Database size is set to the upper limit (384 TB). **Note:** This parameter cannot be used with the `dataStorageSizeInGBs` parameter. ' maximum: 384 minimum: 1 type: integer databaseEdition: description: 'The Oracle AI Database Edition that applies to the Autonomous AI Databases. This parameter accepts options `STANDARD_EDITION` and `ENTERPRISE_EDITION`. ' type: string x-obmcs-enumref: '#/definitions/AutonomousDatabaseSummary/databaseEdition' dbName: description: The database name. The name must begin with an alphabetic character and can contain a maximum of 30 alphanumeric characters. Special characters are not permitted. The database name must be unique in the tenancy. It is required in all cases except when creating a cross-region Autonomous Data Guard standby instance or a cross-region disaster recovery standby instance. maxLength: 30 minLength: 1 type: string dbToolsDetails: description: 'The list of database tools details. This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, isLocalDataGuardEnabled, or isFreeTier. ' items: $ref: '#/components/schemas/DatabaseTool' type: array x-default-description: 'null' dbVersion: description: 'A valid Oracle AI Database version for Autonomous AI Database. When you specify 23ai for dbversion, the system will provision a 23ai database, but the UI will display it as 26ai. When you specify 26ai for dbversion, the system will provision and display a 26ai database as expected. For new databases, it is recommended to use either 19c or 26ai. **Note** Starting December 2026, 23ai will not be supported as a valid value for this parameter. ' maxLength: 255 minLength: 1 type: string dbWorkload: description: 'The Autonomous AI Database workload type. The following values are valid: - OLTP - indicates an Autonomous AI Transaction Processing database - DW - indicates an Autonomous AI Lakehouse database - AJD - indicates an Autonomous AI JSON Database - APEX - indicates an Autonomous AI Database with the Oracle APEX AI Application Development workload type. - LH - indicates an Oracle Autonomous AI Lakehouse database **Note** Starting December 2026, DW will not be supported as a valid value for this parameter. When creating an Autonomous AI Database, if this parameter is not specified, the default value is `OLTP`. This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. ' enum: - OLTP - DW - AJD - APEX - LH type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object displayName: description: The user-friendly name for the Autonomous AI Database. The name does not have to be unique. maxLength: 255 minLength: 1 type: string encryptionKey: $ref: '#/components/schemas/AutonomousDatabaseEncryptionKeyDetails' freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object inMemoryPercentage: default: 0 description: The percentage of the System Global Area(SGA) assigned to In-Memory tables in Autonomous AI Database. This property is applicable only to Autonomous AI Databases on the Exadata Cloud@Customer platform. minimum: 0 type: integer isAccessControlEnabled: description: "Indicates if the database-level access control is enabled.\nIf disabled, database access is defined by the network security rules.\nIf enabled, database access is restricted to the IP addresses defined by the rules specified with the `whitelistedIps` property. While specifying `whitelistedIps` rules is optional,\n if database-level access control is enabled and no rules are specified, the database will become inaccessible. The rules can be added later using the `UpdateAutonomousDatabase` API operation or edit option in console.\nWhen creating a database clone, the desired access control setting should be specified. By default, database-level access control will be disabled for the clone.\n\nThis property is applicable only to Autonomous AI Databases on the Exadata Cloud@Customer platform. For Autonomous AI Database Serverless instances, `whitelistedIps` is used.\n" type: boolean isAutoScalingEnabled: default: false description: 'Indicates if auto scaling is enabled for the Autonomous AI Database CPU core count. The default value is `FALSE`. ' type: boolean isAutoScalingForStorageEnabled: description: 'Indicates if auto scaling is enabled for the Autonomous AI Database storage. The default value is `FALSE`. ' type: boolean isBackupRetentionLocked: description: True if the Autonomous AI Database is backup retention locked. type: boolean isDataGuardEnabled: description: '**Deprecated.** Indicates whether the Autonomous AI Database has local (in-region) Data Guard enabled. Not applicable to cross-region Autonomous Data Guard associations, or to Autonomous AI Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure. ' type: boolean isDedicated: description: 'True if the database is on [dedicated Exadata infrastructure](https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html). ' type: boolean isDevTier: default: false description: 'Autonomous AI Database for Developers are fixed-shape Autonomous AI Databases that developers can use to build and test new applications. On Serverless, these are low-cost and billed per instance, on Dedicated and Cloud@Customer there is no additional cost to create Developer databases. Developer databases come with limited resources and is not intended for large-scale testing and production deployments. When you need more compute or storage resources, you may upgrade to a full paid production database. ' type: boolean isFreeTier: default: false description: 'Indicates if this is an Always Free resource. The default value is false. Note that Always Free Autonomous AI Databases have 1 CPU and 20GB of memory. For Always Free databases, memory and CPU cannot be scaled. This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, or isLocalDataGuardEnabled ' type: boolean isLocalDataGuardEnabled: description: Indicates whether the Autonomous AI Database has local (in-region) Data Guard enabled. Not applicable to cross-region Autonomous Data Guard associations, or to Autonomous AI Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure. type: boolean isMtlsConnectionRequired: description: 'Specifies if the Autonomous AI Database requires mTLS connections. This may not be updated in parallel with any of the following: licenseModel, databaseEdition, cpuCoreCount, computeCount, dataStorageSizeInTBs, whitelistedIps, openMode, permissionLevel, db-workload, privateEndpointLabel, nsgIds, customerContacts, dbVersion, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. Service Change: The default value of the isMTLSConnectionRequired attribute will change from true to false on July 1, 2023 in the following APIs: - CreateAutonomousDatabase - GetAutonomousDatabase - UpdateAutonomousDatabase Details: Prior to the July 1, 2023 change, the isMTLSConnectionRequired attribute default value was true. This applies to Autonomous AI Database Serverless. Does this impact me? If you use or maintain custom scripts or Terraform scripts referencing the CreateAutonomousDatabase, GetAutonomousDatabase, or UpdateAutonomousDatabase APIs, you want to check, and possibly modify, the scripts for the changed default value of the attribute. Should you choose not to leave your scripts unchanged, the API calls containing this attribute will continue to work, but the default value will switch from true to false. How do I make this change? Using either OCI SDKs or command line tools, update your custom scripts to explicitly set the isMTLSConnectionRequired attribute to true. ' type: boolean isPreviewVersionWithServiceTermsAccepted: default: false description: 'If set to `TRUE`, indicates that an Autonomous AI Database preview version is being provisioned, and that the preview version''s terms of service have been accepted. Note that preview version software is only available for Autonomous AI Database Serverless instances (https://docs.oracle.com/en/cloud/paas/autonomous-database/serverless/). ' type: boolean kmsKeyId: description: The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. maxLength: 255 minLength: 1 type: string licenseModel: description: 'The Oracle license model that applies to the Oracle Autonomous AI Database. Bring your own license (BYOL) allows you to apply your current on-premises Oracle software licenses to equivalent, highly automated Oracle services in the cloud. License Included allows you to subscribe to new Oracle AI Database software licenses and the Oracle AI Database service. Note that when provisioning an [Autonomous AI Database on dedicated Exadata infrastructure](https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html), this attribute must be null. It is already set at the Autonomous Exadata Infrastructure level. When provisioning an [Autonomous AI Database Serverless] (https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html) database, if a value is not specified, the system defaults the value to `BRING_YOUR_OWN_LICENSE`. Bring your own license (BYOL) also allows you to select the DB edition using the optional parameter. This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, dataStorageSizeInTBs, adminPassword, isMTLSConnectionRequired, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, dbName, scheduledOperations, dbToolsDetails, or isFreeTier. ' enum: - LICENSE_INCLUDED - BRING_YOUR_OWN_LICENSE type: string ncharacterSet: description: 'The character set for the Autonomous AI Database. The default is AL32UTF8. Use [List Autonomous AI Database Character Sets](https://docs.oracle.com/iaas/autonomous-database-serverless/doc/autonomous-character-set-selection.html) to list the allowed values for an Autonomous AI Database Serverless instance. For an Autonomous AI Database on dedicated Exadata infrastructure, the allowed values are: AL16UTF16 or UTF8. ' maxLength: 255 minLength: 1 type: string nsgIds: description: 'The list of [OCIDs](/Content/General/Concepts/identifiers.htm) for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see [Security Rules](/Content/Network/Concepts/securityrules.htm). ' items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array uniqueItems: true ocpuCount: description: 'The number of OCPU cores to be made available to the database. The following points apply: - For Autonomous AI Databases on Dedicated Exadata infrastructure, to provision less than 1 core, enter a fractional value in an increment of 0.1. For example, you can provision 0.3 or 0.4 cores, but not 0.35 cores. (Note that fractional OCPU values are not supported for Autonomous AI Database Serverless instances.) - To provision 1 or more cores, you must enter an integer between 1 and the maximum number of cores available for the infrastructure shape. For example, you can provision 2 cores or 3 cores, but not 2.5 cores. This applies to an Autonomous AI Database Serverless instance or an Autonomous AI Database on Dedicated Exadata Infrastructure. - For Autonomous AI Database Serverless instances, this parameter is not used. For Autonomous AI Databases on Dedicated Exadata infrastructure, the maximum number of cores is determined by the infrastructure shape. See [Characteristics of Infrastructure Shapes](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbde/) for shape details. **Note:** This parameter cannot be used with the `cpuCoreCount` parameter. ' format: float minimum: 0.1 type: number privateEndpointIp: description: The private endpoint Ip address for the resource. type: string privateEndpointLabel: description: 'The resource''s private endpoint label. - Setting the endpoint label to a non-empty string creates a private endpoint database. - Resetting the endpoint label to an empty string, after the creation of the private endpoint database, changes the private endpoint database to a public endpoint database. - Setting the endpoint label to a non-empty string value, updates to a new private endpoint database, when the database is disabled and re-enabled. This setting cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, dbWorkload, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, or isFreeTier. ' type: string resourcePoolLeaderId: description: The unique identifier for leader Autonomous AI Database OCID [OCID](/Content/General/Concepts/identifiers.htm). maxLength: 255 minLength: 1 type: string resourcePoolSummary: $ref: '#/components/schemas/ResourcePoolSummary' scheduledOperations: description: 'The list of scheduled operations. Consists of values such as dayOfWeek, scheduledStartTime, scheduledStopTime. This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. ' items: $ref: '#/components/schemas/ScheduledOperationDetails' type: array secretId: description: 'The OCI vault secret [/Content/General/Concepts/identifiers.htm]OCID. This cannot be used in conjunction with adminPassword. ' maxLength: 255 minLength: 1 type: string secretVersionNumber: description: The version of the vault secret. If no version is specified, the latest version will be used. maximum: 60 minimum: 1 type: integer 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 [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}` ' type: object source: default: NONE description: 'The source of the database: Use `NONE` for creating a new Autonomous AI Database. Use `DATABASE` for creating a new Autonomous AI Database by cloning an existing Autonomous AI Database. Use `CROSS_REGION_DATAGUARD` to create a standby Data Guard database in another region. For [Autonomous AI Database Serverless instances](https://docs.oracle.com/en/cloud/paas/autonomous-database/serverless/), the following cloning options are available: Use `BACKUP_FROM_ID` for creating a new Autonomous AI Database from a specified backup. Use `BACKUP_FROM_TIMESTAMP` for creating a point-in-time Autonomous AI Database clone using backups. For more information, see [Cloning and Moving an Autonomous AI Database](https://docs.oracle.com/en/cloud/paas/autonomous-database/adbsa/clone-autonomous-database.html#GUID-D771796F-5081-4CFB-A7FF-0F893EABD7BC). ' enum: - NONE - DATABASE - BACKUP_FROM_ID - BACKUP_FROM_TIMESTAMP - UNDELETE_ADB - CLONE_TO_REFRESHABLE - CROSS_REGION_DATAGUARD - CROSS_REGION_DISASTER_RECOVERY type: string standbyWhitelistedIps: description: 'The client IP access control list (ACL). This feature is available for [Autonomous AI Database Serverless] (https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html) and on Exadata Cloud@Customer. Only clients connecting from an IP address included in the ACL may access the Autonomous AI Database instance. If `arePrimaryWhitelistedIpsUsed` is ''TRUE'' then Autonomous AI Database uses this primary''s IP access control list (ACL) for the disaster recovery peer called `standbywhitelistedips`. For Autonomous AI Database Serverless, this is an array of CIDR (classless inter-domain routing) notations for a subnet or VCN OCID (virtual cloud network Oracle Cloud ID). Multiple IPs and VCN OCIDs should be separate strings separated by commas, but if it’s other configurations that need multiple pieces of information then its each piece is connected with semicolon (;) as a delimiter. Example: `["1.1.1.1","1.1.1.0/24","ocid1.vcn.oc1.sea.","ocid1.vcn.oc1.sea.;1.1.1.1","ocid1.vcn.oc1.sea.;1.1.0.0/16"]` For Exadata Cloud@Customer, this is an array of IP addresses or CIDR notations. Example: `["1.1.1.1","1.1.1.0/24","1.1.2.25"]` For an update operation, if you want to delete all the IPs in the ACL, use an array with a single empty string entry. This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. ' items: maxLength: 1024 minLength: 0 type: string type: array subnetId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet the resource is associated with. **Subnet Restrictions:** - For bare metal DB systems and for single node virtual machine DB systems, do not use a subnet that overlaps with 192.168.16.16/28. - For Exadata and virtual machine 2-node RAC systems, do not use a subnet that overlaps with 192.168.128.0/20. - For Autonomous AI Database, setting this will disable public secure access to the database. These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and the backup subnet. ' maxLength: 255 minLength: 1 type: string subscriptionId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the subscription with which resource needs to be associated with. maxLength: 255 minLength: 1 type: string transportableTablespace: $ref: '#/components/schemas/ImportTransportableTablespaceDetails' vaultId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [vault](/Content/KeyManagement/Concepts/keyoverview.htm#concepts). This parameter and `secretId` are required for Customer Managed Keys. maxLength: 255 minLength: 1 type: string whitelistedIps: description: 'The client IP access control list (ACL). This feature is available for [Autonomous AI Database Serverless] (https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html) and on Exadata Cloud@Customer. Only clients connecting from an IP address included in the ACL may access the Autonomous AI Database instance. If `arePrimaryWhitelistedIpsUsed` is ''TRUE'' then Autonomous AI Database uses this primary''s IP access control list (ACL) for the disaster recovery peer called `standbywhitelistedips`. For Autonomous AI Database Serverless, this is an array of CIDR (classless inter-domain routing) notations for a subnet or VCN OCID (virtual cloud network Oracle Cloud ID). Multiple IPs and VCN OCIDs should be separate strings separated by commas, but if it’s other configurations that need multiple pieces of information then its each piece is connected with semicolon (;) as a delimiter. Example: `["1.1.1.1","1.1.1.0/24","ocid1.vcn.oc1.sea.","ocid1.vcn.oc1.sea.;1.1.1.1","ocid1.vcn.oc1.sea.;1.1.0.0/16"]` For Exadata Cloud@Customer, this is an array of IP addresses or CIDR notations. Example: `["1.1.1.1","1.1.1.0/24","1.1.2.25"]` For an update operation, if you want to delete all the IPs in the ACL, use an array with a single empty string entry. This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. ' items: maxLength: 1024 minLength: 0 type: string type: array required: - compartmentId EditAutonomousContainerDatabaseDataguardDetails: description: 'The configuration details for updating a Autonomous Container DatabaseData Guard for a Autonomous Container Database. ' properties: fastStartFailOverLagLimitInSeconds: description: The lag time for my preference based on data loss tolerance in seconds. maximum: 3600 minimum: 5 type: integer isAutomaticFailoverEnabled: description: 'Indicates whether Automatic Failover is enabled for Autonomous Container Database Dataguard Association ' type: boolean protectionMode: description: 'The protection mode of this Autonomous Data Guard association. For more information, see [Oracle Data Guard Protection Modes](http://docs.oracle.com/database/122/SBYDB/oracle-data-guard-protection-modes.htm#SBYDB02000) in the Oracle Data Guard documentation. ' enum: - MAXIMUM_AVAILABILITY - MAXIMUM_PERFORMANCE type: string UpdateVmClusterDetails: description: 'Details for updating the VM cluster. Applies to Exadata Cloud@Customer instances only. For details on updating a cloud VM cluster in an Exadata Cloud Service instance, see [UpdateCloudVmClusterDetails Reference ](#/en/database/latest/datatypes/UpdateCloudVmClusterDetails) ' properties: cpuCoreCount: description: The number of CPU cores to enable for the VM cluster. type: integer dataCollectionOptions: $ref: '#/components/schemas/DataCollectionOptions' dataStoragePercentage: description: 'The percentage assigned to DATA storage (user data and database files). See [Storage Configuration](/Content/Database/Concepts/exaoverview.htm#Exadata) in the Exadata documentation for details on the impact of the configuration settings on storage. ' format: int32 maximum: 100 minimum: 0 type: integer dataStorageSizeInGBs: description: The data disk group size to be allocated in GBs. format: double minimum: 32 type: number dataStorageSizeInTBs: description: The data disk group size to be allocated in TBs. format: double type: number dbNodeStorageSizeInGBs: description: The local node storage to be allocated in GBs. type: integer definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object fileSystemConfigurationDetails: description: Details of the file system configuration of the VM cluster. items: $ref: '#/components/schemas/FileSystemConfigurationDetail' maxItems: 1024 type: array freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object isLocalBackupEnabled: description: 'If true, database backup on local Exadata storage is configured for the VM cluster. If false, database backup on local Exadata storage is not available in the VM cluster. ' type: boolean isSparseDiskgroupEnabled: description: 'If true, sparse disk group is configured for the VM cluster. If false, sparse disk group is not created. ' type: boolean licenseModel: description: 'The Oracle license model that applies to the VM cluster. The default is BRING_YOUR_OWN_LICENSE. ' enum: - LICENSE_INCLUDED - BRING_YOUR_OWN_LICENSE type: string memorySizeInGBs: description: The memory to be allocated in GBs. type: integer ocpuCount: description: The number of OCPU cores to enable for the VM cluster. Only 1 decimal place is allowed for the fractional part. format: float minimum: 0.1 type: number x-example: 0.2 recoStoragePercentage: description: 'The percentage assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). See [Storage Configuration](/Content/Database/Concepts/exaoverview.htm#Exadata) in the Exadata documentation for details on the impact of the configuration settings on storage. ' format: int32 maximum: 100 minimum: 0 type: integer sparseStoragePercentage: description: 'The percentage assigned to SPARSE storage (Exadata snapshots). See [Storage Configuration](/Content/Database/Concepts/exaoverview.htm#Exadata) in the Exadata documentation for details on the impact of the configuration settings on storage. ' format: int32 maximum: 100 minimum: 0 type: integer sshPublicKeys: description: The public key portion of one or more key pairs used for SSH access to the VM cluster. items: maxLength: 1024 minLength: 1 type: string type: array updateDetails: $ref: '#/components/schemas/VmClusterUpdateDetails' version: $ref: '#/components/schemas/PatchDetails' vmBackupStorageType: description: Specifies the type of VM Backups Storage and supported values are LOCAL and EXASCALE. Storage Type can only be changed once from LOCAL to EXASCALE. EXASCALE to LOCAL is not permitted. enum: - LOCAL - EXASCALE type: string CreateOneoffPatchDetails: description: 'Data to create the one-off patch for the specificed database version. ' properties: compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string dbVersion: description: 'A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation. This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. ' type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object displayName: description: One-off patch name. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object oneOffPatches: description: List of one-off patches for Database Homes. items: type: string type: array releaseUpdate: description: The PSU or PBP or Release Updates. To get a list of supported versions, use the [ListDbVersions](#/en/database/latest/DbVersionSummary/ListDbVersions) operation. maxLength: 255 minLength: 1 type: string required: - compartmentId - displayName - dbVersion - releaseUpdate RotateAutonomousDatabaseEncryptionKeyDetails: description: Key details provided by the user for rotate key operation for Autonomous AI Database. properties: keyVersionId: description: Key version ocid of the key provided by the user for rotate operation. [OCID](/Content/General/Concepts/identifiers.htm). maxLength: 255 minLength: 1 type: string ExternalNonContainerDatabase: allOf: - $ref: '#/components/schemas/ExternalDatabaseBase' - properties: operationsInsightsConfig: $ref: '#/components/schemas/OperationsInsightsConfig' type: object description: an external Oracle non-container database. ActionParamValuesSummary: description: 'Details of the action parameter and its possible values that is used in listParamsForActionType. ' properties: defaultValue: description: The default value for this parameter. maxLength: 255 minLength: 1 type: string isRequired: description: Whether this parameter is required or not for this action type.、 type: boolean parameterName: description: The name of this parameter. maxLength: 255 minLength: 1 type: string parameterType: default: STRING description: The type of the parameter. enum: - BOOLEAN - STRING - INTEGER type: string parameterValues: description: Possible values for this parameter. In case of integer it's min and max values. items: type: string type: array required: - parameterName - parameterType - parameterValues - isRequired type: object EnableExternalPluggableDatabaseStackMonitoringDetails: allOf: - $ref: '#/components/schemas/EnableExternalDatabaseStackMonitoringDetailsBase' description: Details to enable Stack Monitoring on the external pluggable database. CreateExternalContainerDatabaseDetails: allOf: - $ref: '#/components/schemas/CreateExternalDatabaseDetailsBase' description: 'Details for creating an external container database resource. ' ChangeCompartmentDetails: description: 'The configuration details for moving the resource. ' properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the resource to. ' maxLength: 255 minLength: 1 type: string required: - compartmentId PatchDetails: description: 'The details about what actions to perform and using what patch to the specified target. This is part of an update request that is applied to a version field on the target such as DB system, Database Home, etc. ' properties: action: description: The action to perform on the patch. enum: - APPLY - PRECHECK type: string databaseSoftwareImageId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the database software image. maxLength: 255 minLength: 1 type: string patchId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the patch. maxLength: 255 minLength: 1 type: string LaunchDbSystemBase: description: 'Parameters for provisioning a bare metal, virtual machine, or Exadata DB system. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' discriminator: propertyName: source properties: availabilityDomain: description: The availability domain where the DB system is located. maxLength: 255 minLength: 1 type: string backupNetworkNsgIds: description: 'A list of the [OCIDs](/Content/General/Concepts/identifiers.htm) of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see [Security Rules](/Content/Network/Concepts/securityrules.htm). Applicable only to Exadata systems. ' items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array uniqueItems: true backupSubnetId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the backup network subnet the DB system is associated with. Applicable only to Exadata DB systems. **Subnet Restrictions:** See the subnet restrictions information for **subnetId**. ' maxLength: 255 minLength: 1 type: string clusterName: description: 'The cluster name for Exadata and 2-node RAC virtual machine DB systems. The cluster name must begin with an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive. ' maxLength: 11 minLength: 1 type: string compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment the DB system belongs in. maxLength: 255 minLength: 1 type: string computeCount: description: The number of compute servers for the DB system. format: int32 type: integer computeModel: description: The compute model for Base Database Service. This is required if using the `computeCount` parameter. If using `cpuCoreCount` then it is an error to specify `computeModel` to a non-null value. The ECPU compute model is the recommended model, and the OCPU compute model is legacy. enum: - ECPU - OCPU type: string cpuCoreCount: description: 'The number of CPU cores to enable for a bare metal or Exadata DB system or AMD VMDB Systems. The valid values depend on the specified shape: - BM.DenseIO1.36 - Specify a multiple of 2, from 2 to 36. - BM.DenseIO2.52 - Specify a multiple of 2, from 2 to 52. - Exadata.Base.48 - Specify a multiple of 2, from 0 to 48. - Exadata.Quarter1.84 - Specify a multiple of 2, from 22 to 84. - Exadata.Half1.168 - Specify a multiple of 4, from 44 to 168. - Exadata.Full1.336 - Specify a multiple of 8, from 88 to 336. - Exadata.Quarter2.92 - Specify a multiple of 2, from 0 to 92. - Exadata.Half2.184 - Specify a multiple of 4, from 0 to 184. - Exadata.Full2.368 - Specify a multiple of 8, from 0 to 368. - VM.Standard.E4.Flex - Specify any thing from 1 to 64. This parameter is not used for INTEL virtual machine DB systems because virtual machine DB systems have a set number of cores for each shape. For information about the number of cores for a virtual machine DB system shape, see [Virtual Machine DB Systems](/Content/Database/Concepts/overview.htm#virtualmachine) ' minimum: 1 type: integer dataCollectionOptions: $ref: '#/components/schemas/DataCollectionOptions' dataStoragePercentage: description: 'The percentage assigned to DATA storage (user data and database files). The remaining percentage is assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). Specify 80 or 40. The default is 80 percent assigned to DATA storage. Not applicable for virtual machine DB systems. ' type: integer dbSystemOptions: $ref: '#/components/schemas/DbSystemOptions' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object displayName: description: The user-friendly name for the DB system. The name does not have to be unique. maxLength: 255 minLength: 1 type: string domain: description: 'A domain name used for the DB system. If the Oracle-provided Internet and VCN Resolver is enabled for the specified subnet, the domain name for the subnet is used (do not provide one). Otherwise, provide a valid DNS domain name. Hyphens (-) are not permitted. ' type: string faultDomains: description: 'A Fault Domain is a grouping of hardware and infrastructure within an availability domain. Fault Domains let you distribute your instances so that they are not on the same physical hardware within a single availability domain. A hardware failure or maintenance that affects one Fault Domain does not affect DB systems in other Fault Domains. If you do not specify the Fault Domain, the system selects one for you. To change the Fault Domain for a DB system, terminate it and launch a new DB system in the preferred Fault Domain. If the node count is greater than 1, you can specify which Fault Domains these nodes will be distributed into. The system assigns your nodes automatically to the Fault Domains you specify so that no Fault Domain contains more than one node. To get a list of Fault Domains, use the [ListFaultDomains](#/en/identity/latest/FaultDomain/ListFaultDomains) operation in the Identity and Access Management Service API. Example: `FAULT-DOMAIN-1` ' items: maxLength: 255 minLength: 1 type: string type: array freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object hostname: description: 'The hostname for the DB system. The hostname must begin with an alphabetic character, and can contain alphanumeric characters and hyphens (-). The maximum length of the hostname is 16 characters for bare metal and virtual machine DB systems, and 12 characters for Exadata DB systems. The maximum length of the combined hostname and domain is 63 characters. **Note:** The hostname must be unique within the subnet. If it is not unique, the DB system will fail to provision. ' type: string initialDataStorageSizeInGB: description: 'Size (in GB) of the initial data volume that will be created and attached to a virtual machine DB system. You can scale up storage after provisioning, as needed. Note that the total storage size attached will be more than the amount you specify to allow for REDO/RECO space and software volume. By default this will be set to 256. ' minimum: 2 type: integer kmsKeyId: description: The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. maxLength: 255 minLength: 1 type: string kmsKeyVersionId: description: 'The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous AI Database Serverless does not use key versions, hence is not applicable for Autonomous AI Database Serverless instances. ' maxLength: 255 minLength: 1 type: string nodeCount: description: 'The number of nodes to launch for a virtual machine DB system. Specify either 1 or 2. By default this will be set to 1. ' minimum: 1 type: integer nsgIds: description: 'The list of [OCIDs](/Content/General/Concepts/identifiers.htm) for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see [Security Rules](/Content/Network/Concepts/securityrules.htm). ' items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array uniqueItems: true privateIp: description: 'A private IP address of your choice. 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. ' maxLength: 46 minLength: 1 type: string privateIpV6: description: 'A private IPv6 address of your choice. Must be an available IP address within the subnet''s CIDR. If you don''t specify a value and the subnet is dual stack, Oracle automatically assigns a private IPv6 address from the subnet. ' maxLength: 46 minLength: 1 type: string 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 [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}` ' type: object shape: description: 'The shape of the DB system. The shape determines resources allocated to the DB system. - For virtual machine shapes, the number of CPU cores and memory - For bare metal and Exadata shapes, the number of CPU cores, memory, and storage To get a list of shapes, use the [ListDbSystemShapes](#/en/database/latest/DbSystemShapeSummary/ListDbSystemShapes) operation. ' maxLength: 255 minLength: 1 type: string source: default: NONE description: 'The source of the database: Use `NONE` for creating a new database. Use `DB_BACKUP` for creating a new database by restoring from a backup. Use `DATABASE` for creating a new database from an existing database, including archive redo log data. The default is `NONE`. ' enum: - NONE - DB_BACKUP - DATABASE - DB_SYSTEM - DATAGUARD type: string sparseDiskgroup: description: 'If true, Sparse Diskgroup is configured for Exadata dbsystem. If False, Sparse diskgroup is not configured. ' type: boolean sshPublicKeys: description: The public key portion of the key pair to use for SSH access to the DB system. Multiple public keys can be provided. The length of the combined keys cannot exceed 40,000 characters. items: maxLength: 1024 minLength: 1 type: string type: array storageVolumePerformanceMode: default: BALANCED description: 'The block storage volume performance level. Valid values are `BALANCED` and `HIGH_PERFORMANCE`. See [Block Volume Performance](/Content/Block/Concepts/blockvolumeperformance.htm) for more information. ' enum: - BALANCED - HIGH_PERFORMANCE type: string subnetId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet the DB system is associated with. **Subnet Restrictions:** - For bare metal DB systems and for single node virtual machine DB systems, do not use a subnet that overlaps with 192.168.16.16/28. - For Exadata and virtual machine 2-node RAC DB systems, do not use a subnet that overlaps with 192.168.128.0/20. These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and the backup subnet. ' maxLength: 255 minLength: 1 type: string timeZone: description: The time zone to use for the DB system. For details, see [DB System Time Zones](/Content/Database/References/timezones.htm). maxLength: 255 minLength: 1 type: string required: - compartmentId - availabilityDomain - subnetId - shape - sshPublicKeys - hostname DatabaseUpgradeSourceBase: description: 'Details for the database upgrade source. ' discriminator: propertyName: source properties: options: description: 'Additional upgrade options supported by DBUA(Database Upgrade Assistant). Example: "-upgradeTimezone false -keepEvents" ' type: string source: description: "The source of the Oracle Database software to be used for the upgrade.\n - Use `DB_HOME` to specify an existing Database Home to upgrade the database. The database is moved to the target Database Home and makes use of the Oracle Database software version of the target Database Home.\n - Use `DB_VERSION` to specify a generally-available Oracle Database software version to upgrade the database.\n - Use `DB_SOFTWARE_IMAGE` to specify a [database software image](/iaas/Content/Database/Concepts/databasesoftwareimage.htm) to upgrade the database.\n" enum: - DB_HOME - DB_VERSION - DB_SOFTWARE_IMAGE type: string ImportTransportableTablespaceDetails: description: 'Details for importing transportable tablespace for an Autonomous AI Database. ' properties: ttsBundleUrl: description: URL for OCI Storage location for a Transportable Tablespace (TTS) bundle. type: string required: - ttsBundleUrl ManagedSoftwareUpdatePreferenceDetails: description: 'Oracle Managed Database Software Updates schedule will be created based on the provided update preferences ' properties: daysOfWeek: description: 'The update should be applied on the database for the selected days of the week. ' items: $ref: '#/components/schemas/ManagedSoftwareUpdateDayOfWeek' maxItems: 1 minItems: 1 type: array uniqueItems: true hourOfDay: description: 'The update should be applied on the database for the selected hour of the day. ' maximum: 23 minimum: 0 type: integer updateMode: description: 'Oracle Managed Database Software update method, either "ROLLING" or "NONROLLING". Default value is ROLLING. *IMPORTANT*: Non-rolling Database Software update update involves system down time. ' enum: - ROLLING - NONROLLING type: string versionSchemeDetails: $ref: '#/components/schemas/VersionSchemeDetails' required: - daysOfWeek - hourOfDay - versionSchemeDetails FlexComponentSummary: description: 'The Flex Components for a DB system. The Flex Component determines resources to allocate to the DB system - CPU cores, memory and storage for Flex shapes. For Exadata flexible shapes, detailed specifications can be found in https://docs.oracle.com/en/engineered-systems/exadata-cloud-service/ecscm/exa-service-desc.html#GUID-9E090174-5C57-4EB1-9243-B470F9F10D6B 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: availableCoreCount: description: The maximum number of CPU cores that can ben enabled on the DB Server for this Flex Component. format: int32 type: integer availableDbStorageInGBs: description: The maximum storage that can be enabled on the Storage Server for this Flex Component. format: int32 type: integer availableLocalStorageInGBs: description: The maximum local storage that can be enabled on the DB Server for this Flex Component. format: int32 type: integer availableMemoryInGBs: description: The maximum memory size that can be enabled on the DB Server for this Flex Component. type: integer computeModel: description: The compute model of the DB Server for this Flex Component. maxLength: 255 minLength: 1 type: string descriptionSummary: description: The description summary for this Flex Component. maxLength: 255 minLength: 1 type: string hardwareType: description: The hardware type of the DB (Compute) or Storage (Cell) Server for this Flex Component. enum: - COMPUTE - CELL type: string minimumCoreCount: description: The minimum number of CPU cores that can be enabled on the DB Server for this Flex Component. format: int32 type: integer name: description: The name of the Flex Component used for the DB system. maxLength: 255 minLength: 1 type: string runtimeMinimumCoreCount: description: The runtime minimum number of CPU cores that can be enabled for this Flex Component. format: int32 type: integer shape: description: The name of the DB system shape for this Flex Component. maxLength: 255 minLength: 1 type: string required: - name Update: allOf: - $ref: '#/components/schemas/UpdateSummary' RotateAutonomousContainerDatabaseEncryptionKeyDetails: description: Key details provided by the user for rotate key operation for Autonomous AI Database. properties: keyVersionId: description: Key version ocid of the key provided by the user for rotate operation. [OCID](/Content/General/Concepts/identifiers.htm). maxLength: 255 minLength: 1 type: string DbVersionSummary: description: 'The Oracle Database software version. 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: isLatestForMajorVersion: description: True if this version of the Oracle Database software is the latest version for a release. type: boolean isPreviewDbVersion: description: True if this version of the Oracle Database software is the preview version. type: boolean isUpgradeSupported: description: True if this version of the Oracle Database software is supported for Upgrade. type: boolean supportsPdb: description: True if this version of the Oracle Database software supports pluggable databases. type: boolean version: description: A valid Oracle Database version. maxLength: 255 minLength: 1 type: string required: - version ExecutionWindow: allOf: - $ref: '#/components/schemas/ExecutionWindowSummary' description: 'Details of an execution window. ' AutonomousVirtualMachine: allOf: - $ref: '#/components/schemas/AutonomousVirtualMachineSummary' description: Autonomous Virtual Machine details. CustomerContact: description: 'Customer contact information that will be used by Oracle to provide notifications needed by database and infrastructure administrators. ' properties: email: description: The email address used by Oracle to send notifications regarding databases and infrastructure. maxLength: 320 minLength: 1 type: string type: object SchedulingWindowSummary: description: 'Details of a Scheduling Window. ' properties: compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object displayName: description: The user-friendly name for the Scheduling Window. The name does not need to be unique. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Scheduling Window. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: Additional information about the current lifecycle state. type: string lifecycleState: description: 'The current state of the Scheduling Window. Valid states are CREATING, ACTIVE, UPDATING, FAILED, DELETING and DELETED. ' enum: - CREATING - AVAILABLE - UPDATING - FAILED - DELETING - DELETED type: string schedulingPolicyId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Scheduling Policy. maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object timeCreated: description: The date and time the Scheduling Window was created. format: date-time type: string timeNextSchedulingWindowStarts: description: The date and time of the next upcoming window associated within the schedulingWindow is planned to start. format: date-time type: string timeUpdated: description: The last date and time that the Scheduling Window was updated. format: date-time type: string windowPreference: $ref: '#/components/schemas/WindowPreferenceDetail' required: - id - lifecycleState - schedulingPolicyId - windowPreference type: object DatabaseConnectionStringProfile: description: 'The connection string profile to allow clients to group, filter and select connection string values based on structured metadata. ' properties: consumerGroup: description: Consumer group used by the connection. enum: - HIGH - MEDIUM - LOW - TP - TPURGENT type: string displayName: description: A user-friendly name for the connection. maxLength: 255 minLength: 1 type: string hostFormat: description: Host format used in connection string. enum: - FQDN - IP type: string isRegional: description: True for a regional connection string, applicable to cross-region DG only. type: boolean protocol: description: Protocol used by the connection. enum: - TCP - TCPS type: string sessionMode: description: Specifies whether the listener performs a direct hand-off of the session, or redirects the session. In RAC deployments where SCAN is used, sessions are redirected to a Node VIP. Use `DIRECT` for direct hand-offs. Use `REDIRECT` to redirect the session. enum: - DIRECT - REDIRECT type: string syntaxFormat: description: 'Specifies whether the connection string is using the long (`LONG`), Easy Connect (`EZCONNECT`), or Easy Connect Plus (`EZCONNECTPLUS`) format. Autonomous AI Database Serverless instances always use the long format. ' enum: - LONG - EZCONNECT - EZCONNECTPLUS type: string tlsAuthentication: description: Specifies whether the TLS handshake is using one-way (`SERVER`) or mutual (`MUTUAL`) authentication. enum: - SERVER - MUTUAL type: string value: description: Connection string value. type: string required: - displayName - value - protocol - hostFormat - sessionMode - syntaxFormat SchedulingPolicy: allOf: - $ref: '#/components/schemas/SchedulingPolicySummary' description: 'Details of a Scheduling Policy. ' RestartAutonomousContainerDatabaseDetails: description: Request details to restart an Autonomous Container Database with force option. properties: isForceRestart: description: If set to `true`, restarts the Autonomous Container Database with force option. type: boolean type: object DatabaseManagementConfig: description: The configuration of the Database Management service. properties: databaseManagementConnectionId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the [external database connector](#/en/database/latest/datatypes/CreateExternalDatabaseConnectorDetails). ' maxLength: 255 minLength: 1 type: string databaseManagementStatus: description: The status of the Database Management service. enum: - ENABLING - ENABLED - DISABLING - NOT_ENABLED - FAILED_ENABLING - FAILED_DISABLING type: string licenseModel: description: 'The Oracle license model that applies to the external database. ' enum: - LICENSE_INCLUDED - BRING_YOUR_OWN_LICENSE type: string required: - databaseManagementStatus VmClusterNetworkSummary: description: 'Details of the VM cluster network. Applies to Exadata Cloud@Customer instances only. ' properties: compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object displayName: description: The user-friendly name for the VM cluster network. The name does not need to be unique. maxLength: 255 minLength: 1 type: string dns: description: The list of DNS server IP addresses. Maximum of 3 allowed. items: maxLength: 1024 minLength: 1 type: string maxItems: 3 type: array drScans: description: The SCAN details for DR network items: $ref: '#/components/schemas/DrScanDetails' type: array exadataInfrastructureId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the VM cluster network. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: Additional information about the current lifecycle state. type: string lifecycleState: description: "The current state of the VM cluster network.\nCREATING - The resource is being created\nREQUIRES_VALIDATION - The resource is created and may not be usable until it is validated.\nVALIDATING - The resource is being validated and not available to use.\nVALIDATED - The resource is validated and is available for consumption by VM cluster.\nVALIDATION_FAILED - The resource validation has failed and might require user input to be corrected.\nUPDATING - The resource is being updated and not available to use.\nALLOCATED - The resource is is currently being used by VM cluster.\nTERMINATING - The resource is being deleted and not available to use.\nTERMINATED - The resource is deleted and unavailable.\nFAILED - The resource is in a failed state due to validation or other errors.\nNEEDS_ATTENTION - The resource is in needs attention state as some of it's child nodes are not validated\n and unusable by VM cluster.\n" enum: - CREATING - REQUIRES_VALIDATION - VALIDATING - VALIDATED - VALIDATION_FAILED - UPDATING - ALLOCATED - TERMINATING - TERMINATED - FAILED - NEEDS_ATTENTION type: string ntp: description: The list of NTP server IP addresses. Maximum of 3 allowed. items: maxLength: 1024 minLength: 1 type: string maxItems: 3 type: array scans: description: The SCAN details. items: $ref: '#/components/schemas/ScanDetails' maxItems: 3 type: array systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object timeCreated: description: The date and time when the VM cluster network was created. format: date-time type: string vmClusterId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the associated VM Cluster. maxLength: 255 minLength: 1 type: string vmNetworks: description: Details of the client and backup networks. items: $ref: '#/components/schemas/VmNetworkDetails' type: array Database: allOf: - $ref: '#/components/schemas/DatabaseSummary' - properties: null DbConnectionBundle: allOf: - $ref: '#/components/schemas/DbConnectionBundleSummary' - type: object description: Details of a database connection bundle. ScheduledOperationDetails: description: 'Details of scheduled operation. ' properties: dayOfWeek: $ref: '#/components/schemas/DayOfWeek' scheduledStartTime: description: auto start time. value must be of ISO-8601 format "HH:mm" maxLength: 50 minLength: 1 type: string scheduledStopTime: description: auto stop time. value must be of ISO-8601 format "HH:mm" maxLength: 50 minLength: 1 type: string required: - dayOfWeek type: object DataGuardGroup: description: "Details of Data Guard setup that the given database is part of. \nAlso includes information about databases part of this Data Guard group and properties for their Data Guard configuration.\n" properties: members: description: List of Data Guard members, representing each database that is part of Data Guard. items: $ref: '#/components/schemas/DataGuardGroupMember' type: array protectionMode: description: 'The protection mode of this Data Guard. For more information, see [Oracle Data Guard Protection Modes](http://docs.oracle.com/database/122/SBYDB/oracle-data-guard-protection-modes.htm#SBYDB02000) in the Oracle Data Guard documentation. ' enum: - MAXIMUM_AVAILABILITY - MAXIMUM_PERFORMANCE - MAXIMUM_PROTECTION type: string type: object ResourcePoolShapeSummary: description: 'An Autonomous AI Database Resource Pool. This object provides all the information related to the resource pool. ' properties: shape: description: 'Predefined shape of the resource pool. ' type: integer required: - shape type: object KeyStoreAssociatedDatabaseDetails: description: The databases associated with a key store properties: dbName: description: The name of the database that is associated with the key store. maxLength: 14 minLength: 1 type: string dbUniqueName: description: The unique name of the database that is associated with the key store. maxLength: 30 minLength: 1 type: string id: description: The database [OCID](/Content/General/Concepts/identifiers.htm). maxLength: 255 minLength: 1 type: string FailoverDataGuardAssociationDetails: description: 'The Data Guard association failover parameters. ' properties: databaseAdminPassword: description: The DB system administrator password. maxLength: 255 minLength: 1 type: string required: - databaseAdminPassword BackupSummary: description: 'A database backup. 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). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' properties: availabilityDomain: description: The name of the availability domain where the database backup is stored. type: string backupDestinationType: description: Type of the backup destination. enum: - OBJECT_STORE - DBRS - AWS type: string compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string databaseEdition: description: 'The Oracle Database Edition that applies to all the databases on the DB system. Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE. ' enum: - STANDARD_EDITION - ENTERPRISE_EDITION - ENTERPRISE_EDITION_HIGH_PERFORMANCE - ENTERPRISE_EDITION_EXTREME_PERFORMANCE - ENTERPRISE_EDITION_DEVELOPER type: string databaseId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the database. maxLength: 255 minLength: 1 type: string databaseSizeInGBs: description: 'The size of the database in gigabytes at the time the backup was taken. ' format: double type: number displayName: description: The user-friendly name for the backup. The name does not have to be unique. maxLength: 255 minLength: 1 type: string encryptionKeyLocationDetails: $ref: '#/components/schemas/EncryptionKeyLocationDetails' id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the backup. maxLength: 255 minLength: 1 type: string isUsingOracleManagedKeys: description: True if Oracle Managed Keys is required for restore of the backup. type: boolean kmsKeyId: description: The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. maxLength: 255 minLength: 1 type: string kmsKeyVersionId: description: 'The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous AI Database Serverless does not use key versions, hence is not applicable for Autonomous AI Database Serverless instances. ' maxLength: 255 minLength: 1 type: string lifecycleDetails: description: Additional information about the current lifecycle state. type: string lifecycleState: description: The current state of the backup. enum: - CREATING - ACTIVE - DELETING - DELETED - FAILED - RESTORING - UPDATING type: string retentionPeriodInDays: description: The retention period of the long term backup in days. maximum: 3650 minimum: 90 type: integer retentionPeriodInYears: description: The retention period of the long term backup in years. maximum: 10 minimum: 1 type: integer secondaryKmsKeyIds: description: List of OCIDs of the key containers used as the secondary encryption key in database transparent data encryption (TDE) operations. items: maxLength: 255 minLength: 1 type: string type: array shape: description: Shape of the backup's source database. type: string timeEnded: description: The date and time the backup was completed. format: date-time type: string timeExpiryScheduled: description: Expiration time of the long term database backup. format: date-time type: string timeStarted: description: The date and time the backup started. format: date-time type: string type: description: The type of backup. enum: - INCREMENTAL - FULL - VIRTUAL_FULL type: string vaultId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [vault](/Content/KeyManagement/Concepts/keyoverview.htm#concepts). This parameter and `secretId` are required for Customer Managed Keys. maxLength: 255 minLength: 1 type: string version: description: Version of the backup's source database type: string RecoveryApplianceDetails: description: Information about the recovery appliance configuration associated with the Autonomous Container Database. properties: allocatedStorageSizeInGBs: description: The storage size of the backup destination allocated for an Autonomous Container Database to store backups on the recovery appliance, in GBs, rounded to the nearest integer. type: integer recoveryWindowInDays: description: Number of days between the current and earliest point of recoverability covered by automatic backups. type: integer timeRecoveryApplianceDetailsUpdated: description: The time when the recovery appliance details are updated. format: date-time type: string CreateExecutionWindowDetails: description: 'Request to create an execution window resource under an execution resource. ' properties: compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object executionResourceId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the execution resource the execution window belongs to. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object isEnforcedDuration: default: false description: Indicates if duration the user plans to allocate for scheduling window is strictly enforced. The default value is `FALSE`. type: boolean timeScheduled: description: The scheduled start date and time of the execution window. format: date-time type: string windowDurationInMins: description: 'Duration window allows user to set a duration they plan to allocate for Scheduling window. The duration is in minutes. ' minimum: 120 type: integer required: - compartmentId - executionResourceId - timeScheduled - windowDurationInMins ExadbVmClusterUpdateHistoryEntrySummary: description: 'The record of an maintenance update action on a specified Exadata VM cluster on Exascale Infrastructure. ' properties: id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the maintenance update history entry. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: 'Descriptive text providing additional details about the lifecycle state. ' type: string lifecycleState: description: The current lifecycle state of the maintenance update operation. enum: - IN_PROGRESS - SUCCEEDED - FAILED type: string timeCompleted: description: The date and time when the maintenance update action completed. format: date-time type: string timeStarted: description: The date and time when the maintenance update action started. format: date-time type: string updateAction: description: The update action. enum: - ROLLING_APPLY - NON_ROLLING_APPLY - PRECHECK - ROLLBACK type: string updateId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the maintenance update. maxLength: 255 minLength: 1 type: string updateType: description: The type of cloud VM cluster maintenance update. enum: - GI_UPGRADE - GI_PATCH - OS_UPDATE type: string version: description: The version of the maintenance update package. maxLength: 255 minLength: 1 type: string x-default-description: The version of the maintenance update package. required: - id - updateId - lifecycleState - timeStarted - updateType DatabaseTool: description: Summary of database tools of Autonomous AI Database. properties: isEnabled: default: false description: Indicates whether tool is enabled. type: boolean name: description: Name of database tool. enum: - APEX - DATABASE_ACTIONS - GRAPH_STUDIO - OML - DATA_TRANSFORMS - ORDS - MONGODB_API type: string required: - name type: object DownloadDbConnectionBundleDetails: description: 'Details to download a database connection bundle. ' properties: password: description: The password to encrypt the keys inside the bundle. The password must be at least 8 characters long and must include at least 1 letter and either 1 numeric character or 1 special character. minLength: 8 type: string required: - password EnableExternalDatabaseManagementDetailsBase: description: 'Details to enable Database Management on an external database. ' properties: externalDatabaseConnectorId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the [external database connector](#/en/database/latest/datatypes/CreateExternalDatabaseConnectorDetails). ' maxLength: 255 minLength: 1 type: string required: - externalDatabaseConnectorId PluggableDatabaseRefreshableCloneConfig: description: Pluggable Database Refreshable Clone Configuration. properties: isRefreshableClone: description: Indicates whether the Pluggable Database is a refreshable clone. type: boolean type: object AutonomousExadataInfrastructureShapeSummary: description: 'The shape of the Autonomous Exadata Infrastructure. The shape determines resources to allocate to the Autonomous Exadata Infrastructure (CPU cores, memory and storage). 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: availableCoreCount: description: The maximum number of CPU cores that can be enabled on the Autonomous Exadata Infrastructure. type: integer coreCountIncrement: description: The increment in which core count can be increased or decreased. type: integer maximumNodeCount: description: The maximum number of nodes available for the shape. type: integer minimumCoreCount: description: The minimum number of CPU cores that can be enabled on the Autonomous Exadata Infrastructure. type: integer minimumNodeCount: description: The minimum number of nodes available for the shape. type: integer name: description: The name of the shape used for the Autonomous Exadata Infrastructure. maxLength: 255 minLength: 1 type: string runtimeMinimumCoreCount: description: The runtime minimum number of CPU cores that can be enabled on the DB system for this shape. type: integer required: - name - availableCoreCount ExadataInfrastructure: allOf: - $ref: '#/components/schemas/ExadataInfrastructureSummary' description: ExadataInfrastructure UpdateExadbVmClusterDetails: description: 'Details for updating the Exadata VM cluster on Exascale Infrastructure. Applies to Exadata Database Service on Exascale Infrastructure only. ' properties: backupNetworkNsgIds: description: 'A list of the [OCIDs](/Content/General/Concepts/identifiers.htm) of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see [Security Rules](/Content/Network/Concepts/securityrules.htm). Applicable only to Exadata systems. ' items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array uniqueItems: true dataCollectionOptions: $ref: '#/components/schemas/DataCollectionOptions' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object displayName: description: The user-friendly name for the Exadata VM cluster on Exascale Infrastructure. The name does not need to be unique. maxLength: 255 minLength: 1 type: string enabledECpuCount: description: 'The number of ECPUs to enable for an Exadata VM cluster on Exascale Infrastructure. ' format: int32 minimum: 0 type: integer freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object gridImageId: description: 'Grid Setup will be done using this grid image id. The grid image ID can be obtained using the API /20160918/giVersions/{majorVersion}/minorVersions?compartmentId=&shapeFamily=EXADB_XS&availabilityDomain=. The list of supported major versions can be obtained using the API /20160918/giVersions?compartmentId=&shape=ExaDbXS&availabilityDomain= ' maxLength: 255 minLength: 1 type: string licenseModel: description: 'The Oracle license model that applies to the Exadata VM cluster on Exascale Infrastructure. The default is BRING_YOUR_OWN_LICENSE. ' enum: - LICENSE_INCLUDED - BRING_YOUR_OWN_LICENSE type: string nodeCount: description: 'The number of nodes to be added in the Exadata VM cluster on Exascale Infrastructure. ' format: int32 minimum: 1 type: integer nsgIds: description: 'The list of [OCIDs](/Content/General/Concepts/identifiers.htm) for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see [Security Rules](/Content/Network/Concepts/securityrules.htm). ' items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array uniqueItems: true 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 [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}` ' type: object sshPublicKeys: description: The public key portion of one or more key pairs used for SSH access to the Exadata VM cluster on Exascale Infrastructure. items: maxLength: 1024 minLength: 1 type: string type: array systemVersion: description: Operating system version of the image. maxLength: 255 minLength: 1 type: string totalECpuCount: description: 'The number of Total ECPUs for an Exadata VM cluster on Exascale Infrastructure. ' format: int32 minimum: 2 type: integer updateAction: description: The update action. enum: - ROLLING_APPLY - NON_ROLLING_APPLY - PRECHECK - ROLLBACK type: string vmFileSystemStorage: $ref: '#/components/schemas/ExadbVmClusterStorageDetails' KeyStore: allOf: - $ref: '#/components/schemas/KeyStoreSummary' description: 'A key store to connect to an on-premise encryption key appliance like Oracle Key Vault. ' DbSystemOsPatchHistoryEntryCollection: description: Results of OS patch history of a DB System. properties: items: description: Array of OS patch history entry summaries. items: $ref: '#/components/schemas/DbSystemOsPatchHistoryEntrySummary' type: array required: - items type: object CreateSchedulingPolicyDetails: description: 'Request to create Scheduling Policy resource with Maintenance windows per cadence. ' properties: cadence: description: The cadence period. enum: - HALFYEARLY - QUARTERLY - MONTHLY type: string cadenceStartMonth: $ref: '#/components/schemas/Month' description: Start of the month to be followed during the cadence period. compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object displayName: description: The user-friendly name for the Scheduling Policy. The name does not need to be unique. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object required: - compartmentId - displayName - cadence SaasAdminUserStatus: description: SaaS administrative user status. properties: accessType: description: The access type for the SaaS administrative user. If no access type is specified, the READ_ONLY access type is used. enum: - READ_ONLY - READ_WRITE - ADMIN type: string isEnabled: description: Indicates if the SaaS administrative user is enabled for the Autonomous AI Database. type: boolean timeSaasAdminUserEnabled: description: The date and time the SaaS administrative user was enabled at, for the Autonomous AI Database. format: date-time type: string type: object AutonomousPatch: allOf: - $ref: '#/components/schemas/AutonomousPatchSummary' DbSystemSummary: description: 'The Database Service supports several types of DB systems, ranging in size, price, and performance. For details about each type of system, see [Bare Metal and Virtual Machine DB Systems](/Content/Database/Concepts/overview.htm). **Note:** Deprecated for Exadata Cloud Service instances using the new [resource model](/iaas/Content/Database/Concepts/exaflexsystem.htm#exaflexsystem_topic-resource_model). To provision and manage new Exadata Cloud Service systems, use the [CloudExadataInfrastructure](#/en/database/latest/CloudExadataInfrastructure/) and [CloudVmCluster](#/en/database/latest/CloudVmCluster/). See [Exadata Cloud Service](/Content/Database/Concepts/exaoverview.htm) for more information on Exadata systems. For Exadata Cloud Service instances, support for this API will end on May 15th, 2021. See [Switching an Exadata DB System to the New Resource Model and APIs](/iaas/Content/Database/Concepts/exaflexsystem_topic-resource_model_conversion.htm) for details on converting existing Exadata DB systems to the new resource model. To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm). For information about access control and compartments, see [Overview of the Identity Service](/Content/Identity/Concepts/overview.htm). For information about availability domains, see [Regions and Availability Domains](/Content/General/Concepts/regions.htm). To get a list of availability domains, use the `ListAvailabilityDomains` operation in the Identity Service API. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' properties: availabilityDomain: description: The name of the availability domain that the DB system is located in. maxLength: 255 minLength: 1 type: string backupNetworkNsgIds: description: 'A list of the [OCIDs](/Content/General/Concepts/identifiers.htm) of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see [Security Rules](/Content/Network/Concepts/securityrules.htm). Applicable only to Exadata systems. ' items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array uniqueItems: true backupSubnetId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the backup network subnet the DB system is associated with. Applicable only to Exadata DB systems. **Subnet Restriction:** See the subnet restrictions information for **subnetId**. ' maxLength: 255 minLength: 1 type: string clusterName: description: 'The cluster name for Exadata and 2-node RAC virtual machine DB systems. The cluster name must begin with an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive. ' type: string compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string computeCount: description: The number of compute servers for the DB system. format: int32 type: integer computeModel: description: The compute model for Base Database Service. This is required if using the `computeCount` parameter. If using `cpuCoreCount` then it is an error to specify `computeModel` to a non-null value. The ECPU compute model is the recommended model, and the OCPU compute model is legacy. enum: - ECPU - OCPU type: string cpuCoreCount: description: The number of CPU cores enabled on the DB system. type: integer dataCollectionOptions: $ref: '#/components/schemas/DataCollectionOptions' dataStoragePercentage: description: 'The percentage assigned to DATA storage (user data and database files). The remaining percentage is assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). Accepted values are 40 and 80. The default is 80 percent assigned to DATA storage. Not applicable for virtual machine DB systems. ' type: integer dataStorageSizeInGBs: description: 'The data storage size, in gigabytes, that is currently available to the DB system. Applies only for virtual machine DB systems. ' type: integer databaseEdition: description: 'The Oracle Database Edition that applies to all the databases on the DB system. Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE. ' enum: - STANDARD_EDITION - ENTERPRISE_EDITION - ENTERPRISE_EDITION_HIGH_PERFORMANCE - ENTERPRISE_EDITION_EXTREME_PERFORMANCE - ENTERPRISE_EDITION_DEVELOPER type: string dbSystemOptions: $ref: '#/components/schemas/DbSystemOptions' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object diskRedundancy: description: 'The type of redundancy configured for the DB system. NORMAL is 2-way redundancy. HIGH is 3-way redundancy. ' enum: - HIGH - NORMAL type: string displayName: description: The user-friendly name for the DB system. The name does not have to be unique. maxLength: 255 minLength: 1 type: string domain: description: The domain name for the DB system. type: string faultDomains: description: List of the Fault Domains in which this DB system is provisioned. items: maxLength: 255 minLength: 1 type: string type: array freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object giSoftwareImageId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of a grid infrastructure software image. This is a database software image of the type `GRID_IMAGE`. maxLength: 255 type: string hostname: description: The hostname for the DB system. type: string id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the DB system. maxLength: 255 minLength: 1 type: string kmsKeyId: description: The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. maxLength: 255 minLength: 1 type: string lastMaintenanceRunId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the last maintenance run. maxLength: 255 minLength: 1 type: string lastPatchHistoryEntryId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the last patch history. This value is updated as soon as a patch operation starts. maxLength: 255 minLength: 1 type: string licenseModel: description: 'The Oracle license model that applies to all the databases on the DB system. The default is LICENSE_INCLUDED. ' enum: - LICENSE_INCLUDED - BRING_YOUR_OWN_LICENSE type: string lifecycleDetails: description: Additional information about the current lifecycle state. type: string lifecycleState: description: The current state of the DB system. enum: - PROVISIONING - AVAILABLE - UPDATING - TERMINATING - TERMINATED - FAILED - MIGRATED - MAINTENANCE_IN_PROGRESS - NEEDS_ATTENTION - UPGRADING type: string listenerPort: description: The port number configured for the listener on the DB system. type: integer maintenanceWindow: $ref: '#/components/schemas/MaintenanceWindow' memorySizeInGBs: description: Memory allocated to the DB system, in gigabytes. maxLength: 1024 minLength: 1 type: integer x-default-description: 'null' nextMaintenanceRunId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the next maintenance run. maxLength: 255 minLength: 1 type: string nodeCount: description: 'The number of nodes in the DB system. For RAC DB systems, the value is greater than 1. ' minimum: 1 type: integer nsgIds: description: 'The list of [OCIDs](/Content/General/Concepts/identifiers.htm) for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see [Security Rules](/Content/Network/Concepts/securityrules.htm). ' items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array uniqueItems: true pointInTimeDataDiskCloneTimestamp: description: The point in time for a cloned database system when the data disks were cloned from the source database system, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339). format: date-time type: string recoStorageSizeInGB: description: 'The RECO/REDO storage size, in gigabytes, that is currently allocated to the DB system. Applies only for virtual machine DB systems. ' type: integer scanDnsName: description: 'The FQDN of the DNS record for the SCAN IP addresses that are associated with the DB system. ' maxLength: 72 minLength: 1 type: string scanDnsRecordId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the DNS record for the SCAN IP addresses that are associated with the DB system. ' maxLength: 255 minLength: 1 type: string scanIpIds: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Single Client Access Name (SCAN) IPv4 addresses associated with the DB system. SCAN IPv4 addresses are typically used for load balancing and are not assigned to any interface. Oracle Clusterware directs the requests to the appropriate nodes in the cluster. **Note:** For a single-node DB system, this list is empty. ' items: maxLength: 255 minLength: 1 type: string type: array scanIpv6Ids: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Single Client Access Name (SCAN) IPv6 addresses associated with the DB system. SCAN IPv6 addresses are typically used for load balancing and are not assigned to any interface. Oracle Clusterware directs the requests to the appropriate nodes in the cluster. **Note:** For a single-node DB system, this list is empty. ' items: maxLength: 255 minLength: 1 type: string type: array 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 [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}` ' type: object shape: description: 'The shape of the DB system. The shape determines resources to allocate to the DB system. - For virtual machine shapes, the number of CPU cores and memory - For bare metal and Exadata shapes, the number of CPU cores, storage, and memory ' maxLength: 255 minLength: 1 type: string sourceDbSystemId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the DB system. maxLength: 255 minLength: 1 type: string sparseDiskgroup: description: 'True, if Sparse Diskgroup is configured for Exadata dbsystem, False, if Sparse diskgroup was not configured. ' type: boolean sshPublicKeys: description: The public key portion of one or more key pairs used for SSH access to the DB system. items: maxLength: 1024 minLength: 1 type: string type: array storageVolumePerformanceMode: default: BALANCED description: 'The block storage volume performance level. Valid values are `BALANCED` and `HIGH_PERFORMANCE`. See [Block Volume Performance](/Content/Block/Concepts/blockvolumeperformance.htm) for more information. ' enum: - BALANCED - HIGH_PERFORMANCE type: string subnetId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet the DB system is associated with. **Subnet Restrictions:** - For bare metal DB systems and for single node virtual machine DB systems, do not use a subnet that overlaps with 192.168.16.16/28. - For Exadata and virtual machine 2-node RAC DB systems, do not use a subnet that overlaps with 192.168.128.0/20. These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and backup subnet. ' maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object timeCreated: description: The date and time the DB system was created. format: date-time type: string timeZone: description: The time zone of the DB system. For details, see [DB System Time Zones](/Content/Database/References/timezones.htm). maxLength: 255 minLength: 1 type: string version: description: The Oracle Database version of the DB system. type: string vipIds: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the virtual IPv4 (VIP) addresses associated with the DB system. The Cluster Ready Services (CRS) creates and maintains one VIPv4 address for each node in the DB system to enable failover. If one node fails, the VIPv4 is reassigned to another active node in the cluster. **Note:** For a single-node DB system, this list is empty. ' items: maxLength: 255 minLength: 1 type: string type: array vipv6Ids: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the virtual IPv6 (VIP) addresses associated with the DB system. The Cluster Ready Services (CRS) creates and maintains one VIP IpV6 address for each node in the DB system to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster. **Note:** For a single-node DB system, this list is empty. ' items: maxLength: 255 minLength: 1 type: string type: array zoneId: description: 'The OCID of the zone the DB system is associated with. ' maxLength: 255 minLength: 1 type: string required: - id - compartmentId - lifecycleState - displayName - availabilityDomain - subnetId - shape - sshPublicKeys - cpuCoreCount - databaseEdition - hostname - domain UpdateCloudVmClusterDetails: description: 'Details for updating the cloud VM cluster. Applies to Exadata Cloud Service instances only. ' properties: backupNetworkNsgIds: description: 'A list of the [OCIDs](/Content/General/Concepts/identifiers.htm) of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see [Security Rules](/Content/Network/Concepts/securityrules.htm). Applicable only to Exadata systems. ' items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array uniqueItems: true computeNodes: description: The list of compute servers to be added to the cloud VM cluster. items: maxLength: 255 minLength: 1 type: string type: array cpuCoreCount: description: "For fixed shapes, this is the total number of OCPUs to enable across the VM cluster.\n\n - Exadata.Base.48 - Specify a multiple of 2, from 0 to 48.\n - Exadata.Quarter1.84 - Specify a multiple of 2, from 22 to 84.\n - Exadata.Half1.168 - Specify a multiple of 4, from 44 to 168.\n - Exadata.Full1.336 - Specify a multiple of 8, from 88 to 336.\n - Exadata.Quarter2.92 - Specify a multiple of 2, from 0 to 92.\n - Exadata.Half2.184 - Specify a multiple of 4, from 0 to 184.\n - Exadata.Full2.368 - Specify a multiple of 8, from 0 to 368.\n - Exadata.Quarter3.100 - Specify a multiple of 2, from 0 to 100.\n - Exadata.Half3.200 - Specify a multiple of 4, from 0 to 200.\n - Exadata.Full3.400 - Specify a multiple of 8, from 0 to 400.\n\nThe API specification for fixed shape values is https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/DbSystemShapeSummary\n\n\nFor flexible shapes X8M and X9M, this is the total number of OCPUs to enable across the VM cluster. The number available for the VM cluster will be based on the number of database servers selected for provisioning the VM cluster on the Exadata Infrastructure.\n\n - Exadata.X8M - Specify a multiple of 2, from 2 to 50 per X8M database server.\n - Exadata.X9M - Specify a multiple of 2, from 2 to 126 per X9M database server.\n\nFor flexible shapes X11M and higher, this is the total number of ECPUs to enable across the VM cluster. The number available for the VM cluster will be based on the number of database servers selected for provisioning the VM cluster on the Exadata Infrastructure.\n\n - Exadata.X11M - Specify a multiple of 8, from 8 to 760 per X11M database server.\n\nThe API specification for flexible shape values is https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/FlexComponentSummary\n" format: int32 type: integer dataCollectionOptions: $ref: '#/components/schemas/DataCollectionOptions' dataStoragePercentage: description: 'The percentage assigned to DATA storage (user data and database files). See [Storage Configuration](/Content/Database/Concepts/exaoverview.htm#Exadata) in the Exadata documentation for details on the impact of the configuration settings on storage. ' format: int32 maximum: 100 minimum: 0 type: integer dataStorageSizeInTBs: description: The data disk group size to be allocated in TBs. format: double type: number dbNodeStorageSizeInGBs: description: The local node storage to be allocated in GBs. type: integer definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object displayName: description: 'The user-friendly name for the cloud VM cluster. The name does not need to be unique. ' maxLength: 255 minLength: 1 type: string fileSystemConfigurationDetails: description: Details of the file system configuration of the VM cluster. items: $ref: '#/components/schemas/FileSystemConfigurationDetail' maxItems: 1024 type: array freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object isLocalBackupEnabled: description: 'If true, database backup on local Exadata storage is configured for the cloud VM cluster. If false, database backup on local Exadata storage is not available in the cloud VM cluster. ' type: boolean isSparseDiskgroupEnabled: description: 'If true, sparse disk group is configured for the cloud VM cluster. If false, sparse disk group is not created. ' type: boolean licenseModel: description: 'The Oracle license model that applies to the cloud VM cluster. The default is BRING_YOUR_OWN_LICENSE. Applies to Exadata Cloud Service instances only. ' enum: - LICENSE_INCLUDED - BRING_YOUR_OWN_LICENSE type: string memorySizeInGBs: description: The memory to be allocated in GBs. type: integer nsgIds: description: 'The list of [OCIDs](/Content/General/Concepts/identifiers.htm) for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see [Security Rules](/Content/Network/Concepts/securityrules.htm). ' items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array uniqueItems: true ocpuCount: description: The number of OCPU cores to enable for a cloud VM cluster. Only 1 decimal place is allowed for the fractional part. format: float minimum: 0.1 type: number x-example: 0.2 recoStoragePercentage: description: 'The percentage assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). See [Storage Configuration](/Content/Database/Concepts/exaoverview.htm#Exadata) in the Exadata documentation for details on the impact of the configuration settings on storage. ' format: int32 maximum: 100 minimum: 0 type: integer 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 [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}` ' type: object sparseStoragePercentage: description: 'The percentage assigned to SPARSE storage (Exadata snapshots). See [Storage Configuration](/Content/Database/Concepts/exaoverview.htm#Exadata) in the Exadata documentation for details on the impact of the configuration settings on storage. ' format: int32 maximum: 100 minimum: 0 type: integer sshPublicKeys: description: The public key portion of one or more key pairs used for SSH access to the cloud VM cluster. items: maxLength: 1024 minLength: 1 type: string type: array storageSizeInGBs: description: The disk group size to be allocated in GBs. format: int32 type: integer updateDetails: $ref: '#/components/schemas/UpdateDetails' vmBackupStorageType: description: Specifies the type of VM Backups Storage and supported values are LOCAL and EXASCALE. Storage Type can only be changed once from LOCAL to EXASCALE. EXASCALE to LOCAL is not permitted. enum: - LOCAL - EXASCALE type: string CompleteExternalBackupJobDetails: properties: cfBackupHandle: description: The handle of the control file backup. maxLength: 1024 minLength: 1 type: string dataSize: description: The size of the data in the database, in megabytes. format: int64 type: integer redoSize: description: The size of the redo in the database, in megabytes. format: int64 type: integer spfBackupHandle: description: The handle of the spfile backup. maxLength: 1024 minLength: 1 type: string sqlPatches: description: The list of SQL patches that need to be applied to the backup during the restore. items: maxLength: 1024 minLength: 1 type: string type: array tdeWalletPath: description: If the database being backed up is TDE enabled, this will be the path to the associated TDE wallet in Object Storage. maxLength: 1024 minLength: 1 type: string AutonomousDatabaseApex: description: 'Oracle APEX AI Application Development is a low-code development platform that enables you to build scalable, secure enterprise apps, with world-class features. Autonomous AI Database with the APEX workload type is optimized to support APEX development. ' properties: apexVersion: description: The Oracle APEX AI Application Development version. maxLength: 255 minLength: 1 type: string ordsVersion: description: The Oracle REST Data Services (ORDS) version. maxLength: 255 minLength: 1 type: string type: object BackupDestinationConfigurationSummary: allOf: - $ref: '#/components/schemas/BackupDestinationDetailsSummary' - properties: recoveryWindowInDays: description: Number of days between the current and earliest point of recoverability covered by automatic backups and manual backups, but not long term backups. type: integer type: object description: Information about the Autonomous Container Database's secondary backup destination(s). DatabaseSoftwareImageSummary: description: 'The Database service supports the creation of database software images for use in creating and patching DB systems and databases. To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm). For information about access control and compartments, see [Overview of the Identity Service](/Content/Identity/Concepts/overview.htm). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' properties: compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string databaseSoftwareImageIncludedPatches: description: List of one-off patches for Database Homes. items: type: string type: array databaseSoftwareImageOneOffPatches: description: List of one-off patches for Database Homes. items: type: string type: array databaseVersion: description: The database version with which the database software image is to be built. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object displayName: description: The user-friendly name for the database software image. The name does not have to be unique. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the database software image. maxLength: 255 minLength: 1 type: string imageShapeFamily: description: To what shape the image is meant for. enum: - VM_BM_SHAPE - EXADATA_SHAPE - EXACC_SHAPE - EXADBXS_SHAPE type: string imageType: description: The type of software image. Can be grid or database. enum: - GRID_IMAGE - DATABASE_IMAGE type: string includedPatchesSummary: description: The patches included in the image and the version of the image. maxLength: 65536 minLength: 1 type: string isUpgradeSupported: description: True if this Database software image is supported for Upgrade. type: boolean lifecycleDetails: description: Detailed message for the lifecycle state. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of the database software image. enum: - PROVISIONING - AVAILABLE - DELETING - DELETED - FAILED - TERMINATING - TERMINATED - UPDATING type: string lsInventory: description: The output from the OPatch lsInventory command, which is passed as a string. maxLength: 262144 minLength: 1 type: string patchSet: description: The PSU or PBP or Release Updates. To get a list of supported versions, use the [ListDbVersions](#/en/database/latest/DbVersionSummary/ListDbVersions) operation. maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object timeCreated: description: The date and time the database software image was created. format: date-time type: string required: - id - compartmentId - lifecycleState - displayName - timeCreated - imageType - imageShapeFamily - patchSet - databaseVersion ConsoleHistory: allOf: - $ref: '#/components/schemas/ConsoleHistorySummary' description: 'The details of the Db Node console history. ' CreateKeyStoreDetails: description: 'Details for the create key store operation. ' properties: compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object displayName: description: The user-friendly name for the key store. The name does not need to be unique. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object typeDetails: $ref: '#/components/schemas/KeyStoreTypeDetails' required: - compartmentId - displayName - typeDetails UpdateDataGuardAssociationDetails: description: 'The configuration details for updating a Data Guard association for a database. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' properties: databaseAdminPassword: description: 'A strong password for the ''SYS'', ''SYSTEM'', and ''PDB Admin'' users to apply during standby creation. The password must contain no fewer than nine characters and include: * At least two uppercase characters. * At least two lowercase characters. * At least two numeric characters. * At least two special characters. Valid special characters include "_", "#", and "-" only. **The password MUST be the same as the primary admin password.** ' maxLength: 255 minLength: 1 type: string isActiveDataGuardEnabled: description: True if active Data Guard is enabled. Update this parameter to change the Data Guard setting. type: boolean protectionMode: description: 'The protection mode for the Data Guard association''s primary and standby database. For more information, see [Oracle Data Guard Protection Modes](http://docs.oracle.com/database/122/SBYDB/oracle-data-guard-protection-modes.htm#SBYDB02000) in the Oracle Data Guard documentation. ' enum: - MAXIMUM_AVAILABILITY - MAXIMUM_PERFORMANCE - MAXIMUM_PROTECTION type: string transportType: description: 'The redo transport type to use for this Data Guard association. Valid values depend on the specified ''protectionMode'': * MAXIMUM_AVAILABILITY - Use SYNC or FASTSYNC * MAXIMUM_PERFORMANCE - Use ASYNC * MAXIMUM_PROTECTION - Use SYNC For more information, see [Redo Transport Services](http://docs.oracle.com/database/122/SBYDB/oracle-data-guard-redo-transport-services.htm#SBYDB00400) in the Oracle Data Guard documentation. ' enum: - SYNC - ASYNC - FASTSYNC type: string RemoveVirtualMachineFromVmClusterDetails: description: 'Details of removing Virtual Machines from the VM Cluster. Applies to Exadata Cloud@Customer instances only. ' properties: dbServers: description: The list of Exacc DB servers for the cluster to be removed. items: $ref: '#/components/schemas/DbServerDetails' type: array required: - dbServers CloudExadataInfrastructureSummary: description: 'Details of the cloud Exadata infrastructure resource. Applies to Exadata Cloud Service instances only. ' properties: activatedStorageCount: description: The requested number of additional storage servers activated for the Exadata infrastructure. type: integer additionalStorageCount: description: The requested number of additional storage servers for the Exadata infrastructure. type: integer availabilityDomain: description: The name of the availability domain that the cloud Exadata infrastructure resource is located in. maxLength: 255 minLength: 1 type: string availableStorageSizeInGBs: description: The available storage can be allocated to the cloud Exadata infrastructure resource, in gigabytes (GB). format: int32 type: integer clusterPlacementGroupId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cluster placement group of the Exadata Infrastructure. maxLength: 255 minLength: 1 type: string compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string computeCount: description: The number of compute servers for the cloud Exadata infrastructure. format: int32 type: integer computeModel: description: 'The compute model of the Base Database, Exadata Infrastructure, VM Cluster and Autonomous AI Database. ' enum: - ECPU - OCPU type: string x-default-description: Null used when unspecified. cpuCount: description: The total number of CPU cores allocated. type: integer customerContacts: description: 'The list of customer email addresses that receive information from Oracle about the specified OCI Database service resource. Oracle uses these email addresses to send notifications about planned and unplanned software maintenance updates, information about system hardware, and other information needed by administrators. Up to 10 email addresses can be added to the customer contacts for a cloud Exadata infrastructure instance. ' items: $ref: '#/components/schemas/CustomerContact' type: array dataStorageSizeInTBs: description: 'Size, in terabytes, of the DATA disk group. ' format: double type: number databaseServerType: description: The database server type of the Exadata infrastructure. maxLength: 255 minLength: 1 type: string x-default-description: 'null' dbNodeStorageSizeInGBs: description: The local node storage allocated in GBs. type: integer dbServerVersion: description: 'The software version of the database servers (dom0) in the cloud Exadata infrastructure. Example: 20.1.15 ' maxLength: 255 minLength: 1 type: string definedFileSystemConfigurations: description: Details of the file system configuration of the Exadata infrastructure. items: $ref: '#/components/schemas/DefinedFileSystemConfiguration' maxItems: 1024 type: array definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object displayName: description: The user-friendly name for the cloud Exadata infrastructure resource. The name does not need to be unique. maxLength: 255 minLength: 1 type: string exascaleConfig: $ref: '#/components/schemas/ExascaleConfigDetails' freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud Exadata infrastructure resource. maxLength: 255 minLength: 1 type: string isSchedulingPolicyAssociated: description: If true, the infrastructure is using granular maintenance scheduling preference. type: boolean lastMaintenanceRunId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the last maintenance run. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: Additional information about the current lifecycle state. type: string lifecycleState: description: The current lifecycle state of the cloud Exadata infrastructure resource. enum: - PROVISIONING - AVAILABLE - UPDATING - TERMINATING - TERMINATED - FAILED - MAINTENANCE_IN_PROGRESS type: string maintenanceVersionPreferences: $ref: '#/components/schemas/MaintenanceVersionPreferenceDetails' maintenanceWindow: $ref: '#/components/schemas/MaintenanceWindow' maxCpuCount: description: The total number of CPU cores available. type: integer maxDataStorageInTBs: description: The total available DATA disk group size. format: double type: number maxDbNodeStorageInGBs: description: The total local node storage available in GBs. type: integer maxMemoryInGBs: description: The total memory available in GBs. type: integer memorySizeInGBs: description: The memory allocated in GBs. type: integer monthlyDbServerVersion: description: 'The monthly software version of the database servers (dom0) in the cloud Exadata infrastructure. Example: 20.1.15 ' maxLength: 255 minLength: 1 type: string monthlyStorageServerVersion: description: 'The monthly software version of the storage servers (cells) in the cloud Exadata infrastructure. Example: 20.1.15 ' maxLength: 255 minLength: 1 type: string nextMaintenanceRunId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the next maintenance run. maxLength: 255 minLength: 1 type: string shape: description: 'The model name of the cloud Exadata infrastructure resource. ' maxLength: 255 minLength: 1 type: string storageCount: description: The number of storage servers for the cloud Exadata infrastructure. format: int32 type: integer storageServerType: description: The storage server type of the Exadata infrastructure. maxLength: 255 minLength: 1 type: string x-default-description: 'null' storageServerVersion: description: 'The software version of the storage servers (cells) in the cloud Exadata infrastructure. Example: 20.1.15 ' maxLength: 255 minLength: 1 type: string subscriptionId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the subscription with which resource needs to be associated with. maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object timeCreated: description: The date and time the cloud Exadata infrastructure resource was created. format: date-time type: string totalStorageSizeInGBs: description: The total storage allocated to the cloud Exadata infrastructure resource, in gigabytes (GB). format: int32 type: integer required: - id - compartmentId - lifecycleState - displayName - shape - availabilityDomain DbBackupConfig: description: 'Backup Options 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: autoBackupEnabled: description: If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work. type: boolean autoBackupWindow: description: 'Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: `SLOT_TWO` ' enum: - SLOT_ONE - SLOT_TWO - SLOT_THREE - SLOT_FOUR - SLOT_FIVE - SLOT_SIX - SLOT_SEVEN - SLOT_EIGHT - SLOT_NINE - SLOT_TEN - SLOT_ELEVEN - SLOT_TWELVE type: string autoFullBackupDay: default: SUNDAY description: Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday. enum: - SUNDAY - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY type: string autoFullBackupWindow: description: 'Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: `SLOT_TWO` ' enum: - SLOT_ONE - SLOT_TWO - SLOT_THREE - SLOT_FOUR - SLOT_FIVE - SLOT_SIX - SLOT_SEVEN - SLOT_EIGHT - SLOT_NINE - SLOT_TEN - SLOT_ELEVEN - SLOT_TWELVE type: string x-default-description: 'null' backupDeletionPolicy: description: This defines when the backups will be deleted. - DELETE_IMMEDIATELY option keep the backup for predefined time i.e 72 hours and then delete permanently... - DELETE_AFTER_RETENTION_PERIOD will keep the backups as per the policy defined for database backups. enum: - DELETE_IMMEDIATELY - DELETE_AFTER_RETENTION_PERIOD type: string backupDestinationDetails: description: Backup destination details. items: $ref: '#/components/schemas/BackupDestinationDetails' type: array recoveryWindowInDays: description: 'Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups. ' maximum: 60 minimum: 1 type: integer runImmediateFullBackup: default: true description: If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately. type: boolean BackupDestinationProperties: description: The properties of the backup destination associated with the Autonomous Container Database. properties: backupDestinationAttachHistory: description: The timestamps at which this backup destination is used as the preferred destination to host the Autonomous Container Database backups. items: format: date-time type: string type: array spaceUtilizedInGBs: description: The total space utilized (in GBs) by this Autonomous Container Database on this backup destination, rounded to the nearest integer. type: integer timeAtWhichStorageDetailsAreUpdated: description: The latest timestamp when the backup destination details, such as 'spaceUtilized,' are updated. format: date-time type: string ChangeAutonomousVmClusterCompartmentDetails: description: 'The configuration details for moving the Autonomous VM cluster. ' properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the Autonomous VM cluster to. ' maxLength: 255 minLength: 1 type: string required: - compartmentId RegisterAutonomousDatabaseDataSafeDetails: description: 'Details for registering an Autonomous AI Database with Data Safe. ' properties: pdbAdminPassword: description: The admin password provided during the creation of the database. This password is between 12 and 30 characters long, and must contain at least 1 uppercase, 1 lowercase, and 1 numeric character. It cannot contain the double quote symbol (") or the username "admin", regardless of casing. maxLength: 30 minLength: 12 type: string required: - pdbAdminPassword UpdateMaintenanceRunDetails: description: 'Describes the modification parameters for the maintenance run. ' properties: currentCustomActionTimeoutInMins: description: The current custom action timeout between the current database servers during waiting state in addition to custom action timeout, from 0 (zero) to 30 minutes. maximum: 30 minimum: 0 type: integer customActionTimeoutInMins: description: 'Determines the amount of time the system will wait before the start of each database server patching operation. Specify a number of minutes from 15 to 120. ' maximum: 120 minimum: 15 type: integer isCustomActionTimeoutEnabled: description: If true, enables the configuration of a custom action timeout (waiting period) between database servers patching operations. type: boolean isEnabled: description: If `FALSE`, skips the maintenance run. type: boolean isPatchNowEnabled: description: If set to `TRUE`, starts patching immediately. type: boolean isResumePatching: description: If true, then the patching is resumed and the next component will be patched immediately. type: boolean patchId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the patch to be applied in the maintenance run. type: string patchingMode: description: 'Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING. *IMPORTANT*: Non-rolling infrastructure patching involves system down time. See [Oracle-Managed Infrastructure Maintenance Updates](/iaas/Content/Database/Concepts/examaintenance.htm#Oracle) for more information. ' enum: - ROLLING - NONROLLING type: string targetDbServerVersion: description: The target database server system software version for the patching operation. maxLength: 255 minLength: 1 type: string targetStorageServerVersion: description: The target storage cell system software version for the patching operation. maxLength: 255 minLength: 1 type: string timeScheduled: description: The scheduled date and time of the maintenance run to update. format: date-time type: string UpdateOneoffPatchDetails: description: 'Data to update the one-off patch. ' properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object SchedulingPlanSummary: description: Details of a Scheduling Plan. properties: compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object displayName: description: The display name of the Scheduling Plan. maxLength: 255 minLength: 1 type: string estimatedTimeInMins: description: The estimated time for the Scheduling Plan. maximum: 500000 minimum: 0 type: integer freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Scheduling Plan. maxLength: 255 minLength: 1 type: string isUsingRecommendedScheduledActions: description: If true, recommended scheduled actions will be generated for the scheduling plan. type: boolean lifecycleDetails: description: Additional information about the current lifecycle state. type: string lifecycleState: description: 'The current state of the Scheduling Plan. Valid states are CREATING, NEEDS_ATTENTION, AVAILABLE, UPDATING, FAILED, DELETING and DELETED. ' enum: - CREATING - NEEDS_ATTENTION - AVAILABLE - UPDATING - FAILED - DELETING - DELETED type: string planIntent: default: EXADATA_INFRASTRUCTURE_FULL_SOFTWARE_UPDATE description: The current intent of the Scheduling Plan. Valid states are EXADATA_INFRASTRUCTURE_FULL_SOFTWARE_UPDATE and EXADATA_INFRASTRUCTURE_SECURITY_UPDATE. enum: - EXADATA_INFRASTRUCTURE_FULL_SOFTWARE_UPDATE - EXADATA_INFRASTRUCTURE_SECURITY_UPDATE type: string resourceId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the resource. maxLength: 255 minLength: 1 type: string schedulingPolicyId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Scheduling Policy. maxLength: 255 minLength: 1 type: string serviceType: description: The service type of the Scheduling Plan. enum: - EXACC - EXACS - FPPPCS type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object timeCreated: description: The date and time the Scheduling Plan Resource was created. format: date-time type: string timeUpdated: description: The date and time the Scheduling Plan Resource was updated. format: date-time type: string required: - id - schedulingPolicyId - resourceId - compartmentId - serviceType - lifecycleState - timeCreated type: object AutonomousDbPreviewVersionSummary: description: 'The Autonomous AI Database preview version. Note that preview version software is only available for [Autonomous AI Database Serverless instances](https://docs.oracle.com/en/cloud/paas/autonomous-database/serverless/). ' properties: dbWorkload: description: 'The Autonomous AI Database workload type. The following values are valid: - OLTP - indicates an Autonomous AI Transaction Processing database - DW - indicates an Autonomous AI Lakehouse database - AJD - indicates an Autonomous AI JSON Database - APEX - indicates an Autonomous AI Database with the Oracle APEX AI Application Development workload type. - LH - indicates an Oracle Autonomous AI Lakehouse database **Note** Starting December 2026, DW will not be supported as a valid value for this parameter. When creating an Autonomous AI Database, if this parameter is not specified, the default value is `OLTP`. This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. ' enum: - OLTP - DW - AJD - APEX - LH type: string details: description: A URL that points to a detailed description of the preview version. type: string timePreviewBegin: description: The date and time when the preview version availability begins. format: date-time type: string timePreviewEnd: description: The date and time when the preview version availability ends. format: date-time type: string version: description: A valid Autonomous AI Database preview version. maxLength: 255 minLength: 1 type: string required: - version ExadataInfrastructureSummary: description: 'Details of the Exadata Cloud@Customer infrastructure. Applies to Exadata Cloud@Customer instances only. See [CloudExadataInfrastructureSummary Reference](#/en/database/latest/datatypes/CloudExadataInfrastructureSummary) for details of the cloud Exadata infrastructure resource used by Exadata Cloud Service instances. ' properties: activatedStorageCount: description: The requested number of additional storage servers activated for the Exadata infrastructure. type: integer additionalComputeCount: description: The requested number of additional compute servers for the Exadata infrastructure. type: integer additionalComputeSystemModel: description: 'Oracle Exadata System Model specification. The system model determines the amount of compute or storage server resources available for use. For more information, please see [System and Shape Configuration Options] (https://docs.oracle.com/en/engineered-systems/exadata-cloud-at-customer/ecccm/ecc-system-config-options.html#GUID-9E090174-5C57-4EB1-9243-B470F9F10D6B) ' enum: - X7 - X8 - X8M - X9M - X11M type: string additionalStorageCount: description: The requested number of additional storage servers for the Exadata infrastructure. type: integer adminNetworkCIDR: description: The CIDR block for the Exadata administration network. maxLength: 255 minLength: 1 type: string availabilityDomain: description: The name of the availability domain that the Exadata infrastructure is located in. maxLength: 255 minLength: 1 type: string cloudControlPlaneServer1: description: The IP address for the first control plane server. maxLength: 255 minLength: 1 type: string cloudControlPlaneServer2: description: The IP address for the second control plane server. maxLength: 255 minLength: 1 type: string compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string computeCount: description: The number of compute servers for the Exadata infrastructure. type: integer computeModel: description: 'The compute model of the Base Database, Exadata Infrastructure, VM Cluster and Autonomous AI Database. ' enum: - ECPU - OCPU type: string x-default-description: Null used when unspecified. contacts: description: The list of contacts for the Exadata infrastructure. items: $ref: '#/components/schemas/ExadataInfrastructureContact' maxItems: 10 minItems: 1 type: array corporateProxy: description: The corporate network proxy for access to the control plane network. maxLength: 255 minLength: 1 type: string cpusEnabled: description: The number of enabled CPU cores. type: integer csiNumber: description: The CSI Number of the Exadata infrastructure. maxLength: 255 minLength: 1 type: string dataStorageSizeInTBs: description: 'Size, in terabytes, of the DATA disk group. ' format: double type: number databaseServerType: description: The database server type of the Exadata infrastructure. maxLength: 255 minLength: 1 type: string x-default-description: 'null' dbNodeStorageSizeInGBs: description: The local node storage allocated in GBs. type: integer dbServerVersion: description: The software version of the database servers (dom0) in the Exadata infrastructure. maxLength: 255 minLength: 1 type: string definedFileSystemConfigurations: description: Details of the file system configuration of the Exadata infrastructure. items: $ref: '#/components/schemas/DefinedFileSystemConfiguration' maxItems: 1024 type: array definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object displayName: description: The user-friendly name for the Exadata Cloud@Customer infrastructure. The name does not need to be unique. maxLength: 255 minLength: 1 type: string dnsServer: description: The list of DNS server IP addresses. Maximum of 3 allowed. items: maxLength: 1024 minLength: 1 type: string type: array freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object gateway: description: The gateway for the control plane network. maxLength: 255 minLength: 1 type: string id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure. maxLength: 255 minLength: 1 type: string infiniBandNetworkCIDR: description: The CIDR block for the Exadata InfiniBand interconnect. maxLength: 255 minLength: 1 type: string isMultiRackDeployment: description: Indicates if deployment is Multi-Rack or not. type: boolean isSchedulingPolicyAssociated: description: If true, the infrastructure is using granular maintenance scheduling preference. type: boolean lifecycleDetails: description: Additional information about the current lifecycle state. type: string lifecycleState: description: The current lifecycle state of the Exadata infrastructure. enum: - CREATING - REQUIRES_ACTIVATION - ACTIVATING - ACTIVE - ACTIVATION_FAILED - FAILED - UPDATING - DELETING - DELETED - DISCONNECTED - MAINTENANCE_IN_PROGRESS - WAITING_FOR_CONNECTIVITY type: string maintenanceSLOStatus: description: A field to capture ‘Maintenance SLO Status’ for the Exadata infrastructure with values ‘OK’, ‘DEGRADED’. Default is ‘OK’ when the infrastructure is provisioned. enum: - OK - DEGRADED type: string maintenanceVersionPreferences: $ref: '#/components/schemas/MaintenanceVersionPreferenceDetails' maintenanceWindow: $ref: '#/components/schemas/MaintenanceWindow' maxCpuCount: description: The total number of CPU cores available. type: integer maxDataStorageInTBs: description: The total available DATA disk group size. format: double type: number maxDbNodeStorageInGBs: description: The total local node storage available in GBs. type: integer maxMemoryInGBs: description: The total memory available in GBs. type: integer memorySizeInGBs: description: The memory allocated in GBs. type: integer monthlyDbServerVersion: description: The monthly software version of the database servers (dom0) in the Exadata infrastructure. maxLength: 255 minLength: 1 type: string multiRackConfigurationFile: description: The base64 encoded Multi-Rack configuration json file. format: byte type: string netmask: description: The netmask for the control plane network. maxLength: 255 minLength: 1 type: string networkBondingModeDetails: $ref: '#/components/schemas/NetworkBondingModeDetails' ntpServer: description: The list of NTP server IP addresses. Maximum of 3 allowed. items: maxLength: 1024 minLength: 1 type: string type: array rackSerialNumber: description: The serial number for the Exadata infrastructure. maxLength: 255 minLength: 1 type: string shape: description: 'The shape of the Exadata infrastructure. The shape determines the amount of CPU, storage, and memory resources allocated to the instance. ' maxLength: 255 minLength: 1 type: string storageCount: description: The number of Exadata storage servers for the Exadata infrastructure. type: integer storageServerType: description: The storage server type of the Exadata infrastructure. maxLength: 255 minLength: 1 type: string x-default-description: 'null' storageServerVersion: description: The software version of the storage servers (cells) in the Exadata infrastructure. maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object timeCreated: description: The date and time the Exadata infrastructure was created. format: date-time type: string timeZone: description: The time zone of the Exadata infrastructure. For details, see [Exadata Infrastructure Time Zones](/Content/Database/References/timezones.htm). format: x-obmcs-time-zone maxLength: 255 minLength: 1 type: string required: - id - compartmentId - lifecycleState - displayName - shape VmClusterNetworkDetails: description: 'Details for an Exadata VM cluster network. Applies to Exadata Cloud@Customer instances only. ' properties: compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object displayName: description: The user-friendly name for the Exadata Cloud@Customer VM cluster network. The name does not need to be unique. maxLength: 255 minLength: 1 type: string dns: description: The list of DNS server IP addresses. Maximum of 3 allowed. items: maxLength: 1024 minLength: 1 type: string maxItems: 3 type: array drScans: description: The SCAN details for DR network items: $ref: '#/components/schemas/DrScanDetails' type: array freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object ntp: description: The list of NTP server IP addresses. Maximum of 3 allowed. items: maxLength: 1024 minLength: 1 type: string maxItems: 3 type: array scans: description: The SCAN details. items: $ref: '#/components/schemas/ScanDetails' maxItems: 3 type: array vmNetworks: description: Details of the client and backup networks. items: $ref: '#/components/schemas/VmNetworkDetails' type: array required: - compartmentId - displayName - scans - vmNetworks UpdateAutonomousDatabaseDetails: description: 'Details to update an Oracle Autonomous AI Database. **Notes** - To specify OCPU core count, you must use either `ocpuCount` or `cpuCoreCount`. You cannot use both parameters at the same time. For Autonomous AI Database Serverless instances, `ocpuCount` is not used. - To specify a storage allocation, you must use either `dataStorageSizeInGBs` or `dataStorageSizeInTBs`. - See the individual parameter discriptions for more information on the OCPU and storage value parameters. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' properties: adminPassword: description: 'The password must be between 12 and 30 characters long, and must contain at least 1 uppercase, 1 lowercase, and 1 numeric character. It cannot contain the double quote symbol (") or the username "admin", regardless of casing. It must be different from the last four passwords and it must not be a password used within the last 24 hours. This cannot be used in conjunction with with OCI vault secrets (secretId). This cannot be updated in parallel with any of the following: licenseModel, dbEdition, whitelistedIps, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, or isFreeTier. ' maxLength: 30 minLength: 12 type: string arePrimaryWhitelistedIpsUsed: description: 'This field will be null if the Autonomous AI Database is not Data Guard enabled or Access Control is disabled. `TRUE` if the Autonomous AI Database has Data Guard and Access Control enabled, and the Autonomous AI Database uses the primary''s IP access control list (ACL) for standby. `FALSE` if the Autonomous AI Database has Data Guard and Access Control enabled, and the Autonomous AI Database uses a different IP access control list (ACL) for standby compared to primary. ' type: boolean autoRefreshFrequencyInSeconds: description: The frequency a refreshable clone is refreshed after auto-refresh is enabled. The minimum is 1 hour. The maximum is 7 days. The date and time that auto-refresh is enabled is controlled by the `timeOfAutoRefreshStart` parameter. maximum: 604800 minimum: 3600 type: integer autoRefreshPointLagInSeconds: description: The time, in seconds, the data of the refreshable clone lags the primary database at the point of refresh. The minimum is 0 minutes (0 mins means refresh to the latest available timestamp). The maximum is 7 days. The lag time increases after refreshing until the next data refresh happens. maximum: 604800 minimum: 0 type: integer autonomousMaintenanceScheduleType: description: 'The maintenance schedule type of the Autonomous AI Database Serverless. An EARLY maintenance schedule follows a schedule applying patches prior to the REGULAR schedule. A REGULAR maintenance schedule follows the normal cycle ' enum: - EARLY - REGULAR type: string backupRetentionPeriodInDays: description: Retention period, in days, for long-term backups maximum: 3650 minimum: 90 type: integer byolComputeCountLimit: description: The maximum number of CPUs allowed with a Bring Your Own License (BYOL), including those used for auto-scaling, disaster recovery, tools, etc. Any CPU usage above this limit is considered as License Included and billed. format: float minimum: 2 type: number computeCount: description: 'The compute amount (CPUs) available to the database. Minimum and maximum values depend on the compute model and whether the database is an Autonomous AI Database Serverless instance or an Autonomous AI Database on Dedicated Exadata Infrastructure. The ''ECPU'' compute model requires a minimum value of one, for databases in the elastic resource pool and minimum value of two, otherwise. Required when using the `computeModel` parameter. When using `cpuCoreCount` parameter, it is an error to specify computeCount to a non-null value. Providing `computeModel` and `computeCount` is the preferred method for both OCPU and ECPU.
For Autonomous AI Databases on Dedicated Exadata Infrastructure, the following points apply: - The CPU type (ECPUs or OCPUs) is determined by the parent Autonomous Exadata VM Cluster''s compute model. - You can enter a fractional value to provision less than 1 CPU. This lets you provision more Autonomous AI Databases than the available physical CPU cores, known as CPU overprovisioning. The exact implementation details vary with the compute model (ECPUs or OCPUs) that is inherited from the parent Autonomous Exadata VM Cluster. See [CPU Overprovisioning in Dedicated Exadata Infrastructure](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/crsrb/index.html) for more details. - To provision 1 or more OCPUs, you must enter an integer between 1 and the maximum number of OCPUscores available in the Autonomous VM Cluster. To provision 2 or more ECPUs, you must enter an even number between 2 and the maximum number of ECPUs available in the Autonomous VM Cluster. - The maximum number of cores is determined by the infrastructure shape. See [Characteristics of Infrastructure Shapes](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbde/) for shape details. This cannot be updated in parallel with any of the following: licenseModel, databaseEdition, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, or isFreeTier. ' format: float maximum: 512 minimum: 0.1 type: number computeModel: description: 'The compute model of the Base Database, Exadata Infrastructure, VM Cluster and Autonomous AI Database. ' enum: - ECPU - OCPU type: string x-default-description: Null used when unspecified. cpuCoreCount: description: 'The number of CPUs to be made available to the Autonomous AI Database.
For Autonomous AI Databases on Dedicated Exadata Infrastructure: - The CPU type (OCPUs or ECPUs) is determined by the parent Autonomous Exadata VM Cluster''s compute model. - It is suggested to use ''computeCount'' parameter if you want to use fractional value to provision less than 1 core. **Note:** This parameter cannot be used with the `ocpuCount` or `computeCount` parameter. This cannot be updated in parallel with any of the following: licenseModel, databaseEdition, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, or isFreeTier. ' maximum: 128 minimum: 1 type: integer customerContacts: description: 'Customer Contacts. Setting this to an empty list removes all customer contacts of an Oracle This cannot be updated in parallel with any of the following: isMTLSConnectionRequired, scheduledOperations, or dbToolsDetails. ' items: $ref: '#/components/schemas/CustomerContact' type: array dataStorageSizeInGBs: description: 'Applies to dedicated Exadata infrastructure only. The size, in gigabytes, of the data volume that will be created and attached to the database. The maximum storage value depends on the system shape. See [Characteristics of Infrastructure Shapes](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbde/) for shape details. **Note:** This parameter cannot be used with the `dataStorageSizeInTBs` parameter. ' maximum: 131072 minimum: 32 type: integer dataStorageSizeInTBs: description: 'The size, in terabytes, of the data volume that will be created and attached to the database. For Autonomous AI Databases on dedicated Exadata infrastructure, the maximum storage value is determined by the infrastructure shape. See [Characteristics of Infrastructure Shapes](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbde/) for shape details. A full Exadata service is allocated when the Autonomous AI Database size is set to the upper limit (384 TB). **Note:** This parameter cannot be used with the `dataStorageSizeInGBs` parameter. This cannot be updated in parallel with any of the following: licenseModel, databaseEdition, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, or isFreeTier. ' maximum: 384 minimum: 1 type: integer databaseEdition: description: 'The Oracle AI Database Edition that applies to the Autonomous AI Databases. This parameter accepts options `STANDARD_EDITION` and `ENTERPRISE_EDITION`. This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, dbName, scheduledOperations, dbToolsDetails, or isFreeTier. ' type: string x-obmcs-enumref: '#/definitions/AutonomousDatabaseSummary/databaseEdition' dbName: description: 'New name for this Autonomous AI Database. For Autonomous AI Databases on Dedicated Exadata Infrastructure, the name must begin with an alphabetic character, and can contain a maximum of eight alphanumeric characters. Special characters are not permitted. For Autonomous AI Database Serverless instances, the name must begin with an alphabetic character, and can contain a maximum of 30 alphanumeric characters. Special characters are not permitted. The database name must be unique in the tenancy. This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails. ' type: string dbToolsDetails: description: 'The list of database tools details. This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, isLocalDataGuardEnabled, or isFreeTier. ' items: $ref: '#/components/schemas/DatabaseTool' type: array x-default-description: 'null' dbVersion: description: 'A valid Oracle AI Database version for Autonomous AI Database. When you specify 23ai for dbversion, the system will provision a 23ai database, but the UI will display it as 26ai. When you specify 26ai for dbversion, the system will provision and display a 26ai database as expected. For new databases, it is recommended to use either 19c or 26ai. **Note** Starting December 2026, 23ai will not be supported as a valid value for this parameter. ' maxLength: 255 minLength: 1 type: string dbWorkload: description: 'The Autonomous AI Database workload type. The following values are valid: - OLTP - indicates an Autonomous AI Transaction Processing database - DW - indicates an Autonomous AI Lakehouse database - AJD - indicates an Autonomous AI JSON Database - APEX - indicates an Autonomous AI Database with the Oracle APEX AI Application Development workload type. - LH - indicates an Oracle Autonomous AI Lakehouse database **Note** Starting December 2026, DW will not be supported as a valid value for this parameter. When creating an Autonomous AI Database, if this parameter is not specified, the default value is `OLTP`. This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. ' enum: - OLTP - DW - AJD - APEX - LH type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object displayName: description: 'The user-friendly name for the Autonomous AI Database. The name does not have to be unique. The display name can only be updated for Autonomous AI Databases using dedicated Exadata Infrastructure. This parameter may not be updated in parallel with dbVersion. ' maxLength: 255 minLength: 1 type: string encryptionKey: $ref: '#/components/schemas/AutonomousDatabaseEncryptionKeyDetails' freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object inMemoryPercentage: description: The percentage of the System Global Area(SGA) assigned to In-Memory tables in Autonomous AI Database. This property is applicable only to Autonomous AI Databases on the Exadata Cloud@Customer platform. minimum: 0 type: integer isAccessControlEnabled: description: "Indicates if the database-level access control is enabled.\nIf disabled, database access is defined by the network security rules.\nIf enabled, database access is restricted to the IP addresses defined by the rules specified with the `whitelistedIps` property. While specifying `whitelistedIps` rules is optional,\n if database-level access control is enabled and no rules are specified, the database will become inaccessible. The rules can be added later using the `UpdateAutonomousDatabase` API operation or edit option in console.\nWhen creating a database clone, the desired access control setting should be specified. By default, database-level access control will be disabled for the clone.\n\nThis property is applicable only to Autonomous AI Databases on the Exadata Cloud@Customer platform. For Autonomous AI Database Serverless instances, `whitelistedIps` is used.\n" type: boolean isAutoScalingEnabled: default: null description: 'Indicates whether auto scaling is enabled for the Autonomous AI Database CPU core count. Setting to `TRUE` enables auto scaling. Setting to `FALSE` disables auto scaling. The default value is null. Auto scaling is only available for [Autonomous AI Database Serverless instances](https://docs.oracle.com/en/cloud/paas/autonomous-database/serverless/). ' type: boolean isAutoScalingForStorageEnabled: description: 'Indicates if auto scaling is enabled for the Autonomous AI Database storage. The default value is `FALSE`. ' type: boolean isBackupRetentionLocked: description: True if the Autonomous AI Database is backup retention locked. type: boolean isDataGuardEnabled: description: '** Deprecated. ** Indicates whether the Autonomous AI Database has a local (in-region) standby database. Not applicable when creating a cross-region Autonomous Data Guard associations, or to Autonomous AI Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure. To create a local standby, set to `TRUE`. To delete a local standby, set to `FALSE`. For more information on using Autonomous Data Guard on an Autonomous AI Database Serverless instance (local and cross-region) , see [About Standby Databases](https://docs.oracle.com/en/cloud/paas/autonomous-database/adbsa/autonomous-data-guard-about.html#GUID-045AD017-8120-4BDC-AF58-7430FFE28D2B) To enable cross-region Autonomous Data Guard on an Autonomous AI Database Serverless instance, see [Enable Autonomous Data Guard](https://docs-uat.us.oracle.com/en/cloud/paas/autonomous-database/adbsa/autonomous-data-guard-update-type.html#GUID-967ED737-4A05-4D6E-A7CA-C3F21ACF9BF0). To delete a cross-region standby database, provide the `peerDbId` for the standby database in a remote region, and set `isDataGuardEnabled` to `FALSE`. ' type: boolean isDevTier: default: false description: 'Autonomous AI Database for Developers are fixed-shape Autonomous AI Databases that developers can use to build and test new applications. On Serverless, these are low-cost and billed per instance, on Dedicated and Cloud@Customer there is no additional cost to create Developer databases. Developer databases come with limited resources and is not intended for large-scale testing and production deployments. When you need more compute or storage resources, you may upgrade to a full paid production database. ' type: boolean isDisconnectPeer: description: 'If true, this disconnects the Autonomous AI Database from its peer. After the disconnect completes, the Autonomous AI Database works permanently as a standalone database. **Warning:** A disconnected standby is no longer part of the disaster recovery configuration. Operations and restrictions that apply to a connected standby do not apply in the same way after the database has been disconnected. To disconnect a cross region standby, also provide the OCID of the standby database in the `peerDbId` parameter. ' type: boolean isFreeTier: default: false description: 'Indicates if this is an Always Free resource. The default value is false. Note that Always Free Autonomous AI Databases have 1 CPU and 20GB of memory. For Always Free databases, memory and CPU cannot be scaled. This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, or isLocalDataGuardEnabled ' type: boolean isLocalDataGuardEnabled: description: 'Indicates whether the Autonomous AI Database has a local (in-region) standby database. Not applicable when creating a cross-region Autonomous Data Guard associations, or to Autonomous AI Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure. To create a local standby, set to `TRUE`. To delete a local standby, set to `FALSE`. For more information on using Autonomous Data Guard on an Autonomous AI Database Serverless instance (local and cross-region) , see [About Standby Databases](https://docs.oracle.com/en/cloud/paas/autonomous-database/adbsa/autonomous-data-guard-about.html#GUID-045AD017-8120-4BDC-AF58-7430FFE28D2B) To enable cross-region Autonomous Data Guard on an Autonomous AI Database Serverless instance, see [Enable Autonomous Data Guard](https://docs-uat.us.oracle.com/en/cloud/paas/autonomous-database/adbsa/autonomous-data-guard-update-type.html#GUID-967ED737-4A05-4D6E-A7CA-C3F21ACF9BF0). This cannot be updated in parallel with any of the following: isMTLSRequired, dbWorkload, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, or isFreeTier. ' type: boolean isMtlsConnectionRequired: description: 'Specifies if the Autonomous AI Database requires mTLS connections. This may not be updated in parallel with any of the following: licenseModel, databaseEdition, cpuCoreCount, computeCount, dataStorageSizeInTBs, whitelistedIps, openMode, permissionLevel, db-workload, privateEndpointLabel, nsgIds, customerContacts, dbVersion, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. Service Change: The default value of the isMTLSConnectionRequired attribute will change from true to false on July 1, 2023 in the following APIs: - CreateAutonomousDatabase - GetAutonomousDatabase - UpdateAutonomousDatabase Details: Prior to the July 1, 2023 change, the isMTLSConnectionRequired attribute default value was true. This applies to Autonomous AI Database Serverless. Does this impact me? If you use or maintain custom scripts or Terraform scripts referencing the CreateAutonomousDatabase, GetAutonomousDatabase, or UpdateAutonomousDatabase APIs, you want to check, and possibly modify, the scripts for the changed default value of the attribute. Should you choose not to leave your scripts unchanged, the API calls containing this attribute will continue to work, but the default value will switch from true to false. How do I make this change? Using either OCI SDKs or command line tools, update your custom scripts to explicitly set the isMTLSConnectionRequired attribute to true. ' type: boolean isRefreshableClone: description: 'Indicates if the Autonomous AI Database is a refreshable clone. This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. ' type: boolean isSqlWebDeveloperEnabled: description: Indicates whether SQL Web Developer is enabled. The default is `FALSE` and no option will be given during provisioning. type: boolean licenseModel: description: 'The Oracle license model that applies to the Oracle Autonomous AI Database. Bring your own license (BYOL) allows you to apply your current on-premises Oracle software licenses to equivalent, highly automated Oracle services in the cloud. License Included allows you to subscribe to new Oracle AI Database software licenses and the Oracle AI Database service. Note that when provisioning an [Autonomous AI Database on dedicated Exadata infrastructure](https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html), this attribute must be null. It is already set at the Autonomous Exadata Infrastructure level. When provisioning an [Autonomous AI Database Serverless] (https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html) database, if a value is not specified, the system defaults the value to `BRING_YOUR_OWN_LICENSE`. Bring your own license (BYOL) also allows you to select the DB edition using the optional parameter. This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, dataStorageSizeInTBs, adminPassword, isMTLSConnectionRequired, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, dbName, scheduledOperations, dbToolsDetails, or isFreeTier. ' enum: - LICENSE_INCLUDED - BRING_YOUR_OWN_LICENSE type: string localAdgAutoFailoverMaxDataLossLimit: description: Parameter that allows users to select an acceptable maximum data loss limit in seconds, up to which Automatic Failover will be triggered when necessary for a Local Autonomous Data Guard maximum: 3600 minimum: 0 type: integer longTermBackupSchedule: $ref: '#/components/schemas/LongTermBackUpScheduleDetails' nsgIds: description: 'The list of [OCIDs](/Content/General/Concepts/identifiers.htm) for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see [Security Rules](/Content/Network/Concepts/securityrules.htm). ' items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array uniqueItems: true ocpuCount: description: 'The number of OCPU cores to be made available to the Autonomous AI Database. For Autonomous AI Databases on Dedicated Exadata Infrastructure, you can specify a fractional value for this parameter. Fractional values are not supported for Autonomous AI Database Serverless instances. For Autonomous AI Database Serverless instances, this parameter is not used. To provision less than 1 core, enter a fractional value in an increment of 0.1. To provision 1 or more cores, you must enter an integer between 1 and the maximum number of cores available to the infrastructure shape. For example, you can provision 0.3 or 0.4 cores, but not 0.35 cores. Likewise, you can provision 2 cores or 3 cores, but not 2.5 cores. The maximum number of cores is determined by the infrastructure shape. See [Characteristics of Infrastructure Shapes](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbde/index.html) for shape details. **Note:** This parameter cannot be used with the `cpuCoreCount` parameter. ' format: float minimum: 0.1 type: number openMode: description: 'Indicates the Autonomous AI Database mode. The database can be opened in `READ_ONLY` or `READ_WRITE` mode. This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, or isFreeTier. ' enum: - READ_ONLY - READ_WRITE type: string x-default-description: 'null' peerDbId: description: 'The database OCID(/Content/General/Concepts/identifiers.htm) of the Disaster Recovery peer (source Primary) database, which is located in a different (remote) region from the current peer database. To create or delete a local (in-region) standby, see the `isDataGuardEnabled` parameter. When disconnecting a cross-region standby, specify the standby database OCID in this parameter together with `isDisconnectPeer=true`. ' maxLength: 255 minLength: 1 type: string permissionLevel: description: 'The Autonomous AI Database permission level. Restricted mode allows access only by admin users. This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, or isFreeTier. ' enum: - RESTRICTED - UNRESTRICTED type: string x-default-description: 'null' privateEndpointIp: description: The private endpoint Ip address for the resource. type: string privateEndpointLabel: description: 'The resource''s private endpoint label. - Setting the endpoint label to a non-empty string creates a private endpoint database. - Resetting the endpoint label to an empty string, after the creation of the private endpoint database, changes the private endpoint database to a public endpoint database. - Setting the endpoint label to a non-empty string value, updates to a new private endpoint database, when the database is disabled and re-enabled. This setting cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, dbWorkload, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, or isFreeTier. ' type: string refreshableMode: description: The refresh mode of the clone. AUTOMATIC indicates that the clone is automatically being refreshed with data from the source Autonomous AI Database. enum: - AUTOMATIC - MANUAL type: string resourcePoolLeaderId: description: The unique identifier for leader Autonomous AI Database OCID [OCID](/Content/General/Concepts/identifiers.htm). maxLength: 255 minLength: 1 type: string resourcePoolSummary: $ref: '#/components/schemas/ResourcePoolSummary' scheduledOperations: description: 'The list of scheduled operations. Consists of values such as dayOfWeek, scheduledStartTime, scheduledStopTime. This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. ' items: $ref: '#/components/schemas/ScheduledOperationDetails' type: array secretId: description: The OCI vault secret [/Content/General/Concepts/identifiers.htm]OCID. This cannot be used in conjunction with adminPassword. maxLength: 255 minLength: 1 type: string secretVersionNumber: description: The version of the vault secret. If no version is specified, the latest version will be used. maximum: 60 minimum: 1 type: integer 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 [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}` ' type: object standbyWhitelistedIps: description: 'The client IP access control list (ACL). This feature is available for [Autonomous AI Database Serverless] (https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html) and on Exadata Cloud@Customer. Only clients connecting from an IP address included in the ACL may access the Autonomous AI Database instance. If `arePrimaryWhitelistedIpsUsed` is ''TRUE'' then Autonomous AI Database uses this primary''s IP access control list (ACL) for the disaster recovery peer called `standbywhitelistedips`. For Autonomous AI Database Serverless, this is an array of CIDR (classless inter-domain routing) notations for a subnet or VCN OCID (virtual cloud network Oracle Cloud ID). Multiple IPs and VCN OCIDs should be separate strings separated by commas, but if it’s other configurations that need multiple pieces of information then its each piece is connected with semicolon (;) as a delimiter. Example: `["1.1.1.1","1.1.1.0/24","ocid1.vcn.oc1.sea.","ocid1.vcn.oc1.sea.;1.1.1.1","ocid1.vcn.oc1.sea.;1.1.0.0/16"]` For Exadata Cloud@Customer, this is an array of IP addresses or CIDR notations. Example: `["1.1.1.1","1.1.1.0/24","1.1.2.25"]` For an update operation, if you want to delete all the IPs in the ACL, use an array with a single empty string entry. This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. ' items: maxLength: 1024 minLength: 0 type: string type: array subnetId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet the resource is associated with. **Subnet Restrictions:** - For bare metal DB systems and for single node virtual machine DB systems, do not use a subnet that overlaps with 192.168.16.16/28. - For Exadata and virtual machine 2-node RAC systems, do not use a subnet that overlaps with 192.168.128.0/20. - For Autonomous AI Database, setting this will disable public secure access to the database. These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and the backup subnet. ' maxLength: 255 minLength: 1 type: string timeOfAutoRefreshStart: description: The the date and time that auto-refreshing will begin for an Autonomous AI Database refreshable clone. This value controls only the start time for the first refresh operation. Subsequent (ongoing) refresh operations have start times controlled by the value of the `autoRefreshFrequencyInSeconds` parameter. format: date-time type: string whitelistedIps: description: 'The client IP access control list (ACL). This feature is available for [Autonomous AI Database Serverless] (https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html) and on Exadata Cloud@Customer. Only clients connecting from an IP address included in the ACL may access the Autonomous AI Database instance. If `arePrimaryWhitelistedIpsUsed` is ''TRUE'' then Autonomous AI Database uses this primary''s IP access control list (ACL) for the disaster recovery peer called `standbywhitelistedips`. For Autonomous AI Database Serverless, this is an array of CIDR (classless inter-domain routing) notations for a subnet or VCN OCID (virtual cloud network Oracle Cloud ID). Multiple IPs and VCN OCIDs should be separate strings separated by commas, but if it’s other configurations that need multiple pieces of information then its each piece is connected with semicolon (;) as a delimiter. Example: `["1.1.1.1","1.1.1.0/24","ocid1.vcn.oc1.sea.","ocid1.vcn.oc1.sea.;1.1.1.1","ocid1.vcn.oc1.sea.;1.1.0.0/16"]` For Exadata Cloud@Customer, this is an array of IP addresses or CIDR notations. Example: `["1.1.1.1","1.1.1.0/24","1.1.2.25"]` For an update operation, if you want to delete all the IPs in the ACL, use an array with a single empty string entry. This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. ' items: maxLength: 1024 minLength: 0 type: string type: array UpdateExascaleDbStorageVaultDetails: description: 'Details for updating the Exadata Database Storage Vault. ' properties: additionalFlashCacheInPercent: description: 'The size of additional Flash Cache in percentage of High Capacity database storage. ' format: int32 minimum: 0 type: integer autoscaleLimitInGBs: description: The maximum limit, in gigabytes, to which the Vault storage size can automatically scale when auto scaling is enabled for the Database Storage Vault type: integer definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object description: description: Exadata Database Storage Vault description. maxLength: 400 minLength: 1 type: string displayName: description: The user-friendly name for the Exadata Database Storage Vault. The name does not need to be unique. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object highCapacityDatabaseStorage: $ref: '#/components/schemas/ExascaleDbStorageInputDetails' isAutoscaleEnabled: description: Indicates if autoscale feature is enabled for the Database Storage Vault. The default value is `FALSE`. type: boolean CreateAutonomousContainerDatabaseBase: description: 'Describes the required parameters for the creation of an Autonomous Container Database. ' discriminator: propertyName: source properties: autonomousExadataInfrastructureId: description: '**No longer used.** This parameter is no longer used for Autonomous AI Database on dedicated Exadata infrasture. Specify a `cloudAutonomousVmClusterId` instead. Using this parameter will cause the operation to fail. ' maxLength: 255 minLength: 1 type: string autonomousVmClusterId: description: The OCID of the Autonomous VM Cluster. maxLength: 255 minLength: 1 type: string backupConfig: $ref: '#/components/schemas/AutonomousContainerDatabaseBackupConfig' cloudAutonomousVmClusterId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud Autonomous Exadata VM Cluster. maxLength: 255 minLength: 1 type: string compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment containing the Autonomous Container Database. maxLength: 255 minLength: 1 type: string customerContacts: description: 'Customer Contacts. Setting this to an empty list removes all customer contacts. ' items: $ref: '#/components/schemas/CustomerContact' type: array databaseSoftwareImageId: description: The Autonomous AI Database Software Image [OCID](/Content/General/Concepts/identifiers.htm). maxLength: 255 minLength: 1 type: string dbName: description: The Database name for the Autonomous Container Database. The name must be unique within the Cloud Autonomous VM Cluster, starting with an alphabetic character, followed by 1 to 7 alphanumeric characters. maxLength: 8 minLength: 2 type: string dbSplitThreshold: description: The CPU value beyond which an Autonomous AI Database will be opened across multiple nodes. The default value of this attribute is 16 for OCPUs and 64 for ECPUs. minimum: 1 type: integer dbUniqueName: description: '**Deprecated.** The `DB_UNIQUE_NAME` value is set by Oracle Cloud Infrastructure. Do not specify a value for this parameter. Specifying a value for this field will cause Terraform operations to fail. ' maxLength: 32 minLength: 1 type: string dbVersion: description: The base version for the Autonomous Container Database. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object displayName: description: The display name for the Autonomous Container Database. maxLength: 255 minLength: 1 type: string distributionAffinity: description: Determines whether an Autonomous AI Database must be opened across a minimum or maximum of nodes. By default, Minimum nodes is selected. enum: - MINIMUM_DISTRIBUTION - MAXIMUM_DISTRIBUTION type: string fastStartFailOverLagLimitInSeconds: description: The lag time for my preference based on data loss tolerance in seconds. maximum: 3600 minimum: 5 type: integer freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object isAutomaticFailoverEnabled: description: 'Indicates whether Automatic Failover is enabled for Autonomous Container Database Dataguard Association ' type: boolean isDstFileUpdateEnabled: description: Indicates if an automatic DST Time Zone file update is enabled for the Autonomous Container Database. If enabled along with Release Update, patching will be done in a Non-Rolling manner. type: boolean keyStoreId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the key store of Oracle Vault. maxLength: 255 minLength: 1 type: string kmsKeyId: description: The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. maxLength: 255 minLength: 1 type: string kmsKeyVersionId: description: 'The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous AI Database Serverless does not use key versions, hence is not applicable for Autonomous AI Database Serverless instances. ' maxLength: 255 minLength: 1 type: string maintenanceWindowDetails: $ref: '#/components/schemas/MaintenanceWindow' netServicesArchitecture: default: DEDICATED description: Enabling SHARED server architecture enables a database server to allow many client processes to share very few server processes, thereby increasing the number of supported users. enum: - DEDICATED - SHARED - DRCP type: string okvEndPointGroupName: description: 'The OKV End Point Group name for the Autonomous Container Database. ' maxLength: 128 minLength: 1 type: string patchModel: description: Database Patch model preference. enum: - RELEASE_UPDATES - RELEASE_UPDATE_REVISIONS type: string peerAutonomousContainerDatabaseBackupConfig: $ref: '#/components/schemas/PeerAutonomousContainerDatabaseBackupConfig' peerAutonomousContainerDatabaseCompartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment where the standby Autonomous Container Database will be created. ' maxLength: 255 minLength: 1 type: string peerAutonomousContainerDatabaseDisplayName: description: The display name for the peer Autonomous Container Database. maxLength: 255 minLength: 1 type: string peerAutonomousExadataInfrastructureId: description: '*No longer used.* This parameter is no longer used for Autonomous AI Database on dedicated Exadata infrasture. Specify a `peerCloudAutonomousVmClusterId` instead. Using this parameter will cause the operation to fail. ' maxLength: 255 minLength: 1 type: string peerAutonomousVmClusterId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the peer Autonomous VM cluster for Autonomous Data Guard. Required to enable Data Guard. ' maxLength: 255 minLength: 1 type: string peerCloudAutonomousVmClusterId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the peer cloud Autonomous Exadata VM Cluster. maxLength: 255 minLength: 1 type: string peerDbUniqueName: description: '**Deprecated.** The `DB_UNIQUE_NAME` of the peer Autonomous Container Database in a Data Guard association is set by Oracle Cloud Infrastructure. Do not specify a value for this parameter. Specifying a value for this field will cause Terraform operations to fail. ' maxLength: 32 minLength: 1 type: string x-default-description: This field will have a value if the Autonomous Container Database is Data Guard enabled. The value will be dynamically generated if it is null. protectionMode: description: 'The protection mode of this Autonomous Data Guard association. For more information, see [Oracle Data Guard Protection Modes](http://docs.oracle.com/database/122/SBYDB/oracle-data-guard-protection-modes.htm#SBYDB02000) in the Oracle Data Guard documentation. ' enum: - MAXIMUM_AVAILABILITY - MAXIMUM_PERFORMANCE type: string serviceLevelAgreementType: description: The service level agreement type of the Autonomous Container Database. The default is STANDARD. For an autonomous dataguard Autonomous Container Database, the specified Autonomous Exadata Infrastructure must be associated with a remote Autonomous Exadata Infrastructure. enum: - STANDARD - AUTONOMOUS_DATAGUARD type: string source: default: NONE description: 'The source of the database. Use `NONE` to create a new Autonomous Container Database (ACD). Use `BACKUP_FROM_ID` to create a new ACD from a specified backup. ' enum: - NONE - BACKUP_FROM_ID type: string standbyMaintenanceBufferInDays: description: 'The scheduling detail for the quarterly maintenance window of the standby Autonomous Container Database. This value represents the number of days before scheduled maintenance of the primary database. ' maximum: 7 minimum: 1 type: integer vaultId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [vault](/Content/KeyManagement/Concepts/keyoverview.htm#concepts). This parameter and `secretId` are required for Customer Managed Keys. maxLength: 255 minLength: 1 type: string versionPreference: default: NEXT_RELEASE_UPDATE description: 'The next maintenance version preference. ' enum: - NEXT_RELEASE_UPDATE - LATEST_RELEASE_UPDATE type: string vmFailoverReservation: default: 50 description: The percentage of CPUs reserved across nodes to support node failover. Allowed values are 0%, 25%, 50%, 75%, and 100%, with 50% being the default option. type: integer required: - displayName - patchModel type: object VmClusterSummary: description: 'Details of the Exadata Cloud@Customer VM cluster. ' properties: availabilityDomain: description: The name of the availability domain that the VM cluster is located in. maxLength: 255 minLength: 1 type: string compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string computeModel: description: 'The compute model of the Base Database, Exadata Infrastructure, VM Cluster and Autonomous AI Database. ' enum: - ECPU - OCPU type: string x-default-description: Null used when unspecified. cpusEnabled: description: The number of enabled CPU cores. type: integer dataCollectionOptions: $ref: '#/components/schemas/DataCollectionOptions' dataStoragePercentage: description: 'The percentage assigned to DATA storage (user data and database files). See [Storage Configuration](/Content/Database/Concepts/exaoverview.htm#Exadata) in the Exadata documentation for details on the impact of the configuration settings on storage. ' format: int32 maximum: 100 minimum: 0 type: integer dataStorageSizeInGBs: description: Size of the DATA disk group in GBs. format: double minimum: 32 type: number dataStorageSizeInTBs: description: Size, in terabytes, of the DATA disk group. format: double type: number dbNodeStorageSizeInGBs: description: The local node storage allocated in GBs. type: integer dbServers: description: The list of Db server. items: maxLength: 1024 minLength: 1 type: string type: array definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object displayName: description: The user-friendly name for the Exadata Cloud@Customer VM cluster. The name does not need to be unique. maxLength: 255 minLength: 1 type: string exadataInfrastructureId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure. maxLength: 255 minLength: 1 type: string fileSystemConfigurationDetails: description: Details of the file system configuration of the VM cluster. items: $ref: '#/components/schemas/FileSystemConfigurationDetail' maxItems: 1024 type: array freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object giSoftwareImageId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of a grid infrastructure software image. This is a database software image of the type `GRID_IMAGE`. maxLength: 255 type: string giVersion: description: The Oracle Grid Infrastructure software version for the VM cluster. maxLength: 255 minLength: 1 type: string id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the VM cluster. maxLength: 255 minLength: 1 type: string isLocalBackupEnabled: description: 'If true, database backup on local Exadata storage is configured for the VM cluster. If false, database backup on local Exadata storage is not available in the VM cluster. ' type: boolean isSparseDiskgroupEnabled: description: 'If true, sparse disk group is configured for the VM cluster. If false, sparse disk group is not created. ' type: boolean lastPatchHistoryEntryId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the last patch history. This value is updated as soon as a patch operation starts. maxLength: 255 minLength: 1 type: string licenseModel: description: 'The Oracle license model that applies to the VM cluster. The default is LICENSE_INCLUDED. ' enum: - LICENSE_INCLUDED - BRING_YOUR_OWN_LICENSE type: string lifecycleDetails: description: Additional information about the current lifecycle state. type: string lifecycleState: description: The current state of the VM cluster. enum: - PROVISIONING - AVAILABLE - UPDATING - TERMINATING - TERMINATED - FAILED - MAINTENANCE_IN_PROGRESS type: string memorySizeInGBs: description: The memory allocated in GBs. type: integer ocpusEnabled: description: The number of enabled OCPU cores. format: float minimum: 0.1 type: number recoStoragePercentage: description: 'The percentage assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). See [Storage Configuration](/Content/Database/Concepts/exaoverview.htm#Exadata) in the Exadata documentation for details on the impact of the configuration settings on storage. ' format: int32 maximum: 100 minimum: 0 type: integer shape: description: 'The shape of the Exadata infrastructure. The shape determines the amount of CPU, storage, and memory resources allocated to the instance. ' type: string sparseStoragePercentage: description: 'The percentage assigned to SPARSE storage (Exadata snapshots). See [Storage Configuration](/Content/Database/Concepts/exaoverview.htm#Exadata) in the Exadata documentation for details on the impact of the configuration settings on storage. ' format: int32 maximum: 100 minimum: 0 type: integer sshPublicKeys: description: The public key portion of one or more key pairs used for SSH access to the VM cluster. items: maxLength: 1024 minLength: 1 type: string type: array systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object systemVersion: description: Operating system version of the image. maxLength: 255 minLength: 1 type: string timeCreated: description: The date and time that the VM cluster was created. format: date-time type: string timeZone: description: The time zone of the Exadata infrastructure. For details, see [Exadata Infrastructure Time Zones](/Content/Database/References/timezones.htm). format: x-obmcs-time-zone maxLength: 255 minLength: 1 type: string vmBackupStorageType: description: Specifies the type of VM Backups Storage and supported values are LOCAL and EXASCALE. - LOCAL if selected then VM Backups storage will be on DB Servers. - EXASCALE if selected then VM Backups storage will be on Exascale Storage Servers. Default Value is LOCAL. enum: - LOCAL - EXASCALE type: string vmClusterNetworkId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the VM cluster network. maxLength: 255 minLength: 1 type: string vmFileSystemStorageType: description: Specifies the type of file system storage and supported values are LOCAL and EXASCALE. - LOCAL if selected then file system storage will be on DB Servers. - EXASCALE if selected then file system storage will be on Exascale Storage Servers. Default Value is LOCAL enum: - LOCAL - EXASCALE type: string RefreshableCloneCollection: description: A list of Autonomous AI Database RefreshableClone containing RefreshableCloneSummary items. properties: items: items: $ref: '#/components/schemas/RefreshableCloneSummary' type: array required: - items AutonomousDatabaseDataguardAssociation: description: 'The properties that define dataguard association between two different Autonomous AI Databases. Note that Autonomous AI Databases inherit DataGuard association from parent Autonomous Container Database. No actions can be taken on AutonomousDatabaseDataguardAssociation, usage is strictly informational. ' properties: applyLag: description: 'The lag time between updates to the primary database and application of the redo data on the standby database, as computed by the reporting database. Example: `9 seconds` ' type: string applyRate: description: 'The rate at which redo logs are synced between the associated databases. Example: `180 Mb per second` ' type: string autonomousDatabaseId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Autonomous AI Database that has a relationship with the peer Autonomous AI Database. ' maxLength: 255 minLength: 1 type: string id: description: The OCID of the Autonomous Dataguard created for Autonomous Container Database where given Autonomous AI Database resides in. maxLength: 255 minLength: 1 type: string isAutomaticFailoverEnabled: description: 'Indicates whether Automatic Failover is enabled for Autonomous Container Database Dataguard Association ' type: boolean lifecycleDetails: description: 'Additional information about the current lifecycleState, if available. ' type: string lifecycleState: description: The current state of Autonomous Data Guard. enum: - PROVISIONING - AVAILABLE - ROLE_CHANGE_IN_PROGRESS - TERMINATING - TERMINATED - FAILED - UNAVAILABLE - UPDATING type: string peerAutonomousDatabaseId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the peer Autonomous AI Database. ' maxLength: 255 minLength: 1 type: string peerAutonomousDatabaseLifeCycleState: description: The current state of the Autonomous AI Database. enum: - PROVISIONING - AVAILABLE - STOPPING - STOPPED - STARTING - TERMINATING - TERMINATED - UNAVAILABLE - RESTORE_IN_PROGRESS - RESTORE_FAILED - BACKUP_IN_PROGRESS - SCALE_IN_PROGRESS - AVAILABLE_NEEDS_ATTENTION - UPDATING - MAINTENANCE_IN_PROGRESS - RESTARTING - RECREATING - ROLE_CHANGE_IN_PROGRESS - UPGRADING - INACCESSIBLE - STANDBY - TRANSPORTING type: string peerRole: description: 'The Data Guard role of the Autonomous Container Database or Autonomous AI Database, if Autonomous Data Guard is enabled. ' enum: - PRIMARY - STANDBY - DISABLED_STANDBY - BACKUP_COPY - SNAPSHOT_STANDBY type: string protectionMode: description: 'The protection mode of this Autonomous Data Guard association. For more information, see [Oracle Data Guard Protection Modes](http://docs.oracle.com/database/122/SBYDB/oracle-data-guard-protection-modes.htm#SBYDB02000) in the Oracle Data Guard documentation. ' enum: - MAXIMUM_AVAILABILITY - MAXIMUM_PERFORMANCE type: string role: description: 'The Data Guard role of the Autonomous Container Database or Autonomous AI Database, if Autonomous Data Guard is enabled. ' enum: - PRIMARY - STANDBY - DISABLED_STANDBY - BACKUP_COPY - SNAPSHOT_STANDBY type: string timeCreated: description: The date and time the Data Guard association was created. format: date-time type: string timeLastRoleChanged: description: The date and time when the last role change action happened. format: date-time type: string timeLastSynced: description: The date and time of the last update to the apply lag, apply rate, and transport lag values. format: date-time type: string transportLag: description: 'The approximate number of seconds of redo data not yet available on the standby Autonomous Container Database, as computed by the reporting database. Example: `7 seconds` ' type: string required: - id - lifecycleState - autonomousDatabaseId - role - peerRole DbServerDetails: description: 'Details of the Exacc Db server. Applies to Exadata Cloud@Customer instances only. ' properties: dbServerId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of Exacc Db server. maxLength: 255 minLength: 1 type: string required: - dbServerId AutonomousDatabaseBackupConfig: description: 'Autonomous AI Database configuration details for storing [manual backups](https://docs.oracle.com/en/cloud/paas/autonomous-database/adbsa/backup-restore.html#GUID-9035DFB8-4702-4CEB-8281-C2A303820809) in the [Object Storage](/Content/Object/Concepts/objectstorageoverview.htm) service. ' properties: manualBackupBucketName: description: Name of [Object Storage](/Content/Object/Concepts/objectstorageoverview.htm) bucket to use for storing manual backups. type: string manualBackupType: description: The manual backup destination type. enum: - NONE - OBJECT_STORE type: string UpdateExecutionActionDetails: description: 'Describes the modification parameters for the execution action. ' properties: actionMembers: description: List of action members of this execution action. items: $ref: '#/components/schemas/ExecutionActionMember' maxItems: 200 type: array actionParams: additionalProperties: type: string description: 'Map where a key value pair describes the specific action parameter. Example: `{"count": "3"}` ' maxProperties: 100 type: object definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object executionWindowId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the execution window resource the execution action belongs to. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object ChangeExadbVmClusterSubscriptionDetails: allOf: - $ref: '#/components/schemas/ChangeSubscriptionDetails' description: 'The configuration details for associating the Exadata VM cluster on Exascale Infrastructure with a different subscription. ' CreateExternalBackupJobDetails: properties: availabilityDomain: description: The targeted availability domain for the backup. maxLength: 255 minLength: 1 type: string characterSet: description: The character set for the database. maxLength: 255 minLength: 1 type: string compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment where this backup should be created. maxLength: 255 minLength: 1 type: string databaseEdition: description: 'The Oracle Database Edition that applies to all the databases on the DB system. Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE. ' enum: - STANDARD_EDITION - ENTERPRISE_EDITION - ENTERPRISE_EDITION_HIGH_PERFORMANCE - ENTERPRISE_EDITION_EXTREME_PERFORMANCE - ENTERPRISE_EDITION_DEVELOPER type: string databaseMode: description: The mode (single instance or RAC) of the database being backed up. enum: - SI - RAC type: string dbName: description: The name of the database from which the backup is being taken. maxLength: 8 minLength: 1 type: string dbUniqueName: description: The `DB_UNIQUE_NAME` of the Oracle Database being backed up. maxLength: 32 minLength: 1 type: string dbVersion: description: A valid Oracle Database version. maxLength: 255 minLength: 1 type: string displayName: description: A user-friendly name for the backup. This name does not have to be unique. maxLength: 255 minLength: 1 type: string externalDatabaseIdentifier: description: The `DBID` of the Oracle Database being backed up. format: int64 type: integer ncharacterSet: description: The national character set for the database. maxLength: 255 minLength: 1 type: string pdbName: description: The pluggable database name. maxLength: 30 minLength: 1 type: string required: - availabilityDomain - compartmentId - dbVersion - dbName - externalDatabaseIdentifier - displayName - characterSet - ncharacterSet - databaseMode - databaseEdition CreatePluggableDatabaseCreationTypeDetails: description: 'The Pluggable Database creation type. Use `LOCAL_CLONE_PDB` for creating a new PDB using Local Clone on Source Pluggable Database. This will Clone and starts a pluggable database (PDB) in the same database (CDB) as the source PDB. The source PDB must be in the `READ_WRITE` openMode to perform the clone operation. sourcePluggableDatabaseSnapshotId and isThinClone options are supported for Exadata VM cluster on Exascale Infrastructure, Exadata Cloud@Customer VM Cluster on Exadata Cloud@Customer infrastructure, and Exadata Cloud VM cluster on cloud Exadata infrastructure Use `REMOTE_CLONE_PDB` for creating a new PDB using Remote Clone on Source Pluggable Database. This will Clone a pluggable database (PDB) to a different database from the source PDB. The cloned PDB will be started upon completion of the clone operation. The source PDB must be in the `READ_WRITE` openMode when performing the clone. For Exadata Cloud@Customer instances, the source pluggable database (PDB) must be on the same Exadata Infrastructure as the target container database (CDB) to create a remote clone. sourcePluggableDatabaseSnapshotId and isThinClone options are supported for Exadata VM cluster on Exascale Infrastructure, Exadata Cloud@Customer VM Cluster on Exadata Cloud@Customer infrastructure, and Exadata Cloud VM cluster on cloud Exadata infrastructure. Use `RELOCATE_PDB` for relocating the Pluggable Database from Source CDB and creating it in target CDB. This will relocate a pluggable database (PDB) to a different database from the source PDB. The source PDB must be in the `READ_WRITE` openMode when performing the relocate. ' discriminator: propertyName: creationType properties: creationType: description: The Pluggable Database creation type. enum: - LOCAL_CLONE_PDB - REMOTE_CLONE_PDB - RELOCATE_PDB type: string required: - creationType RestoreAutonomousDatabaseDetails: description: 'Details to restore an Oracle Autonomous AI Database. ' properties: databaseSCN: description: 'Restores using the backup with the System Change Number (SCN) specified. ' maxLength: 255 minLength: 1 type: string latest: description: 'Restores to the last known good state with the least possible data loss. ' type: boolean timestamp: description: The time to restore the database to. format: date-time type: string ChangeVmClusterCompartmentDetails: description: 'The configuration details for moving the VM cluster. ' properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the VM cluster to. ' maxLength: 255 minLength: 1 type: string required: - compartmentId ChangeCloudExadataInfrastructureCompartmentDetails: description: 'The configuration details for moving the cloud Exadata infrastructure resource to another compartment. Applies to Exadata Cloud Service instances only. ' properties: compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string required: - compartmentId AcdAvmResourceStats: description: Resource usage by autonomous container database in a particular VM. properties: displayName: description: The user-friendly name for the Autonomous VM. The name does not need to be unique. type: string id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Autonomous VM. type: string provisionedCpus: description: CPUs/cores assigned to Autonomous AI Databases for the ACD instance in given Autonomus VM. format: float type: number reclaimableCpus: description: 'CPUs/cores that continue to be included in the count of OCPUs available to the Autonomous Container Database in given Autonomous VM, even after one of its Autonomous AI Database is terminated or scaled down. You can release them to the available OCPUs at its parent AVMC level by restarting the Autonomous Container Database. ' format: float type: number reservedCpus: description: 'CPUs/cores reserved for scalability, resilliency and other overheads. This includes failover, autoscaling and idle instance overhead. ' format: float type: number usedCpus: description: 'CPUs/cores assigned to the ACD instance in given Autonomous VM. Sum of provisioned, reserved and reclaimable CPUs/ cores to the ACD instance. ' format: float type: number ScheduledActionSummary: description: Details of a scheduled action. properties: actionMembers: description: The list of action members in a scheduled action. items: $ref: '#/components/schemas/ActionMember' maxItems: 200 type: array actionOrder: description: The order of the scheduled action. maximum: 300 minimum: 1 type: integer actionParams: additionalProperties: type: string description: 'Map where a key value pair describes the specific action parameter. Example: `{"count": "3"}` ' maxProperties: 100 type: object actionType: default: DB_SERVER_FULL_SOFTWARE_UPDATE description: The type of the scheduled action being performed enum: - DB_SERVER_FULL_SOFTWARE_UPDATE - STORAGE_SERVER_FULL_SOFTWARE_UPDATE - NETWORK_SWITCH_FULL_SOFTWARE_UPDATE - DB_SERVER_ONLINE_SOFTWARE_UPDATE type: string compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object displayName: description: The display name of the Scheduled Action. maxLength: 255 minLength: 1 type: string estimatedTimeInMins: description: The estimated patching time for the scheduled action. maximum: 500000 minimum: 0 type: integer freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Scheduled Action. maxLength: 255 minLength: 1 type: string lifecycleState: description: 'The current state of the Scheduled Action. Valid states are CREATING, NEEDS_ATTENTION, AVAILABLE, UPDATING, FAILED, DELETING and DELETED. ' enum: - CREATING - NEEDS_ATTENTION - AVAILABLE - UPDATING - FAILED - DELETING - DELETED type: string schedulingPlanId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Scheduling Plan. maxLength: 255 minLength: 1 type: string schedulingWindowId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Scheduling Window. maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object timeCreated: description: The date and time the Scheduled Action Resource was created. format: date-time type: string timeUpdated: description: The date and time the Scheduled Action Resource was updated. format: date-time type: string required: - id - actionOrder - actionType - schedulingPlanId - timeCreated - displayName - compartmentId - lifecycleState type: object ExadbVmClusterUpdate: allOf: - $ref: '#/components/schemas/ExadbVmClusterUpdateSummary' description: 'A maintenance update details for an Exadata VM cluster on Exascale Infrastructure. ' ConsoleHistoryCollection: description: Results of the Db Node console history lists. Contains ConsoleHistorySummary items. properties: items: description: List of Db Node console histories. items: $ref: '#/components/schemas/ConsoleHistorySummary' maxItems: 1024 type: array required: - items UpdateExternalNonContainerDatabaseDetails: allOf: - $ref: '#/components/schemas/UpdateExternalDatabaseDetailsBase' description: 'Details for updating an external non-container database. This API is not currently supported. ' VmClusterUpdateSummary: description: 'A maintenance update for a VM cluster. Applies to Exadata Cloud@Customer instances only. 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: availableActions: description: The possible actions that can be performed using this maintenance update. items: enum: - ROLLING_APPLY - PRECHECK - ROLLBACK type: string type: array description: description: Details of the maintenance update package. maxLength: 255 minLength: 1 type: string id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the maintenance update. maxLength: 255 minLength: 1 type: string lastAction: description: The update action performed most recently using this maintenance update. enum: - ROLLING_APPLY - PRECHECK - ROLLBACK type: string lifecycleDetails: description: 'Descriptive text providing additional details about the lifecycle state. ' type: string lifecycleState: description: The current state of the maintenance update. Dependent on value of `lastAction`. enum: - AVAILABLE - SUCCESS - IN_PROGRESS - FAILED type: string timeReleased: description: The date and time the maintenance update was released. format: date-time type: string updateType: description: The type of VM cluster maintenance update. enum: - GI_UPGRADE - GI_PATCH - OS_UPDATE type: string version: description: The version of the maintenance update package. maxLength: 255 minLength: 1 type: string required: - id - description - version - timeReleased - updateType GiVersionSummary: description: 'The Oracle Grid Infrastructure (GI) version. 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: version: description: A valid Oracle Grid Infrastructure (GI) software version. maxLength: 255 minLength: 1 type: string required: - version CreateAutonomousVmClusterDetails: description: 'Details for the create Autonomous VM cluster operation. ' properties: autonomousDataStorageSizeInTBs: description: The data disk group size to be allocated for Autonomous Databases, in TBs. format: double type: number compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string computeModel: default: ECPU description: 'The compute model of the Autonomous VM Cluster. ECPU compute model is the recommended model and OCPU compute model is legacy. ' enum: - ECPU - OCPU type: string cpuCoreCountPerNode: description: The number of CPU cores to enable per VM cluster node. type: integer dbServers: description: The list of [OCIDs](/Content/General/Concepts/identifiers.htm) of the Db servers. items: maxLength: 255 minLength: 1 type: string type: array definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object displayName: description: The user-friendly name for the Autonomous VM cluster. The name does not need to be unique. maxLength: 255 minLength: 1 type: string distributionAlgorithm: description: The distribution algorithm used for the Autonomous VM cluster. enum: - RESOURCE_OPTIMIZED - DISTRIBUTION_OPTIMIZED type: string exadataInfrastructureId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object isLocalBackupEnabled: description: 'If true, database backup on local Exadata storage is configured for the Autonomous VM cluster. If false, database backup on local Exadata storage is not available in the Autonomous VM cluster. ' type: boolean isMtlsEnabled: default: false description: Enable mutual TLS(mTLS) authentication for database while provisioning a VMCluster. Default is TLS. type: boolean licenseModel: description: 'The Oracle license model that applies to the Autonomous VM cluster. The default is BRING_YOUR_OWN_LICENSE. ' enum: - LICENSE_INCLUDED - BRING_YOUR_OWN_LICENSE type: string maintenanceWindowDetails: $ref: '#/components/schemas/MaintenanceWindow' memoryPerOracleComputeUnitInGBs: description: 'The amount of memory (in GBs) to be enabled per OCPU or ECPU. ' type: integer scanListenerPortNonTls: description: The SCAN Listener Non TLS port number. Default value is 1521. maximum: 8999 minimum: 1024 type: integer scanListenerPortTls: description: The SCAN Listener TLS port number. Default value is 2484. maximum: 8999 minimum: 1024 type: integer sgaPercentage: description: Percentage of ECPU memory allocated for SGA(System Global Area). format: float type: number timeZone: description: The time zone to use for the Autonomous VM cluster. For details, see [DB System Time Zones](/Content/Database/References/timezones.htm). format: x-obmcs-time-zone maxLength: 255 minLength: 1 type: string totalContainerDatabases: description: The total number of Autonomous Container Databases that can be created. type: integer vmClusterNetworkId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the VM cluster network. maxLength: 255 minLength: 1 type: string required: - compartmentId - displayName - exadataInfrastructureId - vmClusterNetworkId PdbConversionHistoryEntry: allOf: - $ref: '#/components/schemas/PdbConversionHistoryEntrySummary' description: 'Details of operations performed to convert a non-container database to pluggable database. ' ConfigureSaasAdminUserDetails: allOf: - $ref: '#/components/schemas/SaasAdminUserStatus' - properties: duration: description: How long, in hours, the SaaS administrative user will stay enabled. If no duration is specified, the default value 1 will be used. maximum: 24 minimum: 1 type: integer password: description: A strong password for SaaS administrative user. The password must be a minimum of nine (9) characters and contain a minimum of two (2) uppercase, two (2) lowercase, two (2) numbers, and two (2) special characters from _ (underscore), \# (hashtag), or - (dash). maxLength: 255 minLength: 9 type: string secretId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [secret](/Content/KeyManagement/Concepts/keyoverview.htm#concepts). maxLength: 255 minLength: 1 type: string secretVersionNumber: description: The version of the vault secret. If no version is specified, the latest version will be used. maximum: 60 minimum: 1 type: integer type: object description: Details to update SaaS administrative user configuration. DbHomeSummary: description: 'A directory where Oracle Database software is installed. A bare metal or Exadata DB system can have multiple Database Homes and each Database Home can run a different supported version of Oracle Database. A virtual machine DB system can have only one Database Home. For more information, see [Bare Metal and Virtual Machine DB Systems](/Content/Database/Concepts/overview.htm) and [Exadata DB Systems](/Content/Database/Concepts/exaoverview.htm). 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). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' properties: compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string databaseSoftwareImageId: description: The database software image [OCID](/Content/General/Concepts/identifiers.htm) maxLength: 255 minLength: 1 type: string dbHomeLocation: description: The location of the Oracle Database Home. maxLength: 255 minLength: 1 type: string dbSystemId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the DB system. maxLength: 255 minLength: 1 type: string dbVersion: description: The Oracle Database version. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object displayName: description: The user-provided name for the Database Home. The name does not need to be unique. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object homeType: description: 'Represents database home will be managed by oracle or customer ' enum: - ORACLE_MANAGED - CUSTOMER_MANAGED type: string id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Database Home. maxLength: 255 minLength: 1 type: string kmsKeyId: description: The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. maxLength: 255 minLength: 1 type: string lastPatchHistoryEntryId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the last patch history. This value is updated as soon as a patch operation is started. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: Additional information about the current lifecycle state. type: string lifecycleState: description: The current state of the Database Home. enum: - PROVISIONING - AVAILABLE - UPDATING - TERMINATING - TERMINATED - FAILED type: string oneOffPatches: description: List of one-off patches for Database Homes. items: type: string type: array systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object timeCreated: description: The date and time the Database Home was created. format: date-time type: string vmClusterId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the VM cluster. maxLength: 255 minLength: 1 type: string required: - id - compartmentId - lifecycleState - displayName - dbVersion - dbHomeLocation AutonomousDatabaseManualRefreshDetails: description: 'Details of manual refresh for an Autonomous AI Database refreshable clone. ' properties: timeRefreshCutoff: description: The timestamp to which the Autonomous AI Database refreshable clone will be refreshed. Changes made in the primary database after this timestamp are not part of the data refresh. format: date-time type: string DbnodeSnapshots: description: 'Details of the Database Node Snapshot. ' properties: name: description: The user-friendly name for the Database Node Snapshot. The name should be unique. maxLength: 255 minLength: 1 type: string snapshots: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata Database Node. ' items: $ref: '#/components/schemas/DbnodeSnapshot' maxItems: 10 minItems: 1 minLength: 1 type: array required: - name UpdateDataGuardDetails: description: The properties for updating a standby database. properties: databaseAdminPassword: description: 'The administrator password of the primary database in this Data Guard association. **The password MUST be the same as the primary admin password.** ' format: password maxLength: 255 minLength: 1 type: string isActiveDataGuardEnabled: description: True if active Data Guard is enabled. type: boolean protectionMode: description: 'The protection mode of this Data Guard. For more information, see [Oracle Data Guard Protection Modes](http://docs.oracle.com/database/122/SBYDB/oracle-data-guard-protection-modes.htm#SBYDB02000) in the Oracle Data Guard documentation. ' enum: - MAXIMUM_AVAILABILITY - MAXIMUM_PERFORMANCE - MAXIMUM_PROTECTION type: string transportType: description: 'The redo transport type to use for this Data Guard association. Valid values depend on the specified `protectionMode`: * MAXIMUM_AVAILABILITY - SYNC or FASTSYNC * MAXIMUM_PERFORMANCE - ASYNC * MAXIMUM_PROTECTION - SYNC For more information, see [Redo Transport Services](http://docs.oracle.com/database/122/SBYDB/oracle-data-guard-redo-transport-services.htm#SBYDB00400) in the Oracle Data Guard documentation. **IMPORTANT** - The only transport type currently supported by the Database service is ASYNC. ' enum: - SYNC - ASYNC - FASTSYNC type: string type: object ChangeCloudVmClusterSubscriptionDetails: allOf: - $ref: '#/components/schemas/ChangeSubscriptionDetails' description: 'The configuration details for associating the cloud VM cluster resource with a different subscription. ' RegisterCloudVmClusterPkcsDetails: description: 'Details of registering PKCS11 driver. ' properties: tdeKeyStoreType: description: TDE keystore type enum: - AZURE - OCI type: string x-default-description: 'null' required: - tdeKeyStoreType CreateDatabaseSoftwareImageDetails: description: 'Parameters for creating a database software image in the specified compartment. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' properties: compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment the database software image belongs in. maxLength: 255 minLength: 1 type: string databaseSoftwareImageOneOffPatches: description: List of one-off patches for Database Homes. items: type: string type: array databaseVersion: description: The database version with which the database software image is to be built. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object displayName: description: The user-friendly name for the database software image. The name does not have to be unique. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object imageShapeFamily: default: VM_BM_SHAPE description: To what shape the image is meant for. enum: - VM_BM_SHAPE - EXADATA_SHAPE - EXACC_SHAPE - EXADBXS_SHAPE type: string imageType: default: DATABASE_IMAGE description: The type of software image. Can be grid or database. enum: - GRID_IMAGE - DATABASE_IMAGE type: string lsInventory: description: The output from the OPatch lsInventory command, which is passed as a string. maxLength: 262144 minLength: 1 type: string patchSet: description: The PSU or PBP or Release Updates. To get a list of supported versions, use the [ListDbVersions](#/en/database/latest/DbVersionSummary/ListDbVersions) operation. maxLength: 255 minLength: 1 type: string sourceDbHomeId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Database Home. maxLength: 255 minLength: 1 type: string required: - compartmentId - displayName UpdateAutonomousDatabaseBackupDetails: description: 'Details for updating the Autonomous AI Database backup. **Warning:** Oracle recommends avoiding using confidential information when you supply string values using the API. ' properties: retentionPeriodInDays: description: Retention period, in days, for long-term backups maximum: 3650 minimum: 90 type: integer ConvertToPdbTargetBase: description: 'Details of the container database in which the converted pluggable database will be located. ' discriminator: propertyName: target properties: target: description: "The target container database of the pluggable database created by the database conversion operation. Currently, the database conversion operation only supports creating the pluggable database in a new container database.\n - Use `NEW_DATABASE` to specify that the pluggable database be created within a new container database in the same database home.\n" enum: - NEW_DATABASE type: string UpdateSummary: description: 'A maintenance update for a cloud VM cluster. Applies to Exadata Cloud Service instances only. 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: availableActions: description: The possible actions performed by the update operation on the infrastructure components. items: enum: - ROLLING_APPLY - NON_ROLLING_APPLY - PRECHECK - ROLLBACK type: string type: array description: description: Details of the maintenance update package. maxLength: 255 minLength: 1 type: string id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the maintenance update. maxLength: 255 minLength: 1 type: string lastAction: description: The previous update action performed. enum: - ROLLING_APPLY - NON_ROLLING_APPLY - PRECHECK - ROLLBACK type: string lifecycleDetails: description: 'Descriptive text providing additional details about the lifecycle state. ' type: string lifecycleState: description: The current state of the maintenance update. Dependent on value of `lastAction`. enum: - AVAILABLE - SUCCESS - IN_PROGRESS - FAILED type: string timeReleased: description: The date and time the maintenance update was released. format: date-time type: string updateType: description: The type of cloud VM cluster maintenance update. enum: - GI_UPGRADE - GI_PATCH - OS_UPDATE type: string version: description: The version of the maintenance update package. maxLength: 255 minLength: 1 type: string required: - id - description - version - timeReleased - updateType PluggableDatabaseNodeLevelDetails: description: Pluggable Database Node Level Details. properties: nodeName: description: The Node name of the Database Instance. maxLength: 255 minLength: 1 type: string openMode: description: 'The mode that pluggable database is in. Open mode can only be changed to READ_ONLY or MIGRATE directly from the backend (within the Oracle Database software). ' enum: - READ_ONLY - READ_WRITE - MOUNTED - MIGRATE type: string required: - nodeName - openMode UpdateExternalPluggableDatabaseDetails: allOf: - $ref: '#/components/schemas/UpdateExternalDatabaseDetailsBase' description: 'Details for updating an external pluggable database. This API is not currently supported. ' AutonomousContainerDatabaseBackupConfig: description: 'Backup options for the Autonomous Container Database. ' properties: backupDestinationDetails: description: Backup destination details. items: $ref: '#/components/schemas/BackupDestinationDetails' type: array recoveryWindowInDays: description: 'Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups. If the number of specified days is 0 then there will be no backups. ' maximum: 95 minimum: 0 type: integer DownloadOneoffPatch: description: 'Data to download one-off patch. ' properties: accessUri: description: URI to download one-off patch. type: string timeCreated: description: The date and time one-off patch URI was created. format: date-time type: string timeExpires: description: The date and time until which the one-off patch URI will be available for download. format: date-time type: string required: - accessUri - timeCreated - timeExpires dbIormConfigUpdateDetail: description: 'Details of the IORM configuration settings update request. ' properties: dbName: description: 'The database name. For the default `DbPlan`, the `dbName` is `default`. ' type: string share: description: 'The relative priority of this database. ' maximum: 32 minimum: 1 type: integer type: object FlexComponentCollection: description: Results of a FlexComponent lists. Contains FlexComponentSummary items. properties: items: items: $ref: '#/components/schemas/FlexComponentSummary' type: array required: - items AutonomousContainerDatabaseDataguard: description: 'The properties that define Autonomous Container Databases Dataguard. ' properties: applyLag: description: 'The lag time between updates to the primary Autonomous Container Database and application of the redo data on the standby Autonomous Container Database, as computed by the reporting database. Example: `9 seconds` ' type: string applyRate: description: 'The rate at which redo logs are synchronized between the associated Autonomous Container Databases. Example: `180 Mb per second` ' type: string automaticFailoverTarget: description: 'Automatically selected by backend when observer is enabled. ' maxLength: 255 minLength: 1 type: string autonomousContainerDatabaseId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Autonomous Container Database that has a relationship with the peer Autonomous Container Database. Used only by Autonomous AI Database on Dedicated Exadata Infrastructure. ' maxLength: 255 minLength: 1 type: string availabilityDomain: description: 'The domain of the Autonomous Container Database ' maxLength: 255 minLength: 1 type: string fastStartFailOverLagLimitInSeconds: description: The lag time for my preference based on data loss tolerance in seconds. maximum: 3600 minimum: 5 type: integer isAutomaticFailoverEnabled: description: 'Indicates whether Automatic Failover is enabled for Autonomous Container Database Dataguard Association ' type: boolean lifecycleDetails: description: 'Additional information about the current lifecycleState, if available. ' type: string lifecycleState: description: The current state of Autonomous Data Guard. enum: - PROVISIONING - AVAILABLE - ROLE_CHANGE_IN_PROGRESS - TERMINATING - TERMINATED - FAILED - UNAVAILABLE - UPDATING type: string protectionMode: description: 'The protection mode of this Autonomous Data Guard association. For more information, see [Oracle Data Guard Protection Modes](http://docs.oracle.com/database/122/SBYDB/oracle-data-guard-protection-modes.htm#SBYDB02000) in the Oracle Data Guard documentation. ' enum: - MAXIMUM_AVAILABILITY - MAXIMUM_PERFORMANCE type: string redoTransportMode: description: 'Automatically selected by backend based on the protection mode. ' maxLength: 255 minLength: 1 type: string role: description: 'The Data Guard role of the Autonomous Container Database or Autonomous AI Database, if Autonomous Data Guard is enabled. ' enum: - PRIMARY - STANDBY - DISABLED_STANDBY - BACKUP_COPY - SNAPSHOT_STANDBY type: string timeCreated: description: The date and time the Autonomous DataGuard association was created. format: date-time type: string timeLagRefreshedOn: description: Timestamp when the lags were last calculated for a standby. format: date-time type: string timeLastRoleChanged: description: The date and time when the last role change action happened. format: date-time type: string timeLastSynced: description: The date and time of the last update to the apply lag, apply rate, and transport lag values. format: date-time type: string transportLag: description: 'The approximate number of seconds of redo data not yet available on the standby Autonomous Container Database, as computed by the reporting database. Example: `7 seconds` ' type: string required: - lifecycleState - autonomousContainerDatabaseId - role PluggableDatabaseConnectionStrings: description: 'Connection strings to connect to an Oracle Pluggable Database. ' properties: allConnectionStrings: additionalProperties: type: string description: All connection strings to use to connect to the pluggable database. type: object pdbDefault: description: A host name-based PDB connection string. maxLength: 255 minLength: 10 type: string pdbIpDefault: description: An IP-based PDB connection string. maxLength: 255 minLength: 10 type: string type: object PluggableDatabaseSnapshot: description: 'Details of the Pluggable Database Snapshot. ' properties: clusterId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the VM cluster. maxLength: 255 minLength: 1 type: string compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata Pluggable Database Snapshot. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: Additional information about the current lifecycle state of the Exadata Pluggable Database Snapshot. type: string lifecycleState: description: The current state of the Exadata Pluggable Database Snapshot. enum: - CREATING - AVAILABLE - TERMINATING - TERMINATED - FAILED type: string name: description: The user-friendly name for the Database Snapshot. The name should be unique. maxLength: 255 minLength: 1 type: string pluggableDatabaseId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata Pluggable Database. maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object timeCreated: description: 'The date and time that the Exadata Pluggable Database Snapshot was created, as expressed in RFC 3339 format. For example: 2023-06-27T21:10:29Z ' format: date-time type: string required: - id - name - pluggableDatabaseId ConfigureExascaleCloudExadataInfrastructureDetails: description: 'The exascale config request details for the Cloud Exadata infrastructure. ' properties: totalStorageInGBs: description: Storage size needed for Exascale in GBs. type: integer totalVmStorageInGBs: description: Storage size needed for VM storage on Exascale in GBs. type: integer required: - totalStorageInGBs DbSystemComputePerformanceSummary: description: 'Representation of disk performance detail parameters. ' properties: computePerformanceList: description: List of Compute performance details for the specified DB system shape. items: $ref: '#/components/schemas/ComputePerformanceSummary' type: array shape: description: The shape of the DB system. type: string required: - shape - computePerformanceList DbnodeSnapshot: description: 'Details of the Database Node Snapshot. ' properties: clusterId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the VM cluster. maxLength: 255 minLength: 1 type: string compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata Database Node Snapshot. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: Additional information about the current lifecycle state of the Exadata Database Node Snapshot. type: string lifecycleState: description: The current state of the Exadata Database Node Snapshot. enum: - CREATING - AVAILABLE - TERMINATING - TERMINATED - FAILED - MOUNTED - MOUNTING - UNMOUNTING type: string mountPoints: description: Details of the mount points items: $ref: '#/components/schemas/MountPointDetails' maxItems: 10 type: array name: description: The user-friendly name for the Database Node Snapshot. The name should be unique. maxLength: 255 minLength: 1 type: string sourceDbnodeId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata Database Node. maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object timeCreated: description: The date and time that the Exadata Database Node Snapshot was created. format: date-time type: string volumes: description: Details of the volumes items: $ref: '#/components/schemas/VolumeDetails' maxItems: 10 type: array required: - id - name - sourceDbnodeId DbSystemShapeSummary: description: 'The shape of the DB system. The shape determines resources to allocate to the DB system - CPU cores and memory for VM shapes; CPU cores, memory and storage for non-VM (or bare metal) shapes. For Exadata fixed and flexible shapes, detailed specifications can be found in https://docs.oracle.com/en/engineered-systems/exadata-cloud-service/ecscm/exa-service-desc.html#GUID-9E090174-5C57-4EB1-9243-B470F9F10D6B 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: areServerTypesSupported: description: If true, the shape supports configurable DB and Storage Server types. type: boolean availableCoreCount: description: The maximum number of CPU cores that can be enabled on the DB system for this shape. type: integer availableCoreCountPerNode: description: The maximum number of CPU cores per database node that can be enabled for this shape. Only applicable to the flex Exadata shape, ExaCC Elastic shapes and VM Flex shapes. format: int32 type: integer availableDataStorageInTBs: description: The maximum DATA storage that can be enabled for this shape. type: integer availableDataStoragePerServerInTBs: description: The maximum data storage available per storage server for this shape. Only applicable to ExaCC Elastic shapes. format: double type: number availableDbNodePerNodeInGBs: description: The maximum Db Node storage available per database node for this shape. Only applicable to ExaCC Elastic shapes. type: integer availableDbNodeStorageInGBs: description: The maximum Db Node storage that can be enabled for this shape. type: integer availableMemoryInGBs: description: The maximum memory that can be enabled for this shape. type: integer availableMemoryPerNodeInGBs: description: The maximum memory available per database node for this shape. Only applicable to ExaCC Elastic shapes. type: integer computeModel: description: 'The compute model of the Base Database, Exadata Infrastructure, VM Cluster and Autonomous AI Database. ' enum: - ECPU - OCPU type: string x-default-description: Null used when unspecified. coreCountIncrement: description: The discrete number by which the CPU core count for this shape can be increased or decreased. type: integer displayName: description: The display name of the shape used for the DB system. maxLength: 255 minLength: 1 type: string maxStorageCount: description: The maximum number of Exadata storage servers available for the Exadata infrastructure. type: integer maximumNodeCount: description: The maximum number of compute servers available for this shape. type: integer minCoreCountPerNode: description: The minimum number of CPU cores that can be enabled per node for this shape. type: integer minDataStorageInTBs: description: The minimum data storage that need be allocated for this shape. type: integer minDbNodeStoragePerNodeInGBs: description: The minimum Db Node storage that need be allocated per node for this shape. type: integer minMemoryPerNodeInGBs: description: The minimum memory that need be allocated per node for this shape. type: integer minStorageCount: description: The minimum number of Exadata storage servers available for the Exadata infrastructure. type: integer minimumCoreCount: description: The minimum number of CPU cores that can be enabled on the DB system for this shape. type: integer minimumNodeCount: description: The minimum number of compute servers available for this shape. type: integer name: description: The name of the shape used for the DB system. maxLength: 255 minLength: 1 type: string runtimeMinimumCoreCount: description: The runtime minimum number of CPU cores that can be enabled on the DB system for this shape. type: integer shape: description: Deprecated. Use `name` instead of `shape`. maxLength: 255 minLength: 1 type: string shapeAttributes: description: 'The shapeAttributes of the DB system shape. ' items: maxLength: 255 minLength: 1 type: string maxItems: 20 minItems: 0 type: array shapeFamily: description: The family of the shape used for the DB system. maxLength: 255 minLength: 1 type: string shapeType: description: The shape type for the virtual machine DB system. Shape type is determined by CPU hardware. Valid values are `AMD` , `INTEL`, `INTEL_FLEX_X9` or `AMPERE_FLEX_A1`. enum: - AMD - INTEL - INTEL_FLEX_X9 - AMPERE_FLEX_A1 maxLength: 255 minLength: 1 type: string required: - name - availableCoreCount CloudExadataInfrastructure: allOf: - $ref: '#/components/schemas/CloudExadataInfrastructureSummary' description: 'Details of the cloud Exadata infrastructure resource. Applies to Exadata Cloud Service instances only. ' ReinstateDataGuardDetails: description: 'The Data Guard reinstate parameters. ' properties: databaseAdminPassword: description: 'The administrator password of the primary database in this Data Guard association. **The password MUST be the same as the primary admin password.** ' format: password maxLength: 255 minLength: 1 type: string sourceDatabaseId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the source (primary) database in the Data Guard group. type: string required: - databaseAdminPassword - sourceDatabaseId type: object ExternalPluggableDatabaseSummary: allOf: - $ref: '#/components/schemas/ExternalDatabaseBase' - properties: externalContainerDatabaseId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the [external container database](#/en/database/latest/datatypes/CreateExternalContainerDatabaseDetails) that contains the specified [external pluggable database](#/en/database/latest/datatypes/CreateExternalPluggableDatabaseDetails) resource. ' type: string operationsInsightsConfig: $ref: '#/components/schemas/OperationsInsightsConfig' sourceId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the the non-container database that was converted to a pluggable database to create this resource. ' type: string required: - externalContainerDatabaseId type: object description: 'An Oracle Cloud Infrastructure resource that allows you to manage an external pluggable database. ' ComputePerformanceSummary: description: 'Parameters detailing the compute performance for a specified DB system shape. ' properties: cpuCoreCount: description: The number of CPU cores available. maximum: 64 minimum: 1 type: integer memoryInGBs: description: The amount of memory allocated for the VMDB System. format: double type: number networkBandwidthInGbps: description: The network bandwidth of the VMDB system in gbps. format: float type: number networkIops: description: IOPS for the VMDB System. format: float type: number networkThroughputInMbps: description: Network throughput for the VMDB System. format: float type: number required: - cpuCoreCount - memoryInGBs - networkBandwidthInGbps - networkIops - networkThroughputInMbps AssociatedDatabaseDetails: description: Databases associated with a backup destination properties: dbName: description: The display name of the database that is associated with the backup destination. maxLength: 8 minLength: 1 type: string id: description: The database [OCID](/Content/General/Concepts/identifiers.htm). maxLength: 255 minLength: 1 type: string CreateExadataInfrastructureDetails: description: 'Request to create Exadata infrastructure resource. Applies to Exadata Cloud@Customer instances only. See [CreateCloudExadataInfrastructureDetails Reference](#/en/database/latest/datatypes/CreateCloudExadataInfrastructureDetails) for information on creating a cloud Exadata infrastructure resource in an Exadata Cloud Service instance. ' properties: adminNetworkCIDR: description: The CIDR block for the Exadata administration network. maxLength: 255 minLength: 1 type: string cloudControlPlaneServer1: description: The IP address for the first control plane server. maxLength: 255 minLength: 1 type: string cloudControlPlaneServer2: description: The IP address for the second control plane server. maxLength: 255 minLength: 1 type: string compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. ' maxLength: 255 minLength: 1 type: string computeCount: description: The number of compute servers for the Exadata infrastructure. type: integer contacts: description: The list of contacts for the Exadata infrastructure. items: $ref: '#/components/schemas/ExadataInfrastructureContact' maxItems: 10 minItems: 1 type: array corporateProxy: description: 'The corporate network proxy for access to the control plane network. Oracle recommends using an HTTPS proxy when possible for enhanced security. ' maxLength: 255 minLength: 1 type: string databaseServerType: description: The database server type of the Exadata infrastructure. maxLength: 255 minLength: 1 type: string x-default-description: 'null' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object displayName: description: 'The user-friendly name for the Exadata infrastructure. The name does not need to be unique. ' maxLength: 255 minLength: 1 type: string dnsServer: description: The list of DNS server IP addresses. Maximum of 3 allowed. items: maxLength: 1024 minLength: 1 type: string type: array freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object gateway: description: The gateway for the control plane network. maxLength: 255 minLength: 1 type: string infiniBandNetworkCIDR: description: The CIDR block for the Exadata InfiniBand interconnect. maxLength: 255 minLength: 1 type: string isMultiRackDeployment: description: Indicates if deployment is Multi-Rack or not. type: boolean maintenanceVersionPreferences: $ref: '#/components/schemas/MaintenanceVersionPreferenceDetails' maintenanceWindow: $ref: '#/components/schemas/MaintenanceWindow' multiRackConfigurationFile: description: The base64 encoded Multi-Rack configuration json file. format: byte type: string netmask: description: The netmask for the control plane network. maxLength: 255 minLength: 1 type: string networkBondingModeDetails: $ref: '#/components/schemas/NetworkBondingModeDetails' ntpServer: description: The list of NTP server IP addresses. Maximum of 3 allowed. items: maxLength: 1024 minLength: 1 type: string type: array shape: description: 'The shape of the Exadata infrastructure. The shape determines the amount of CPU, storage, and memory resources allocated to the instance. ' maxLength: 255 minLength: 1 type: string storageCount: description: The number of storage servers for the Exadata infrastructure. type: integer storageServerType: description: The storage server type of the Exadata infrastructure. maxLength: 255 minLength: 1 type: string x-default-description: 'null' timeZone: description: 'The time zone of the Exadata infrastructure. For details, see [Exadata Infrastructure Time Zones](/Content/Database/References/timezones.htm). ' format: x-obmcs-time-zone maxLength: 255 minLength: 1 type: string required: - compartmentId - displayName - shape - timeZone - cloudControlPlaneServer1 - cloudControlPlaneServer2 - netmask - gateway - adminNetworkCIDR - infiniBandNetworkCIDR - dnsServer - ntpServer - corporateProxy LongTermBackUpScheduleDetails: description: Details for the long-term backup schedule. properties: isDisabled: default: false description: 'Indicates if the long-term backup schedule should be deleted. The default value is `FALSE`. ' type: boolean repeatCadence: description: The frequency of the long-term backup schedule enum: - ONE_TIME - WEEKLY - MONTHLY - YEARLY type: string retentionPeriodInDays: description: Retention period, in days, for long-term backups maximum: 3650 minimum: 90 type: integer timeOfBackup: description: The timestamp for the long-term backup schedule. For a MONTHLY cadence, months having fewer days than the provided date will have the backup taken on the last day of that month. format: date-time type: string CreateCloudVmClusterDetails: description: 'Details for the create cloud VM cluster operation. Applies to Exadata Cloud Service instances only. ' properties: backupNetworkNsgIds: description: 'A list of the [OCIDs](/Content/General/Concepts/identifiers.htm) of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see [Security Rules](/Content/Network/Concepts/securityrules.htm). Applicable only to Exadata systems. ' items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array uniqueItems: true backupSubnetId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the backup network subnet associated with the cloud VM cluster. ' maxLength: 255 minLength: 1 type: string cloudExadataInfrastructureId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud Exadata infrastructure resource. maxLength: 255 minLength: 1 type: string clusterName: description: 'The cluster name for cloud VM cluster. The cluster name must begin with an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive. ' maxLength: 11 minLength: 1 type: string compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string cpuCoreCount: description: "For fixed shapes, this is the total number of OCPUs to enable across the VM cluster.\n\n - Exadata.Base.48 - Specify a multiple of 2, from 0 to 48.\n - Exadata.Quarter3.100 - Specify a multiple of 2, from 0 to 100.\n - Exadata.Half3.200 - Specify a multiple of 4, from 0 to 200.\n - Exadata.Full3.400 - Specify a multiple of 8, from 0 to 400.\n\nThe API specification for fixed shape values is https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/DbSystemShapeSummary\n\n\nFor flexible shapes X8M and X9M, this is the total number of OCPUs to enable across the VM cluster. The number available for the VM cluster will be based on the number of database servers selected for provisioning the VM cluster on the Exadata Infrastructure.\n\n - Exadata.X8M - Specify a multiple of 2, from 2 to 50 per X8M database server.\n - Exadata.X9M - Specify a multiple of 2, from 2 to 126 per X9M database server.\n\nFor flexible shapes X11M and higher, this is the total number of ECPUs to enable across the VM cluster. The number available for the VM cluster will be based on the number of database servers selected for provisioning the VM cluster on the Exadata Infrastructure.\n\n - Exadata.X11M - Specify a multiple of 8, from 8 to 760 per X11M database server.\n\nThe API specification for flexible shape values is https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/FlexComponentSummary\n" format: int32 minimum: 0 type: integer dataCollectionOptions: $ref: '#/components/schemas/DataCollectionOptions' dataStoragePercentage: description: 'The percentage assigned to DATA storage (user data and database files). See [Storage Configuration](/Content/Database/Concepts/exaoverview.htm#Exadata) in the Exadata documentation for details on the impact of the configuration settings on storage. ' format: int32 maximum: 100 minimum: 0 type: integer dataStorageSizeInTBs: description: The data disk group size to be allocated in TBs. format: double type: number dbNodeStorageSizeInGBs: description: The local node storage to be allocated in GBs. type: integer dbServers: description: The list of DB servers. items: maxLength: 1024 minLength: 1 type: string type: array definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object displayName: description: The user-friendly name for the cloud VM cluster. The name does not need to be unique. maxLength: 255 minLength: 1 type: string domain: description: 'A domain name used for the cloud VM cluster. If the Oracle-provided internet and VCN resolver is enabled for the specified subnet, the domain name for the subnet is used (do not provide one). Otherwise, provide a valid DNS domain name. Hyphens (-) are not permitted. Applies to Exadata Cloud Service instances only. ' type: string exascaleDbStorageVaultId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata Database Storage Vault. maxLength: 255 minLength: 1 type: string fileSystemConfigurationDetails: description: Details of the file system configuration of the VM cluster. items: $ref: '#/components/schemas/FileSystemConfigurationDetail' maxItems: 1024 type: array freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object giVersion: description: A valid Oracle Grid Infrastructure (GI) software version. maxLength: 255 minLength: 1 type: string hostname: description: 'The hostname for the cloud VM cluster. The hostname must begin with an alphabetic character, and can contain alphanumeric characters and hyphens (-). The maximum length of the hostname is 16 characters for bare metal and virtual machine DB systems, and 12 characters for Exadata systems. The maximum length of the combined hostname and domain is 63 characters. **Note:** The hostname must be unique within the subnet. If it is not unique, the cloud VM Cluster will fail to provision. ' type: string isLocalBackupEnabled: description: 'If true, database backup on local Exadata storage is configured for the cloud VM cluster. If false, database backup on local Exadata storage is not available in the cloud VM cluster. ' type: boolean isSparseDiskgroupEnabled: description: 'If true, the sparse disk group is configured for the cloud VM cluster. If false, the sparse disk group is not created. ' type: boolean licenseModel: description: 'The Oracle license model that applies to the cloud VM cluster. The default is BRING_YOUR_OWN_LICENSE. ' enum: - LICENSE_INCLUDED - BRING_YOUR_OWN_LICENSE type: string memorySizeInGBs: description: The memory to be allocated in GBs. type: integer nsgIds: description: 'The list of [OCIDs](/Content/General/Concepts/identifiers.htm) for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see [Security Rules](/Content/Network/Concepts/securityrules.htm). ' items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array uniqueItems: true ocpuCount: description: The number of OCPU cores to enable for a cloud VM cluster. Only 1 decimal place is allowed for the fractional part. format: float minimum: 0.1 type: number x-example: 0.2 privateZoneId: description: The private zone id in which DNS records need to be created. maxLength: 255 minLength: 1 type: string recoStoragePercentage: description: 'The percentage assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). See [Storage Configuration](/Content/Database/Concepts/exaoverview.htm#Exadata) in the Exadata documentation for details on the impact of the configuration settings on storage. ' format: int32 maximum: 100 minimum: 0 type: integer 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 [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}` ' type: object sparseStoragePercentage: description: 'The percentage assigned to SPARSE storage (Exadata snapshots). See [Storage Configuration](/Content/Database/Concepts/exaoverview.htm#Exadata) in the Exadata documentation for details on the impact of the configuration settings on storage. ' format: int32 maximum: 100 minimum: 0 type: integer sshPublicKeys: description: The public key portion of one or more key pairs used for SSH access to the cloud VM cluster. items: maxLength: 1024 minLength: 1 type: string type: array subnetId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet associated with the cloud VM cluster. ' maxLength: 255 minLength: 1 type: string subscriptionId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the subscription with which resource needs to be associated with. maxLength: 255 minLength: 1 type: string systemVersion: description: Operating system version of the image. maxLength: 255 minLength: 1 type: string timeZone: description: 'The time zone to use for the cloud VM cluster. For details, see [Time Zones](/Content/Database/References/timezones.htm). ' maxLength: 255 minLength: 1 type: string vmBackupStorageType: default: - LOCAL description: Specifies the type of VM Backups Storage and supported values are LOCAL and EXASCALE. - LOCAL if selected then VM Backups storage will be on DB Servers. - EXASCALE if selected then VM Backups storage will be on Exascale Storage Servers. Default Value is LOCAL enum: - LOCAL - EXASCALE type: string vmFileSystemStorageType: default: - LOCAL description: Specifies the type of file system storage and supported values are LOCAL and EXASCALE. - LOCAL if selected then file system storage will be on DB Servers. - EXASCALE if selected then file system storage will be on Exascale Storage Servers. Default Value is LOCAL enum: - LOCAL - EXASCALE type: string required: - compartmentId - displayName - cloudExadataInfrastructureId - cpuCoreCount - sshPublicKeys - giVersion - hostname - subnetId - backupSubnetId ExternalDatabaseConnector: description: 'An Oracle Cloud Infrastructure resource used to connect to an external Oracle Database. This resource stores the database connection string, user credentials, and related details that allow you to manage your external database using the Oracle Cloud Infrastructure Console and API interfaces. ' discriminator: propertyName: connectorType properties: compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string connectionStatus: description: The status of connectivity to the external database. type: string connectorType: default: MACS description: The type of connector used by the external database resource. enum: - MACS type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object displayName: description: 'The user-friendly name for the [external database connector](#/en/database/latest/datatypes/CreateExternalDatabaseConnectorDetails). The name does not have to be unique. ' maxLength: 255 minLength: 1 type: string externalDatabaseId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external database resource. type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the [external database connector](#/en/database/latest/datatypes/CreateExternalDatabaseConnectorDetails). ' maxLength: 255 minLength: 1 type: string lifecycleDetails: description: Additional information about the current lifecycle state. type: string lifecycleState: description: The current lifecycle state of the external database connector resource. enum: - PROVISIONING - AVAILABLE - UPDATING - TERMINATING - TERMINATED - FAILED type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object timeConnectionStatusLastUpdated: description: The date and time the connectionStatus of this external connector was last updated. format: date-time type: string timeCreated: description: The date and time the external connector was created. format: date-time type: string required: - id - compartmentId - displayName - lifecycleState - timeCreated - connectorType - externalDatabaseId - connectionStatus - timeConnectionStatusLastUpdated ChangeExadbVmClusterCompartmentDetails: description: 'The configuration details for moving the Exadata VM cluster on Exascale Infrastructure to another compartment. Applies to Exadata Database Service on Exascale Infrastructure only. ' properties: compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string required: - compartmentId FileSystemConfigurationDetail: description: Details of the file system configuration of the VM cluster. properties: fileSystemSizeGb: description: The file system size to be allocated in GBs. type: integer mountPoint: description: The mount point of file system. type: string DbnodeSnapshotSummary: description: 'Details of the Exadata Database Node Snapshot. ' properties: clusterId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the VM cluster. maxLength: 255 minLength: 1 type: string compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata Database Node Snapshot. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: Additional information about the current lifecycle state of the Exadata Database Node Snapshot. type: string lifecycleState: description: The current state of the Exadata Database Storage Vault. type: string x-obmcs-enumref: '#/definitions/DbnodeSnapshot/lifecycleState' mountPoints: description: Details of the mount points items: $ref: '#/components/schemas/MountPointDetails' maxItems: 10 type: array name: description: The user-friendly name for the Database Node Snapshot. The name should be unique. maxLength: 255 minLength: 1 type: string sourceDbnodeId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata Database Node. maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object timeCreated: description: The date and time that the Exadata Database Node Snapshot was created. format: date-time type: string volumes: description: Details of the volumes items: $ref: '#/components/schemas/VolumeDetails' maxItems: 10 type: array required: - id - name - sourceDbnodeId ExternalPluggableDatabase: allOf: - $ref: '#/components/schemas/ExternalDatabaseBase' - properties: externalContainerDatabaseId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the [external container database](#/en/database/latest/datatypes/CreateExternalContainerDatabaseDetails) that contains the specified [external pluggable database](#/en/database/latest/datatypes/CreateExternalPluggableDatabaseDetails) resource. ' type: string operationsInsightsConfig: $ref: '#/components/schemas/OperationsInsightsConfig' sourceId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the the non-container database that was converted to a pluggable database to create this resource. ' type: string required: - externalContainerDatabaseId type: object description: an external Oracle pluggable database. EnableExternalDatabaseOperationsInsightsDetailsBase: description: Details to enable Operations Insights on the external database. properties: externalDatabaseConnectorId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the [external database connector](#/en/database/latest/datatypes/CreateExternalDatabaseConnectorDetails). ' maxLength: 255 minLength: 1 type: string required: - externalDatabaseConnectorId CreateDataGuardAssociationDetails: description: 'The configuration details for creating a Data Guard association between databases. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' discriminator: propertyName: creationType properties: creationType: description: 'Specifies whether to create the peer database in an existing DB system or in a new DB system. ' maxLength: 255 minLength: 1 type: string databaseAdminPassword: description: 'A strong password for the `SYS`, `SYSTEM`, and `PDB Admin` users to apply during standby creation. The password must contain no fewer than nine characters and include: * At least two uppercase characters. * At least two lowercase characters. * At least two numeric characters. * At least two special characters. Valid special characters include "_", "#", and "-" only. **The password MUST be the same as the primary admin password.** ' maxLength: 255 minLength: 1 type: string databaseSoftwareImageId: description: The database software image [OCID](/Content/General/Concepts/identifiers.htm) maxLength: 255 minLength: 1 type: string isActiveDataGuardEnabled: description: True if active Data Guard is enabled. type: boolean peerDbUniqueName: description: 'Specifies the `DB_UNIQUE_NAME` of the peer database to be created. ' maxLength: 30 minLength: 1 type: string peerSidPrefix: description: 'Specifies a prefix for the `Oracle SID` of the database to be created. ' maxLength: 12 minLength: 1 type: string protectionMode: description: 'The protection mode to set up between the primary and standby databases. For more information, see [Oracle Data Guard Protection Modes](http://docs.oracle.com/database/122/SBYDB/oracle-data-guard-protection-modes.htm#SBYDB02000) in the Oracle Data Guard documentation. **IMPORTANT** - The only protection mode currently supported by the Database service is MAXIMUM_PERFORMANCE. ' enum: - MAXIMUM_AVAILABILITY - MAXIMUM_PERFORMANCE - MAXIMUM_PROTECTION type: string sourceEncryptionKeyLocationDetails: $ref: '#/components/schemas/EncryptionKeyLocationDetails' transportType: description: 'The redo transport type to use for this Data Guard association. Valid values depend on the specified `protectionMode`: * MAXIMUM_AVAILABILITY - SYNC or FASTSYNC * MAXIMUM_PERFORMANCE - ASYNC * MAXIMUM_PROTECTION - SYNC For more information, see [Redo Transport Services](http://docs.oracle.com/database/122/SBYDB/oracle-data-guard-redo-transport-services.htm#SBYDB00400) in the Oracle Data Guard documentation. **IMPORTANT** - The only transport type currently supported by the Database service is ASYNC. ' enum: - SYNC - ASYNC - FASTSYNC type: string required: - databaseAdminPassword - protectionMode - transportType - creationType AutonomousExadataInfrastructure: allOf: - $ref: '#/components/schemas/AutonomousExadataInfrastructureSummary' ChangeCloudExadataInfrastructureSubscriptionDetails: allOf: - $ref: '#/components/schemas/ChangeSubscriptionDetails' description: 'The configuration details for associating the cloud Exadata infrastructure resource with a different subscription. ' MoveExecutionActionMemberDetails: description: 'Request to move an execution action member to an execution action resource from another. ' properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object executionActionMemberCount: description: The number of execution action member without ocids to be moved. minimum: 0 type: integer executionActionMemberId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the execution action member to be moved. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object sourceExecutionActionId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the source execution action resource. maxLength: 255 minLength: 1 type: string ExascaleDbStorageVault: description: 'Details of the Exadata Database Storage Vault. ' properties: additionalFlashCacheInPercent: description: 'The size of additional Flash Cache in percentage of High Capacity database storage. ' format: int32 minimum: 0 type: integer attachedShapeAttributes: description: 'The shapeAttribute of the Exadata VM cluster(s) associated with the Exadata Database Storage Vault. ' items: enum: - SMART_STORAGE - BLOCK_STORAGE maxItems: 2 type: string uniqueItems: true type: array autoscaleLimitInGBs: description: The maximum limit, in gigabytes, to which the Vault storage size can automatically scale when auto scaling is enabled for the Database Storage Vault type: integer availabilityDomain: description: The name of the availability domain in which the Exadata Database Storage Vault is located. maxLength: 255 minLength: 1 type: string clusterPlacementGroupId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cluster placement group of the Exadata Infrastructure. maxLength: 255 minLength: 1 type: string compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object description: description: Exadata Database Storage Vault description. maxLength: 400 minLength: 1 type: string displayName: description: The user-friendly name for the Exadata Database Storage Vault. The name does not need to be unique. maxLength: 255 minLength: 1 type: string exadataInfrastructureId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object highCapacityDatabaseStorage: $ref: '#/components/schemas/ExascaleDbStorageDetails' id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata Database Storage Vault. maxLength: 255 minLength: 1 type: string isAutoscaleEnabled: description: Indicates if autoscale feature is enabled for the Database Storage Vault. The default value is `FALSE`. type: boolean lifecycleDetails: description: Additional information about the current lifecycle state. type: string lifecycleState: description: The current state of the Exadata Database Storage Vault. enum: - PROVISIONING - AVAILABLE - UPDATING - TERMINATING - TERMINATED - FAILED type: string subscriptionId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the subscription with which resource needs to be associated with. maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object timeCreated: description: The date and time that the Exadata Database Storage Vault was created. format: date-time type: string timeZone: description: 'The time zone that you want to use for the Exadata Database Storage Vault. For details, see [Time Zones](/Content/Database/References/timezones.htm). ' maxLength: 255 minLength: 1 type: string vmClusterCount: description: 'The number of Exadata VM clusters used the Exadata Database Storage Vault. ' type: integer vmClusterIds: description: 'The List of Exadata VM cluster on Exascale Infrastructure [OCIDs](/Content/General/Concepts/identifiers.htm) **Note:** If Exadata Database Storage Vault is not used for any Exadata VM cluster on Exascale Infrastructure, this list is empty. ' items: maxLength: 255 minLength: 1 type: string type: array required: - id - compartmentId - availabilityDomain - lifecycleState - displayName - highCapacityDatabaseStorage ChangeExascaleDbStorageVaultCompartmentDetails: description: 'The configuration details for moving the Exadata Database Storage Vault to another compartment. ' properties: compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string required: - compartmentId GenerateAutonomousDatabaseWalletDetails: description: 'Details to create and download an Oracle Autonomous AI Database wallet. ' properties: generateType: default: SINGLE description: 'The type of wallet to generate. **Serverless instance usage:** * `SINGLE` - used to generate a wallet for a single database * `ALL` - used to generate wallet for all databases in the region **Dedicated Exadata infrastructure usage:** Value must be `NULL` if attribute is used. ' enum: - ALL - SINGLE type: string isRegional: description: True when requesting regional connection strings in PDB connect info, applicable to cross-region DG only. type: boolean password: description: The password to encrypt the keys inside the wallet. The password must be at least 8 characters long and must include at least 1 letter and either 1 numeric character or 1 special character. minLength: 8 type: string required: - password AutonomousContainerDatabaseBackupSummary: description: 'An Autonomous Container Database backup. To use any API operation, 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). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' properties: acdDisplayName: description: The user-friendly name for the Autonomous Container Database when the Backup was initiated. This name need not be unique. This field captures the name at the time of backup creation, accounting for possible later updates to the display name. maxLength: 255 minLength: 1 type: string autonomousContainerDatabaseId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Autonomous Container Database. maxLength: 255 minLength: 1 type: string autonomousDatabases: description: List of Autonomous AI Databases that is part of this Autonomous Container Database Backup items: $ref: '#/components/schemas/AutonomousDatabaseInBackup' type: array compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object displayName: description: A user-friendly name for the backup. This name need not be unique. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Autonomous AI Database backup. maxLength: 255 minLength: 1 type: string infrastructureType: description: The infrastructure type this resource belongs to. enum: - CLOUD - CLOUD_AT_CUSTOMER type: string isAutomatic: description: Indicates whether the backup is user-initiated or automatic. type: boolean isRemoteBackup: description: Whether backup is for remote-region or local region type: boolean lifecycleDetails: description: Additional information about the current lifecycle state. type: string lifecycleState: description: The current state of the backup. enum: - CREATING - ACTIVE - DELETING - DELETED - FAILED type: string retentionPeriodInDays: description: Retention period, in days, for long-term backups maximum: 3650 minimum: 90 type: integer systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object timeEnded: description: The date and time the backup completed. format: date-time type: string timeStarted: description: The date and time the backup started. format: date-time type: string type: description: The type of backup. enum: - INCREMENTAL - FULL type: string required: - id - compartmentId - lifecycleState - autonomousContainerDatabaseId - displayName - type - isAutomatic AddVirtualMachineToCloudVmClusterDetails: description: 'Details of adding Virtual Machines to the Cloud VM Cluster. Applies to Exadata Cloud instances only. ' properties: dbServers: description: The list of ExaCS DB servers for the cluster to be added. items: $ref: '#/components/schemas/CloudDbServerDetails' type: array required: - dbServers DataCollectionOptions: description: 'Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS. ' properties: isDiagnosticsEventsEnabled: description: 'Indicates whether diagnostic collection is enabled for the VM cluster/Cloud VM cluster/VMBM DBCS. Enabling diagnostic collection allows you to receive Events service notifications for guest VM issues. Diagnostic collection also allows Oracle to provide enhanced service and proactive support for your Exadata system. You can enable diagnostic collection during VM cluster/Cloud VM cluster provisioning. You can also disable or enable it at any time using the `UpdateVmCluster` or `updateCloudVmCluster` API. ' type: boolean isHealthMonitoringEnabled: description: 'Indicates whether health monitoring is enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling health monitoring allows Oracle to collect diagnostic data and share it with its operations and support personnel. You may also receive notifications for some events. Collecting health diagnostics enables Oracle to provide proactive support and enhanced service for your system. Optionally enable health monitoring while provisioning a system. You can also disable or enable health monitoring anytime using the `UpdateVmCluster`, `UpdateCloudVmCluster` or `updateDbsystem` API. ' type: boolean isIncidentLogsEnabled: description: 'Indicates whether incident logs and trace collection are enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling incident logs collection allows Oracle to receive Events service notifications for guest VM issues, collect incident logs and traces, and use them to diagnose issues and resolve them. Optionally enable incident logs collection while provisioning a system. You can also disable or enable incident logs collection anytime using the `UpdateVmCluster`, `updateCloudVmCluster` or `updateDbsystem` API. ' type: boolean type: object DiskPerformanceDetails: description: 'Representation of disk performance detail parameters. ' properties: diskIops: description: Disk IOPS in thousands. format: float type: number diskThroughputInMbps: description: Disk Throughput in Mbps. format: float type: number required: - diskIops - diskThroughputInMbps ExadbVmClusterUpdateHistoryEntry: allOf: - $ref: '#/components/schemas/ExadbVmClusterUpdateHistoryEntrySummary' description: 'The record of an maintenance update action on a specified Exadata VM cluster on Exascale Infrastructure. ' ChangeAutonomousDatabaseSubscriptionDetails: allOf: - $ref: '#/components/schemas/ChangeSubscriptionDetails' description: 'The configuration details for associating the Autonomous AI Database with a different subscription. ' OneoffPatchSummary: description: 'An Oracle one-off patch for a specified database version. 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). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' properties: compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string dbVersion: description: 'A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation. This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. ' type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object displayName: description: One-off patch name. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the one-off patch. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: Detailed message for the lifecycle state. type: string lifecycleState: description: The current state of the one-off patch. enum: - CREATING - AVAILABLE - UPDATING - INACTIVE - FAILED - EXPIRED - DELETING - DELETED - TERMINATING - TERMINATED type: string oneOffPatches: description: List of one-off patches for Database Homes. items: type: string type: array releaseUpdate: description: The PSU or PBP or Release Updates. To get a list of supported versions, use the [ListDbVersions](#/en/database/latest/DbVersionSummary/ListDbVersions) operation. maxLength: 255 minLength: 1 type: string sha256Sum: description: SHA-256 checksum of the one-off patch. maxLength: 320 minLength: 1 type: string sizeInKBs: description: The size of one-off patch in kilobytes. format: float type: number systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object timeCreated: description: The date and time one-off patch was created. format: date-time type: string timeOfExpiration: description: The date and time until which the one-off patch will be available for download. format: date-time type: string timeUpdated: description: The date and time one-off patch was updated. format: date-time type: string required: - id - compartmentId - displayName - dbVersion - releaseUpdate - lifecycleState - timeCreated EnableExternalPluggableDatabaseOperationsInsightsDetails: allOf: - $ref: '#/components/schemas/EnableExternalDatabaseOperationsInsightsDetailsBase' description: Details to enable Operations Insights on the external pluggable database MaintenanceRunSummary: description: 'Details of a maintenance run. ' properties: compartmentId: description: The OCID of the compartment. maxLength: 255 minLength: 1 type: string currentCustomActionTimeoutInMins: description: Extend current custom action timeout between the current database servers during waiting state, from 0 (zero) to 30 minutes. maximum: 30 minimum: 0 type: integer currentPatchingComponent: description: The name of the current infrastruture component that is getting patched. maxLength: 255 minLength: 1 type: string customActionTimeoutInMins: description: 'Determines the amount of time the system will wait before the start of each database server patching operation. Specify a number of minutes, from 15 to 120. ' maximum: 120 minimum: 15 type: integer description: description: Description of the maintenance run. maxLength: 255 minLength: 1 type: string displayName: description: The user-friendly name for the maintenance run. maxLength: 255 minLength: 1 type: string estimatedComponentPatchingStartTime: description: The estimated start time of the next infrastruture component patching operation. format: date-time type: string estimatedPatchingTime: $ref: '#/components/schemas/EstimatedPatchingTime' id: description: The OCID of the maintenance run. maxLength: 255 minLength: 1 type: string isCustomActionTimeoutEnabled: description: If true, enables the configuration of a custom action timeout (waiting period) between database servers patching operations. type: boolean isDstFileUpdateEnabled: description: Indicates if an automatic DST Time Zone file update is enabled for the Autonomous Container Database. If enabled along with Release Update, patching will be done in a Non-Rolling manner. type: boolean lifecycleDetails: description: Additional information about the current lifecycle state. type: string lifecycleState: description: 'The current state of the maintenance run. For Autonomous AI Database Serverless instances, valid states are IN_PROGRESS, SUCCEEDED, and FAILED. ' enum: - SCHEDULED - IN_PROGRESS - SUCCEEDED - SKIPPED - FAILED - UPDATING - DELETING - DELETED - CANCELED type: string maintenanceSubtype: description: Maintenance sub-type. enum: - QUARTERLY - HARDWARE - CRITICAL - INFRASTRUCTURE - DATABASE - ONEOFF - SECURITY_MONTHLY - TIMEZONE type: string maintenanceType: description: Maintenance type. enum: - PLANNED - UNPLANNED type: string patchFailureCount: description: Contain the patch failure count. type: integer patchId: description: The unique identifier of the patch. The identifier string includes the patch type, the Oracle AI Database version, and the patch creation date (using the format YYMMDD). For example, the identifier `ru_patch_19.9.0.0_201030` is used for an RU patch for Oracle AI Database 19.9.0.0 that was released October 30, 2020. maxLength: 255 minLength: 1 type: string patchingEndTime: description: The time when the patching operation ended. format: date-time type: string patchingMode: description: 'Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING. *IMPORTANT*: Non-rolling infrastructure patching involves system down time. See [Oracle-Managed Infrastructure Maintenance Updates](/iaas/Content/Database/Concepts/examaintenance.htm#Oracle) for more information. ' enum: - ROLLING - NONROLLING type: string patchingStartTime: description: The time when the patching operation started. format: date-time type: string patchingStatus: description: The status of the patching operation. enum: - PATCHING - WAITING - SCHEDULED type: string peerMaintenanceRunId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the maintenance run for the Autonomous Data Guard association's peer container database. maxLength: 255 minLength: 1 type: string peerMaintenanceRunIds: description: The list of OCIDs for the maintenance runs associated with their Autonomous Data Guard peer container databases. items: maxLength: 255 minLength: 1 type: string maxItems: 32 type: array referenceResourceIdForImageUpdates: description: "The [OCID](/Content/General/Concepts/identifiers.htm) of the resource the maintenance run will refer to when trying to fetch target versions.\nThis field is set during maintenance run creation based on infrastructure's maintenance run version preferences. \nCurrently this is only be supported for monthly maintenance runs created via scheduling plans.\n" maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object targetDbServerVersion: description: The target software version for the database server patching operation. maxLength: 255 minLength: 1 type: string targetResourceId: description: The ID of the target resource on which the maintenance run occurs. maxLength: 255 minLength: 1 type: string targetResourceType: description: The type of the target resource on which the maintenance run occurs. enum: - AUTONOMOUS_EXADATA_INFRASTRUCTURE - AUTONOMOUS_CONTAINER_DATABASE - EXADATA_DB_SYSTEM - CLOUD_EXADATA_INFRASTRUCTURE - EXACC_INFRASTRUCTURE - AUTONOMOUS_VM_CLUSTER - AUTONOMOUS_DATABASE - CLOUD_AUTONOMOUS_VM_CLUSTER type: string targetStorageServerVersion: description: The target Cell version that is to be patched to. maxLength: 255 minLength: 1 type: string timeEnded: description: The date and time the maintenance run was completed. format: date-time type: string timeScheduled: description: The date and time the maintenance run is scheduled to occur. format: date-time type: string timeStarted: description: The date and time the maintenance run starts. format: date-time type: string required: - id - compartmentId - displayName - lifecycleState - timeScheduled type: object DbSystemOptions: description: The DB system options. properties: storageManagement: default: ASM description: 'The storage option used in DB system. ASM - Automatic storage management LVM - Logical Volume management ' enum: - ASM - LVM type: string type: object CreateScheduledActionDetails: description: 'Request to create Scheduled Action resource. ' properties: actionMembers: description: The list of action members in a scheduled action. items: $ref: '#/components/schemas/ActionMember' maxItems: 200 type: array actionOrder: description: The array of [OCID](/Content/General/Concepts/identifiers.htm) of the Scheduled Action and order paris. items: maxLength: 1024 minLength: 1 type: string maxItems: 200 type: array actionParams: additionalProperties: type: string description: 'Map where a key value pair describes the specific action parameter. Example: `{"count": "3"}` ' maxProperties: 100 type: object actionType: default: DB_SERVER_FULL_SOFTWARE_UPDATE description: The type of the scheduled action being performed enum: - DB_SERVER_FULL_SOFTWARE_UPDATE - STORAGE_SERVER_FULL_SOFTWARE_UPDATE - NETWORK_SWITCH_FULL_SOFTWARE_UPDATE - DB_SERVER_ONLINE_SOFTWARE_UPDATE type: string compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object schedulingPlanId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Scheduling Plan. maxLength: 255 minLength: 1 type: string schedulingWindowId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Scheduling Window. maxLength: 255 minLength: 1 type: string required: - actionOrder - actionType - schedulingWindowId - schedulingPlanId - compartmentId UpdateExternalContainerDatabaseDetails: allOf: - $ref: '#/components/schemas/UpdateExternalDatabaseDetailsBase' description: 'Details for updating an external container database. This API is not currently supported. ' ExascaleDbStorageInputDetails: description: 'Create exadata Database Storage Details ' properties: totalSizeInGbs: description: 'Total Capacity ' format: int32 type: integer required: - totalSizeInGbs UpdateBackupDestinationDetails: description: 'For a RECOVERY_APPLIANCE backup destination, used to update the connection string and/or the list of VPC users. For an NFS backup destination, there are 2 mount types - Self mount used for non-autonomous ExaCC and automated mount used for autonomous on ExaCC. ' properties: connectionString: description: For a RECOVERY_APPLIANCE backup destination, the connection string for connecting to the Recovery Appliance. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object localMountPointPath: description: 'The local directory path on each VM cluster node where the NFS server location is mounted. The local directory path and the NFS server location must each be the same across all of the VM cluster nodes. Ensure that the NFS mount is maintained continuously on all of the VM cluster nodes. ' type: string nfsMountType: description: NFS Mount type for backup destination. enum: - SELF_MOUNT - AUTOMATED_MOUNT type: string nfsServer: description: IP addresses for NFS Auto mount. items: type: string maxItems: 4 minItems: 1 type: array nfsServerExport: description: Specifies the directory on which to mount the file system type: string vpcUsers: description: For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) users that are used to access the Recovery Appliance. items: type: string maxItems: 50 type: array ExecuteDbSystemOsPatchDetails: description: 'Request details for submitting an operating system (OS) patch action on a DB system. Use PRECHECK to validate prerequisites and surface the expected changes without applying them. Use APPLY to install the selected updates. Some updates may require a reboot to take effect. ' properties: action: description: 'Operation system (OS) patch action to perform * PRECHECK: No changes applied; runs validation/dry run. * APPLY: Installs updates; may require a reboot (see OS patch history entry details to determine isRebootRequired). ' enum: - PRECHECK - APPLY type: string dbNodeId: description: The OCID of the DB node to target for this patch action. If omitted, the action applies to all nodes in the DB system. maxLength: 255 minLength: 1 type: string required: - action type: object DatabaseUpgradeHistoryEntry: allOf: - $ref: '#/components/schemas/DatabaseUpgradeHistoryEntrySummary' description: 'The Database service supports the upgrade history of databases. To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm). For information about access control and compartments, see [Overview of the Identity Service](/Content/Identity/Concepts/overview.htm). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' CloudDbServerDetails: description: 'Details of the ExaDB-D DB server. Applies to Exadata Cloud instances only. ' properties: dbServerId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of ExaDB-D DB server. maxLength: 255 minLength: 1 type: string required: - dbServerId ExecutionActionMember: description: 'The action member details. ' properties: estimatedTimeInMins: description: The estimated time of the execution action member in minutes. minimum: 0 type: integer memberId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the parent resource the execution action belongs to. maxLength: 255 minLength: 1 type: string memberOrder: description: The priority order of the execution action member. minimum: 1 type: integer status: description: 'The current status of the execution action member. Valid states are SCHEDULED, IN_PROGRESS, FAILED, CANCELED, DURATION_EXCEEDED, RESCHEDULED and COMPLETED. enum: - SCHEDULED - IN_PROGRESS - FAILED - CANCELED - DURATION_EXCEEDED - RESCHEDULED - SUCCEEDED ' type: string required: - memberOrder - memberId LocalClonePluggableDatabaseDetails: description: '**Deprecated.** Use [CreatePluggableDatabaseDetails\](#/en/database/latest/datatypes/CreatePluggableDatabaseDetails) for Pluggable Database LocalClone Operation. Parameters for cloning a pluggable database (PDB) within the same database (CDB). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' properties: clonedPdbName: description: The name for the pluggable database (PDB). The name is unique in the context of a [container database](#/en/database/latest/Database/). The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. The pluggable database name should not be same as the container database name. maxLength: 30 minLength: 1 type: string pdbAdminPassword: description: A strong password for PDB Admin of the newly cloned PDB. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numbers, and two special characters. The special characters must be _, \#, or -. maxLength: 255 minLength: 1 type: string x-default-description: 'null' shouldPdbAdminAccountBeLocked: default: false description: 'The locked mode of the pluggable database admin account. If false, the user needs to provide the PDB Admin Password to connect to it. If true, the pluggable database will be locked and user cannot login to it. ' type: boolean targetTdeWalletPassword: description: The existing TDE wallet password of the target CDB. maxLength: 255 minLength: 1 type: string x-default-description: 'null' required: - clonedPdbName NetworkBondingModeDetails: description: 'Details of bonding mode for Client and Backup and DR networks of an Exadata infrastructure. ' properties: backupNetworkBondingMode: default: - ACTIVE_BACKUP description: The network bonding mode for the Exadata infrastructure. enum: - ACTIVE_BACKUP - LACP type: string clientNetworkBondingMode: default: - ACTIVE_BACKUP description: The network bonding mode for the Exadata infrastructure. enum: - ACTIVE_BACKUP - LACP type: string drNetworkBondingMode: default: - ACTIVE_BACKUP description: The network bonding mode for the Exadata infrastructure. enum: - ACTIVE_BACKUP - LACP type: string type: object AutonomousVmCluster: allOf: - $ref: '#/components/schemas/AutonomousVmClusterSummary' description: 'Details of the Autonomous VM cluster. ' SystemVersionMinorVersionCollection: description: Results of the System minor version lists. Contains SystemVersionMinorVersionSummary items. properties: items: description: List of System minor versions. items: $ref: '#/components/schemas/SystemVersionMinorVersionSummary' maxItems: 50 type: array required: - items StopAutonomousDatabaseDetails: description: Request details to stop an Autonomous Database with force option. properties: isForceStop: description: If set to `true`, stops the Autonomous Database with force option. type: boolean type: object CloudVmClusterSummary: description: 'Details of the cloud VM cluster. Applies to Exadata Cloud Service instances only. ' properties: availabilityDomain: description: The name of the availability domain that the cloud Exadata infrastructure resource is located in. maxLength: 255 minLength: 1 type: string backupNetworkNsgIds: description: 'A list of the [OCIDs](/Content/General/Concepts/identifiers.htm) of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see [Security Rules](/Content/Network/Concepts/securityrules.htm). Applicable only to Exadata systems. ' items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array uniqueItems: true backupSubnetId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the backup network subnet associated with the cloud VM cluster. **Subnet Restriction:** See the subnet restrictions information for **subnetId**. ' maxLength: 255 minLength: 1 type: string cloudExadataInfrastructureId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud Exadata infrastructure. maxLength: 255 minLength: 1 type: string clusterName: description: 'The cluster name for cloud VM cluster. The cluster name must begin with an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive. ' type: string compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string computeModel: description: 'The compute model of the Base Database, Exadata Infrastructure, VM Cluster and Autonomous AI Database. ' enum: - ECPU - OCPU type: string x-default-description: Null used when unspecified. cpuCoreCount: description: The number of CPU cores enabled on the cloud VM cluster. format: int32 type: integer dataCollectionOptions: $ref: '#/components/schemas/DataCollectionOptions' dataStoragePercentage: description: 'The percentage assigned to DATA storage (user data and database files). See [Storage Configuration](/Content/Database/Concepts/exaoverview.htm#Exadata) in the Exadata documentation for details on the impact of the configuration settings on storage. ' format: int32 maximum: 100 minimum: 0 type: integer dataStorageSizeInTBs: description: The data disk group size to be allocated in TBs. format: double type: number dbNodeStorageSizeInGBs: description: The local node storage to be allocated in GBs. type: integer dbServers: description: The list of DB servers. items: maxLength: 1024 minLength: 1 type: string type: array definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object diskRedundancy: description: 'The type of redundancy configured for the cloud Vm cluster. NORMAL is 2-way redundancy. HIGH is 3-way redundancy. ' enum: - HIGH - NORMAL type: string displayName: description: The user-friendly name for the cloud VM cluster. The name does not need to be unique. maxLength: 255 minLength: 1 type: string domain: description: The domain name for the cloud VM cluster. type: string exascaleDbStorageVaultId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata Database Storage Vault. maxLength: 255 minLength: 1 type: string fileSystemConfigurationDetails: description: Details of the file system configuration of the VM cluster. items: $ref: '#/components/schemas/FileSystemConfigurationDetail' maxItems: 1024 type: array freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object giSoftwareImageId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of a grid infrastructure software image. This is a database software image of the type `GRID_IMAGE`. maxLength: 255 type: string giVersion: description: A valid Oracle Grid Infrastructure (GI) software version. maxLength: 255 minLength: 1 type: string hostname: description: The hostname for the cloud VM cluster. type: string id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud VM cluster. maxLength: 255 minLength: 1 type: string isLocalBackupEnabled: description: 'If true, database backup on local Exadata storage is configured for the cloud VM cluster. If false, database backup on local Exadata storage is not available in the cloud VM cluster. ' type: boolean isSparseDiskgroupEnabled: description: 'If true, sparse disk group is configured for the cloud VM cluster. If false, sparse disk group is not created. ' type: boolean lastUpdateHistoryEntryId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the last maintenance update history entry. This value is updated when a maintenance update starts. maxLength: 255 minLength: 1 type: string licenseModel: description: 'The Oracle license model that applies to the cloud VM cluster. The default is LICENSE_INCLUDED. ' enum: - LICENSE_INCLUDED - BRING_YOUR_OWN_LICENSE type: string lifecycleDetails: description: Additional information about the current lifecycle state. type: string lifecycleState: description: The current state of the cloud VM cluster. enum: - PROVISIONING - AVAILABLE - UPDATING - TERMINATING - TERMINATED - FAILED - MAINTENANCE_IN_PROGRESS type: string listenerPort: description: The port number configured for the listener on the cloud VM cluster. format: int64 type: integer memorySizeInGBs: description: The memory to be allocated in GBs. type: integer multiCloudIdentityConnectorConfigs: description: Details of the multi cloud identity connectors of the VM cluster. items: $ref: '#/components/schemas/IdentityConnectorDetails' maxItems: 10 type: array nodeCount: description: 'The number of nodes in the cloud VM cluster. ' format: int32 minimum: 1 type: integer nsgIds: description: 'The list of [OCIDs](/Content/General/Concepts/identifiers.htm) for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see [Security Rules](/Content/Network/Concepts/securityrules.htm). ' items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array uniqueItems: true ocpuCount: description: The number of OCPU cores to enable on the cloud VM cluster. Only 1 decimal place is allowed for the fractional part. format: float minimum: 0.1 type: number x-example: 0.2 recoStoragePercentage: description: 'The percentage assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). See [Storage Configuration](/Content/Database/Concepts/exaoverview.htm#Exadata) in the Exadata documentation for details on the impact of the configuration settings on storage. ' format: int32 maximum: 100 minimum: 0 type: integer scanDnsName: description: 'The FQDN of the DNS record for the SCAN IP addresses that are associated with the cloud VM cluster. ' maxLength: 72 minLength: 1 type: string scanDnsRecordId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the DNS record for the SCAN IP addresses that are associated with the cloud VM cluster. ' maxLength: 255 minLength: 1 type: string scanIpIds: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Single Client Access Name (SCAN) IPv4 addresses associated with the cloud VM cluster. SCAN IPv4 addresses are typically used for load balancing and are not assigned to any interface. Oracle Clusterware directs the requests to the appropriate nodes in the cluster. **Note:** For a single-node DB system, this list is empty. ' items: maxLength: 255 minLength: 1 type: string type: array scanIpv6Ids: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Single Client Access Name (SCAN) IPv6 addresses associated with the cloud VM cluster. SCAN IPv6 addresses are typically used for load balancing and are not assigned to any interface. Oracle Clusterware directs the requests to the appropriate nodes in the cluster. **Note:** For a single-node DB system, this list is empty. ' items: maxLength: 255 minLength: 1 type: string type: array 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 [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}` ' type: object shape: description: 'The model name of the Exadata hardware running the cloud VM cluster. ' maxLength: 255 minLength: 1 type: string sparseStoragePercentage: description: 'The percentage assigned to SPARSE storage (Exadata snapshots). See [Storage Configuration](/Content/Database/Concepts/exaoverview.htm#Exadata) in the Exadata documentation for details on the impact of the configuration settings on storage. ' format: int32 maximum: 100 minimum: 0 type: integer sshPublicKeys: description: The public key portion of one or more key pairs used for SSH access to the cloud VM cluster. items: maxLength: 1024 minLength: 1 type: string type: array storageManagementType: description: Specifies the type of storage management for the Cloud VM Cluster if its ASM or Exascale. enum: - ASM - EXASCALE type: string storageSizeInGBs: description: The storage allocation for the disk group, in gigabytes (GB). format: int32 type: integer subnetId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet associated with the cloud VM cluster. **Subnet Restrictions:** - For Exadata and virtual machine 2-node RAC systems, do not use a subnet that overlaps with 192.168.128.0/20. These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and backup subnet. ' maxLength: 255 minLength: 1 type: string subscriptionId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the subscription with which resource needs to be associated with. maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object systemVersion: description: Operating system version of the image. maxLength: 255 minLength: 1 type: string tdeKeyStoreType: description: TDE keystore type enum: - AZURE - OCI type: string x-default-description: 'null' timeCreated: description: The date and time that the cloud VM cluster was created. format: date-time type: string timeZone: description: The time zone of the cloud VM cluster. For details, see [Exadata Infrastructure Time Zones](/Content/Database/References/timezones.htm). maxLength: 255 minLength: 1 type: string vipIds: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the virtual IP (VIP) IPv4 addresses associated with the cloud VM cluster. The Cluster Ready Services (CRS) creates and maintains one VIP IPv4 address for each node in the Exadata Cloud Service instance to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster. **Note:** For a single-node DB system, this list is empty. ' items: maxLength: 255 minLength: 1 type: string type: array vipv6Ids: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the virtual IP (VIP) IPv6 addresses associated with the cloud VM cluster. The Cluster Ready Services (CRS) creates and maintains one VIP IPv6 address for each node in the Exadata Cloud Service instance to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster. **Note:** For a single-node DB system, this list is empty. ' items: maxLength: 255 minLength: 1 type: string type: array vmBackupStorageType: description: Specifies the type of VM Backups Storage and supported values are LOCAL and EXASCALE. - LOCAL if selected then VM Backups storage will be on DB Servers. - EXASCALE if selected then VM Backups storage will be on Exascale Storage Servers. Default Value is LOCAL enum: - LOCAL - EXASCALE type: string vmFileSystemStorageType: description: Specifies the type of file system storage and supported values are LOCAL and EXASCALE. - LOCAL if selected then file system storage will be on DB Servers. - EXASCALE if selected then file system storage will be on Exascale Storage Servers. Default Value is LOCAL enum: - LOCAL - EXASCALE type: string zoneId: description: 'The OCID of the zone the cloud VM cluster is associated with. ' maxLength: 255 minLength: 1 type: string required: - id - cloudExadataInfrastructureId - compartmentId - lifecycleState - displayName - availabilityDomain - subnetId - sshPublicKeys - cpuCoreCount - hostname - domain - shape DisasterRecoveryConfiguration: description: Configurations of a Disaster Recovery. properties: disasterRecoveryType: description: 'Indicates the disaster recovery (DR) type of the Autonomous AI Database Serverless instance. Autonomous Data Guard (ADG) DR type provides business critical DR with a faster recovery time objective (RTO) during failover or switchover. Backup-based DR type provides lower cost DR with a slower RTO during failover or switchover. ' enum: - ADG - BACKUP_BASED type: string isReplicateAutomaticBackups: description: If true, 7 days worth of backups are replicated across regions for Cross-Region ADB or Backup-Based DR between Primary and Standby. If false, the backups taken on the Primary are not replicated to the Standby database. type: boolean isSnapshotStandby: description: 'Indicates if user wants to convert to a snapshot standby. For example, true would set a standby database to snapshot standby database. False would set a snapshot standby database back to regular standby database. ' type: boolean timeSnapshotStandbyEnabledTill: description: Time and date stored as an RFC 3339 formatted timestamp string. For example, 2022-01-01T12:00:00.000Z would set a limit for the snapshot standby to be converted back to a cross-region standby database. format: date-time type: string UpdateDatabaseSoftwareImageDetails: description: 'Describes the parameters for updating the Database Software Image ' properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object displayName: description: The user-friendly name for the database software image. The name does not have to be unique. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object MaintenanceWindow: description: 'The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window. ' properties: customActionTimeoutInMins: description: 'Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive). ' maximum: 120 minimum: 15 type: integer daysOfWeek: description: Days during the week when maintenance should be performed. items: $ref: '#/components/schemas/DayOfWeek' type: array uniqueItems: true hoursOfDay: description: The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are - 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC items: maximum: 20 minimum: 0 type: integer type: array uniqueItems: true isCustomActionTimeoutEnabled: description: If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations. type: boolean leadTimeInWeeks: description: 'Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4. ' maximum: 4 minimum: 1 type: integer months: description: Months during the year when maintenance should be performed. items: $ref: '#/components/schemas/Month' type: array uniqueItems: true patchingMode: description: 'Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING. *IMPORTANT*: Non-rolling infrastructure patching involves system down time. See [Oracle-Managed Infrastructure Maintenance Updates](/iaas/Content/Database/Concepts/examaintenance.htm#Oracle) for more information. ' enum: - ROLLING - NONROLLING type: string preference: default: NO_PREFERENCE description: The maintenance window scheduling preference. enum: - NO_PREFERENCE - CUSTOM_PREFERENCE type: string skipRu: description: 'If true, skips the release update (RU) for the quarter. You cannot skip two consecutive quarters. An RU skip request will only be honoured if the current version of the Autonomous Container Database is supported for current quarter. ' items: type: boolean type: array weeksOfMonth: description: 'Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed. ' items: maximum: 4 minimum: 1 type: integer type: array uniqueItems: true UpdateAutonomousDatabaseSoftwareImageDetails: description: 'Describes the parameters for updating the Autonomous AI Database Software Image ' properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object CreateDbHomeBase: description: 'Details for creating a Database Home. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' discriminator: propertyName: source properties: databaseSoftwareImageId: description: The database software image [OCID](/Content/General/Concepts/identifiers.htm) maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object displayName: description: The user-provided name of the Database Home. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object isDesupportedVersion: description: If true, the customer acknowledges that the specified Oracle Database software is an older release that is not currently supported by OCI. type: boolean kmsKeyId: description: The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. maxLength: 255 minLength: 1 type: string kmsKeyVersionId: description: 'The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous AI Database Serverless does not use key versions, hence is not applicable for Autonomous AI Database Serverless instances. ' maxLength: 255 minLength: 1 type: string source: default: NONE description: 'The source of database: NONE for creating a new database. DB_BACKUP for creating a new database by restoring from a database backup. ' enum: - NONE - DB_BACKUP - DATABASE - VM_CLUSTER_BACKUP - VM_CLUSTER_NEW - VM_CLUSTER_DATABASE type: string AutonomousDatabaseConnectionStrings: description: "Connection strings to connect to an Oracle Autonomous AI Database.\n\nExample output for connection strings. See [DatabaseConnectionStringProfile](#/en/database/latest/datatypes/DatabaseConnectionStringProfile) for additional details:\n\n \"connectionStrings\": {\n \"allConnectionStrings\": {\n \"HIGH\": \"adb.region.oraclecloud.com:1522/unique_id_databasename_high.adwc.oraclecloud.com\",\n \"LOW\": \"adb.region.oraclecloud.com:1522/unique_id_databasename_low.adwc.oraclecloud.com\",\n \"MEDIUM\": \"adb.region.oraclecloud.com:1522/unique_id_databasename_medium.adwc.oraclecloud.com\"\n },\n \"profiles\": [\n {\n \"displayName\": \"databasename_high\",\n \"value\": \"(description= (retry_count=20)(retry_delay=3)(address=(protocol=tcps)(port=1522)(host=adb.region.oraclecloud.com))(connect_data=(service_name=unique_id_databasename_high.adwc.oraclecloud.com))(security=(ssl_server_cert_dn=\"CN=adwc.uscom-east-1.oraclecloud.com,OU=Oracle BMCS US,O=Oracle Corporation,L=Redwood City,ST=California,C=US\")))\",\n \"consumerGroup\": \"HIGH\",\n \"protocol\": \"TCPS\",\n \"tlsAuthentication\": \"MUTUAL\",\n \"hostFormat\": \"FQDN\",\n \"sessionMode\": \"DIRECT\",\n \"syntaxFormat\": \"LONG\"\n },\n {\n \"displayName\": \"databasename_low\",\n \"value\": \"(description= (retry_count=20)(retry_delay=3)(address=(protocol=tcps)(port=1522)(host=adb.region.oraclecloud.com))(connect_data=(service_name=unique_id_databasename_low.adwc.oraclecloud.com))(security=(ssl_server_cert_dn=\"CN=adwc.uscom-east-1.oraclecloud.com,OU=Oracle BMCS US,O=Oracle Corporation,L=Redwood City,ST=California,C=US\")))\",\n \"consumerGroup\": \"LOW\",\n \"protocol\": \"TCPS\",\n \"tlsAuthentication\": \"MUTUAL\",\n \"hostFormat\": \"FQDN\",\n \"sessionMode\": \"DIRECT\",\n \"syntaxFormat\": \"LONG\"\n },\n {\n \"displayName\": \"databasename_medium\",\n \"value\": \"(description= (retry_count=20)(retry_delay=3)(address=(protocol=tcps)(port=1522)(host=adb.region.oraclecloud.com))(connect_data=(service_name=unique_id_databasename_medium.adwc.oraclecloud.com))(security=(ssl_server_cert_dn=\"CN=adwc.uscom-east-1.oraclecloud.com,OU=Oracle BMCS US,O=Oracle Corporation,L=Redwood City,ST=California,C=US\")))\",\n \"consumerGroup\": \"MEDIUM\",\n \"protocol\": \"TCPS\",\n \"tlsAuthentication\": \"MUTUAL\",\n \"hostFormat\": \"FQDN\",\n \"sessionMode\": \"DIRECT\",\n \"syntaxFormat\": \"LONG\"\n }\n ],\n \"dedicated\": null,\n \"high\": \"adb.region.oraclecloud.com:1522/unique_id_databasename_high.adwc.oraclecloud.com\",\n \"low\": \"adb.region.oraclecloud.com:1522/unique_id_databasename_low.adwc.oraclecloud.com\",\n \"medium\": \"adb.region.oraclecloud.com:1522/unique_id_databasename_medium.adwc.oraclecloud.com\"\n }\n" properties: allConnectionStrings: additionalProperties: type: string description: 'Returns all connection strings that can be used to connect to the Autonomous AI Database. For more information, please see [Predefined Database Service Names for Autonomous AI Transaction Processing](https://docs.oracle.com/en/cloud/paas/atp-cloud/atpug/connect-predefined.html#GUID-9747539B-FD46-44F1-8FF8-F5AC650F15BE) ' type: object dedicated: description: The database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements. maxLength: 255 minLength: 10 type: string high: description: The High database service provides the highest level of resources to each SQL statement resulting in the highest performance, but supports the fewest number of concurrent SQL statements. maxLength: 255 minLength: 10 type: string low: description: The Low database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements. maxLength: 255 minLength: 10 type: string medium: description: The Medium database service provides a lower level of resources to each SQL statement potentially resulting a lower level of performance, but supports more concurrent SQL statements. maxLength: 255 minLength: 10 type: string profiles: description: 'A list of connection string profiles to allow clients to group, filter and select connection string values based on structured metadata. ' items: $ref: '#/components/schemas/DatabaseConnectionStringProfile' type: array type: object CreateMaintenanceRunDetails: description: 'Details to schedule Maintenance Run with Latest Release Update along TimeZone File Update for the specified resource. ' properties: compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment containing the Maintenance Run. maxLength: 255 minLength: 1 type: string isDstFileUpdateEnabled: description: Indicates if an automatic DST Time Zone file update is enabled for the Autonomous Container Database. If enabled along with Release Update, patching will be done in a Non-Rolling manner. type: boolean patchType: description: 'Patch type, either "QUARTERLY" or "TIMEZONE". ' enum: - QUARTERLY - TIMEZONE type: string patchingMode: description: 'Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING. *IMPORTANT*: Non-rolling infrastructure patching involves system down time. See [Oracle-Managed Infrastructure Maintenance Updates](/iaas/Content/Database/Concepts/examaintenance.htm#Oracle) for more information. ' enum: - ROLLING - NONROLLING type: string targetResourceId: description: The ID of the target resource for which the maintenance run should be created. maxLength: 255 minLength: 1 type: string timeScheduled: description: The date and time that update should be scheduled. format: date-time type: string required: - targetResourceId - timeScheduled - patchType ExecutionActionSummary: description: 'Details of an execution action. ' properties: actionMembers: description: List of action members of this execution action. items: $ref: '#/components/schemas/ExecutionActionMember' maxItems: 200 type: array actionParams: additionalProperties: type: string description: 'Map where a key value pair describes the specific action parameter. Example: `{"count": "3"}` ' maxProperties: 100 type: object actionType: description: The action type of the execution action being performed enum: - DB_SERVER_FULL_SOFTWARE_UPDATE - STORAGE_SERVER_FULL_SOFTWARE_UPDATE - NETWORK_SWITCH_FULL_SOFTWARE_UPDATE - DB_SERVER_ONLINE_SOFTWARE_UPDATE type: string compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object description: description: Description of the execution action. maxLength: 255 minLength: 1 type: string displayName: description: The user-friendly name for the execution action. The name does not need to be unique. maxLength: 255 minLength: 1 type: string estimatedTimeInMins: description: The estimated time of the execution action in minutes. minimum: 0 type: integer executionActionOrder: description: The priority order of the execution action. minimum: 1 type: integer executionWindowId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the execution window resource the execution action belongs to. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the execution action. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: Additional information about the current lifecycle state. type: string lifecycleState: description: 'The current state of the execution action. Valid states are SCHEDULED, IN_PROGRESS, FAILED, CANCELED, UPDATING, DELETED, SUCCEEDED and PARTIAL_SUCCESS. ' enum: - SCHEDULED - IN_PROGRESS - FAILED - CANCELED - UPDATING - DELETED - SUCCEEDED - PARTIAL_SUCCESS type: string lifecycleSubstate: description: 'The current sub-state of the execution action. Valid states are DURATION_EXCEEDED, MAINTENANCE_IN_PROGRESS and WAITING. ' enum: - DURATION_EXCEEDED - MAINTENANCE_IN_PROGRESS - WAITING type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object timeCreated: description: The date and time the execution action was created. format: date-time type: string timeUpdated: description: The last date and time that the execution action was updated. format: date-time type: string required: - id - compartmentId - displayName - lifecycleState - executionWindowId - actionType - actionParams type: object WindowPreferenceDetail: description: 'The Single Scheduling Window details. ' properties: daysOfWeek: description: Days during the week when scheduling window should be performed. items: $ref: '#/components/schemas/DayOfWeek' type: array uniqueItems: true duration: description: 'Duration window allows user to set a duration they plan to allocate for Scheduling window. The duration is in minutes. ' minimum: 120 type: integer isEnforcedDuration: default: false description: Indicates if duration the user plans to allocate for scheduling window is strictly enforced. The default value is `FALSE`. type: boolean months: description: Months during the year when scheduled window should be performed. items: $ref: '#/components/schemas/Month' type: array uniqueItems: true startTime: description: The scheduling window start time. The value must use the ISO-8601 format "hh:mm". maxLength: 50 minLength: 1 type: string weeksOfMonth: description: 'Weeks during the month when scheduled window should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow scheduling window during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Scheduling window cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and startTime parameters to allow you to specify specific days of the week and hours that scheduled window will be performed. ' items: maximum: 4 minimum: 1 type: integer type: array uniqueItems: true required: - weeksOfMonth - daysOfWeek - startTime - duration - isEnforcedDuration ReinstateDataGuardAssociationDetails: description: 'The Data Guard association reinstate parameters. ' properties: databaseAdminPassword: description: The DB system administrator password. maxLength: 255 minLength: 1 type: string required: - databaseAdminPassword ExecutionAction: allOf: - $ref: '#/components/schemas/ExecutionActionSummary' description: 'Details of an execution action. ' ActivateExadataInfrastructureDetails: description: 'The activation details for the Exadata Cloud@Customer infrastructure. Applies to Exadata Cloud@Customer instances only. ' properties: activationFile: description: The activation zip file. format: byte type: string required: - activationFile PeerAutonomousContainerDatabaseBackupConfig: description: 'Backup options for the standby Autonomous Container Database. ' properties: backupDestinationDetails: description: Backup destination details. items: $ref: '#/components/schemas/BackupDestinationDetails' type: array recoveryWindowInDays: description: 'Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups. If the number of specified days is 0 then there will be no backups. ' maximum: 95 minimum: 0 type: integer CloudAutonomousVmClusterResourceDetails: description: Unallocated resource details of the Cloud Autonomous VM Cluster. properties: id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Cloud Exadata infrastructure. maxLength: 255 minLength: 1 type: string unAllocatedAdbStorageInTBs: description: Total unallocated autonomous data storage in the Cloud Autonomous VM Cluster in TBs. format: double type: number required: - id - unAllocatedAdbStorageInTBs ExascaleConfigDetails: description: 'The exascale config response details for the Exadata Cloud@Customer infrastructure or cloud Exadata infrastructure . Applies to both Exadata Cloud@Customer instances and Exadata Cloud Service instances. ' properties: availableStorageInGBs: description: Available storage size for Exascale in GBs. type: integer totalStorageInGBs: description: Storage size needed for Exascale in GBs. type: integer required: - totalStorageInGBs RemoteClonePluggableDatabaseDetails: allOf: - $ref: '#/components/schemas/LocalClonePluggableDatabaseDetails' - properties: sourceContainerDbAdminPassword: description: The DB system administrator password of the source CDB. maxLength: 255 minLength: 1 type: string targetContainerDatabaseId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the target CDB maxLength: 255 minLength: 1 type: string required: - targetContainerDatabaseId - sourceContainerDbAdminPassword type: object description: '**Deprecated.** Use [CreatePluggableDatabaseDetails\](#/en/database/latest/datatypes/CreatePluggableDatabaseDetails) for Pluggable Database RemoteClone Operation. Parameters for cloning a pluggable database (PDB) in a remote database (CDB). A remote CDB is one that does not contain the source PDB. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' UpdateSchedulingWindowDetails: description: 'Describes the modification parameters for the Scheduling Window. ' properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object windowPreference: $ref: '#/components/schemas/WindowPreferenceDetail' BackupDestinationDetails: description: Backup destination details properties: backupRetentionPolicyOnTerminate: default: RETAIN_FOR_72_HOURS description: "Defines the automatic and manual backup retention policy for the Autonomous AI Database termination. \nThe retention policy set on the Autonomous Container Database is not applicable for cross region remote backups and backups hosted on recovery Appliance backup destination.\nOptions are 'RETAIN_PER_RETENTION_WINDOW' or 'RETAIN_FOR_72_HOURS'.The default value is 'RETAIN_FOR_72_HOURS'.\n" enum: - RETAIN_PER_RETENTION_WINDOW - RETAIN_FOR_72_HOURS type: string dbrsPolicyId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the DBRS policy used for backup. maxLength: 255 minLength: 1 type: string id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the backup destination. maxLength: 255 minLength: 1 type: string internetProxy: description: Proxy URL to connect to object store. type: string isRemote: default: false description: Indicates whether the backup destination is cross-region or local. type: boolean isRetentionLockEnabled: description: 'Indicates if backup retention is locked for all the database backups in the Autonomous Container Database (ACD). The retention window cannot be decreased if the backup retention lock is enabled. Once applied on the Autonomous Container Database, the retention lock cannot be removed, or the retention period cannot be decreased after a 14-day period. If the backup is a Long Term Backup and retention lock is enabled, the backup cannot be deleted and must expire. The retention lock set on the Autonomous Container Database is not applicable for cross region remote backups and backups hosted on recovery Appliance backup destination. ' type: boolean remoteRegion: description: "The name of the remote region where the remote automatic incremental backups will be stored. \nFor information about valid region names, see\n[Regions and Availability Domains](/Content/General/Concepts/regions.htm).\n" maxLength: 50 minLength: 1 type: string type: description: Type of the database backup destination. enum: - NFS - RECOVERY_APPLIANCE - OBJECT_STORE - LOCAL - DBRS - AWS type: string vpcPassword: description: For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance. type: string vpcUser: description: For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance. type: string required: - type CreateSchedulingPlanDetails: description: 'Request to create Scheduling Plan. ' properties: compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object isUsingRecommendedScheduledActions: description: If true, recommended scheduled actions will be generated for the scheduling plan. type: boolean planIntent: default: EXADATA_INFRASTRUCTURE_FULL_SOFTWARE_UPDATE description: The current intent of the Scheduling Plan. Valid states are EXADATA_INFRASTRUCTURE_FULL_SOFTWARE_UPDATE and EXADATA_INFRASTRUCTURE_SECURITY_UPDATE. enum: - EXADATA_INFRASTRUCTURE_FULL_SOFTWARE_UPDATE - EXADATA_INFRASTRUCTURE_SECURITY_UPDATE type: string resourceId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the resource. maxLength: 255 minLength: 1 type: string schedulingPolicyId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Scheduling Policy. maxLength: 255 minLength: 1 type: string serviceType: description: The service type of the Scheduling Plan. enum: - EXACC - EXACS - FPPPCS type: string required: - schedulingPolicyId - resourceId - compartmentId - serviceType SystemVersionMinorVersionSummary: description: 'The System minor version. ' properties: version: description: A valid system minor version. maxLength: 255 minLength: 1 type: string required: - version type: object RecommendedScheduledActionSummary: description: 'Details of the scheduled action that is used in getRecommendedScheduledActions. ' properties: actionMembers: description: The list of action members in a scheduled action. items: $ref: '#/components/schemas/ActionMember' maxItems: 200 type: array actionOrder: description: The order of the scheduled action. maximum: 300 minimum: 1 type: integer actionParams: additionalProperties: type: string description: 'Map where a key value pair describes the specific action parameter. Example: `{"count": "3"}` ' maxProperties: 100 type: object actionType: default: DB_SERVER_FULL_SOFTWARE_UPDATE description: The type of the scheduled action being performed enum: - DB_SERVER_FULL_SOFTWARE_UPDATE - STORAGE_SERVER_FULL_SOFTWARE_UPDATE - NETWORK_SWITCH_FULL_SOFTWARE_UPDATE - DB_SERVER_ONLINE_SOFTWARE_UPDATE type: string displayName: description: Description of the scheduled action being performed, i.e. apply full update to DB Servers 1,2,3,4. maxLength: 255 minLength: 1 type: string estimatedTimeInMins: description: The estimated patching time in minutes for the entire scheduled action. maximum: 500000 minimum: 0 type: integer schedulingWindowId: description: The id of the scheduling window this scheduled action belongs to. maxLength: 255 minLength: 1 type: string required: - actionOrder - actionType - schedulingWindowId type: object ChangeSubscriptionDetails: description: 'The configuration details for associating the resource with a different subscription. ' properties: isDefault: description: 'Indicates if the subscription is UCM or not. ' type: boolean subscriptionId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the subscription with which resource needs to be associated with. maxLength: 255 minLength: 1 type: string type: object CreateBackupDetails: description: 'Details for creating a database backup. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' properties: databaseId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the database. maxLength: 255 minLength: 1 type: string displayName: description: The user-friendly name for the backup. The name does not have to be unique. maxLength: 255 minLength: 1 type: string retentionPeriodInDays: description: The retention period of the long term backup in days. maximum: 3650 minimum: 90 type: integer retentionPeriodInYears: description: The retention period of the long term backup in years. maximum: 10 minimum: 1 type: integer required: - databaseId - displayName SwitchOverDataGuardDetails: description: 'The Data Guard switchover parameters. ' properties: databaseAdminPassword: description: 'The administrator password of the primary database in this Data Guard association. **The password MUST be the same as the primary admin password.** ' format: password maxLength: 255 minLength: 1 type: string required: - databaseAdminPassword type: object CreatePluggableDatabaseDetails: description: 'Parameters for creating a pluggable database in a specified container database (CDB). Additional option `pdbCreationTypeDetails` can be used for creating Pluggable Database using different operations, e.g. LocalClone, Remote Clone, Relocate. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' properties: containerDatabaseAdminPassword: description: The DB system administrator password of the Container Database. format: password maxLength: 255 minLength: 1 type: string containerDatabaseId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the CDB maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object pdbAdminPassword: description: A strong password for PDB Admin. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numbers, and two special characters. The special characters must be _, \#, or -. maxLength: 255 minLength: 1 type: string x-default-description: 'null' pdbCreationTypeDetails: $ref: '#/components/schemas/CreatePluggableDatabaseCreationTypeDetails' pdbName: description: The name for the pluggable database (PDB). The name is unique in the context of a [container database](#/en/database/latest/Database/). The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. The pluggable database name should not be same as the container database name. maxLength: 30 minLength: 1 type: string shouldCreatePdbBackup: description: Indicates whether to take Pluggable Database Backup after the operation. type: boolean shouldPdbAdminAccountBeLocked: default: false description: 'The locked mode of the pluggable database admin account. If false, the user needs to provide the PDB Admin Password to connect to it. If true, the pluggable database will be locked and user cannot login to it. ' type: boolean tdeWalletPassword: description: The existing TDE wallet password of the CDB. maxLength: 255 minLength: 1 type: string x-default-description: 'null' required: - pdbName - containerDatabaseId AutonomousDatabaseEncryptionKeyHistoryEntry: description: The Autonomous AI Database encryption key history entry. properties: encryptionKey: $ref: '#/components/schemas/AutonomousDatabaseEncryptionKeyDetails' timeActivated: description: The date and time the encryption key was activated. format: date-time type: string EnableExternalNonContainerDatabaseStackMonitoringDetails: allOf: - $ref: '#/components/schemas/EnableExternalDatabaseStackMonitoringDetailsBase' description: Details to enable Stack Monitoring on the external non-container database. ReorderExecutionActionDetails: description: 'Describes the ordering list of execution actions for the execution window. ' properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object executionActionOrderList: description: 'List of action resources in a specific order. Example: [{actionOrder: 1, actionResourceId: "resourceId1"}, {actionOrder: 2, actionResourceId: "resourceId2"}] ' items: $ref: '#/components/schemas/ActionOrderDetails' maxItems: 100 type: array freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object UpdateCloudAutonomousVmClusterDetails: description: Details for updating the cloud Autonomous VM cluster. properties: autonomousDataStorageSizeInTBs: description: The new value of autonomous data storage (in TBs) for the Autonomous VM cluster. format: double type: number clusterTimeZone: description: The time zone to use for the Autonomous VM cluster. For details, see [DB System Time Zones](/Content/Database/References/timezones.htm). format: x-obmcs-time-zone maxLength: 255 minLength: 1 type: string cpuCoreCountPerNode: description: The new value of cpus per Autonomous VM cluster per node for the Autonomous VM cluster. type: integer definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object description: description: User defined description of the cloud Autonomous VM cluster. maxLength: 400 minLength: 1 type: string displayName: description: 'The user-friendly name for the cloud Autonomous VM cluster. The name does not need to be unique. ' maxLength: 255 minLength: 1 type: string distributionAlgorithm: description: The distribution algorithm used for the Autonomous VM cluster. enum: - RESOURCE_OPTIMIZED - DISTRIBUTION_OPTIMIZED type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object isMtlsEnabledVmCluster: default: false description: Enable mutual TLS(mTLS) authentication for database at time of provisioning a VMCluster. This is applicable to database TLS Certificates only. Default is TLS type: boolean licenseModel: description: 'The Oracle license model that applies to the Oracle Autonomous AI Database. Bring your own license (BYOL) allows you to apply your current on-premises Oracle software licenses to equivalent, highly automated Oracle services in the cloud. License Included allows you to subscribe to new Oracle AI Database software licenses and the Oracle AI Database service. Note that when provisioning an [Autonomous AI Database on dedicated Exadata infrastructure](https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html), this attribute must be null. It is already set at the Autonomous Exadata Infrastructure level. When provisioning an [Autonomous AI Database Serverless] (https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html) database, if a value is not specified, the system defaults the value to `BRING_YOUR_OWN_LICENSE`. Bring your own license (BYOL) also allows you to select the DB edition using the optional parameter. This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, dataStorageSizeInTBs, adminPassword, isMTLSConnectionRequired, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, dbName, scheduledOperations, dbToolsDetails, or isFreeTier. ' enum: - LICENSE_INCLUDED - BRING_YOUR_OWN_LICENSE type: string maintenanceWindowDetails: $ref: '#/components/schemas/MaintenanceWindow' nsgIds: description: 'The list of [OCIDs](/Content/General/Concepts/identifiers.htm) for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see [Security Rules](/Content/Network/Concepts/securityrules.htm). ' items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array uniqueItems: true scanListenerPortNonTls: description: The SCAN Listener Non TLS port. Default is 1521. maximum: 8999 minimum: 1024 type: integer scanListenerPortTls: description: The SCAN Listener TLS port. Default is 2484. maximum: 8999 minimum: 1024 type: integer 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 [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}` ' type: object totalContainerDatabases: description: The new value of maximum number of ACDs for the Autonomous VM cluster. type: integer IdentityConnectorDetails: description: Details of the identity connector properties: cloudProvider: description: Cloud provider enum: - AZURE type: string x-default-description: 'null' id: description: The OCID of the identity connector type: string UpdateDatabaseDetails: description: 'Details to update a database. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' properties: dbBackupConfig: $ref: '#/components/schemas/DbBackupConfig' dbHomeId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Database Home. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object managedSoftwareUpdateDetails: $ref: '#/components/schemas/ManagedSoftwareUpdateInputDetails' newAdminPassword: description: A new strong password for SYS, SYSTEM, and the plugbable database ADMIN user. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numeric, and two special characters. The special characters must be _, \#, or -. format: password maxLength: 255 minLength: 9 type: string newTdeWalletPassword: description: The new password to open the TDE wallet. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numeric, and two special characters. The special characters must be _, \#, or -. format: password maxLength: 255 minLength: 8 type: string oldTdeWalletPassword: description: The existing TDE wallet password. You must provide the existing password in order to set a new TDE wallet password. format: password maxLength: 255 minLength: 8 type: string storageSizeDetails: $ref: '#/components/schemas/DatabaseStorageSizeDetails' PatchHistoryEntrySummary: description: The record of a patch action on a specified target. properties: action: description: The action being performed or was completed. enum: - APPLY - PRECHECK type: string id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the patch history entry. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: 'A descriptive text associated with the lifecycleState. Typically contains additional displayable text. ' type: string lifecycleState: description: The current state of the action. enum: - IN_PROGRESS - SUCCEEDED - FAILED type: string patchId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the patch. maxLength: 255 minLength: 1 type: string timeEnded: description: The date and time when the patch action completed format: date-time type: string timeStarted: description: The date and time when the patch action started. format: date-time type: string required: - id - patchId - lifecycleState - timeStarted responses: 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' x-anchors: baseDbComputeCount: description: The number of compute servers for the DB system. format: int32 type: integer baseDbComputeModel: description: The compute model for Base Database Service. This is required if using the `computeCount` parameter. If using `cpuCoreCount` then it is an error to specify `computeModel` to a non-null value. The ECPU compute model is the recommended model, and the OCPU compute model is legacy. enum: - ECPU - OCPU type: string computeModel: description: 'The compute model of the Base Database, Exadata Infrastructure, VM Cluster and Autonomous AI Database. ' enum: - ECPU - OCPU type: string x-default-description: Null used when unspecified. containerDatabaseAdminPassword: description: The DB system administrator password of the Container Database. format: password maxLength: 255 minLength: 1 type: string dataGuardProtectionMode: description: 'The protection mode of this Data Guard. For more information, see [Oracle Data Guard Protection Modes](http://docs.oracle.com/database/122/SBYDB/oracle-data-guard-protection-modes.htm#SBYDB02000) in the Oracle Data Guard documentation. ' enum: - MAXIMUM_AVAILABILITY - MAXIMUM_PERFORMANCE - MAXIMUM_PROTECTION type: string dataGuardTransportType: description: 'The redo transport type to use for this Data Guard association. Valid values depend on the specified `protectionMode`: * MAXIMUM_AVAILABILITY - SYNC or FASTSYNC * MAXIMUM_PERFORMANCE - ASYNC * MAXIMUM_PROTECTION - SYNC For more information, see [Redo Transport Services](http://docs.oracle.com/database/122/SBYDB/oracle-data-guard-redo-transport-services.htm#SBYDB00400) in the Oracle Data Guard documentation. **IMPORTANT** - The only transport type currently supported by the Database service is ASYNC. ' enum: - SYNC - ASYNC - FASTSYNC type: string databaseAdminPassword: description: 'The administrator password of the primary database in this Data Guard association. **The password MUST be the same as the primary admin password.** ' format: password maxLength: 255 minLength: 1 type: string dblinkUserPassword: description: The DB link user password. format: password maxLength: 255 minLength: 1 type: string dblinkUsername: description: The name of the DB link user. maxLength: 255 minLength: 1 type: string giSoftwareImageId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of a grid infrastructure software image. This is a database software image of the type `GRID_IMAGE`. maxLength: 255 type: string isMtlsEnabledVmCluster: default: false description: Enable mutual TLS(mTLS) authentication for database at time of provisioning a VMCluster. This is applicable to database TLS Certificates only. Default is TLS type: boolean shouldCreatePdbBackup: description: Indicates whether to take Pluggable Database Backup after the operation. type: boolean x-headers: etag: description: For optimistic concurrency control. See `if-match`. 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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. ' type: string x-properties: acdLifecycleState: description: The current state of the Autonomous Container Database. enum: - PROVISIONING - AVAILABLE - UPDATING - TERMINATING - TERMINATED - FAILED - BACKUP_IN_PROGRESS - RESTORING - RESTORE_FAILED - RESTARTING - MAINTENANCE_IN_PROGRESS - ROLE_CHANGE_IN_PROGRESS - ENABLING_AUTONOMOUS_DATA_GUARD - UNAVAILABLE type: string actionMembers: description: List of action members of this execution action. items: $ref: '#/components/schemas/ExecutionActionMember' maxItems: 200 type: array actionOrderList: description: 'List of action resources in a specific order. Example: [{actionOrder: 1, actionResourceId: "resourceId1"}, {actionOrder: 2, actionResourceId: "resourceId2"}] ' items: $ref: '#/components/schemas/ActionOrderDetails' maxItems: 100 type: array additionalComputeCount: description: The requested number of additional compute servers for the Exadata infrastructure. type: integer associatedLongTermBackupCount: description: Indicates the number of long term backups of Autonomous AI Databases associated with this backup destination. type: integer associatedLongTermBackups: description: List of long term backups of Autonomous AI Databases associated with this backup destination.The maximum associated number of long term backup listed here would be 1024. items: $ref: '#/components/schemas/AssociatedLongTermBackup' maxItems: 1024 minItems: 0 type: array attachedShapeAttributes: description: 'The shapeAttribute of the Exadata VM cluster(s) associated with the Exadata Database Storage Vault. ' items: enum: - SMART_STORAGE - BLOCK_STORAGE maxItems: 2 type: string uniqueItems: true type: array autoRefreshFrequencyInSeconds: description: The frequency a refreshable clone is refreshed after auto-refresh is enabled. The minimum is 1 hour. The maximum is 7 days. The date and time that auto-refresh is enabled is controlled by the `timeOfAutoRefreshStart` parameter. maximum: 604800 minimum: 3600 type: integer autoRefreshPointLagInSeconds: description: The time, in seconds, the data of the refreshable clone lags the primary database at the point of refresh. The minimum is 0 minutes (0 mins means refresh to the latest available timestamp). The maximum is 7 days. The lag time increases after refreshing until the next data refresh happens. maximum: 604800 minimum: 0 type: integer autonomousContainerDatabaseDataguardAssociationId: description: The Autonomous Container Database-Autonomous Data Guard association [OCID](/Content/General/Concepts/identifiers.htm). maxLength: 255 minLength: 1 type: string autonomousDataguardLifecycleState: description: The current state of Autonomous Data Guard. enum: - PROVISIONING - AVAILABLE - ROLE_CHANGE_IN_PROGRESS - TERMINATING - TERMINATED - FAILED - UNAVAILABLE - UPDATING type: string autonomousDataguardRegionType: description: '**Deprecated.** The Autonomous Data Guard region type of the Autonomous AI Database. For Autonomous AI Database Serverless, Autonomous Data Guard associations have designated primary and standby regions, and these region types do not change when the database changes roles. The standby regions in Autonomous Data Guard associations can be the same region designated as the primary region, or they can be remote regions. Certain database administrative operations may be available only in the primary region of the Autonomous Data Guard association, and cannot be performed when the database using the primary role is operating in a remote Autonomous Data Guard standby region. ' enum: - PRIMARY_DG_REGION - REMOTE_STANDBY_DG_REGION type: string autonomousDbVersion: description: 'A valid Oracle AI Database version for Autonomous AI Database. When you specify 23ai for dbversion, the system will provision a 23ai database, but the UI will display it as 26ai. When you specify 26ai for dbversion, the system will provision and display a 26ai database as expected. For new databases, it is recommended to use either 19c or 26ai. **Note** Starting December 2026, 23ai will not be supported as a valid value for this parameter. ' maxLength: 255 minLength: 1 type: string autonomousMaintenanceScheduleType: description: 'The maintenance schedule type of the Autonomous AI Database Serverless. An EARLY maintenance schedule follows a schedule applying patches prior to the REGULAR schedule. A REGULAR maintenance schedule follows the normal cycle ' enum: - EARLY - REGULAR type: string autoscaleLimitInGBs: description: The maximum limit, in gigabytes, to which the Vault storage size can automatically scale when auto scaling is enabled for the Database Storage Vault type: integer backupDeletionPolicy: description: This defines when the backups will be deleted. - DELETE_IMMEDIATELY option keep the backup for predefined time i.e 72 hours and then delete permanently... - DELETE_AFTER_RETENTION_PERIOD will keep the backups as per the policy defined for database backups. enum: - DELETE_IMMEDIATELY - DELETE_AFTER_RETENTION_PERIOD type: string backupNetworkNsgIds: description: 'A list of the [OCIDs](/Content/General/Concepts/identifiers.htm) of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see [Security Rules](/Content/Network/Concepts/securityrules.htm). Applicable only to Exadata systems. ' items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array uniqueItems: true byolComputeCountLimit: description: The maximum number of CPUs allowed with a Bring Your Own License (BYOL), including those used for auto-scaling, disaster recovery, tools, etc. Any CPU usage above this limit is considered as License Included and billed. format: float minimum: 2 type: number caBundleId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the certificate bundle. ' maxLength: 255 minLength: 1 type: string cadence: description: The cadence period. enum: - HALFYEARLY - QUARTERLY - MONTHLY type: string cadenceStartMonth: $ref: '#/components/schemas/Month' description: Start of the month to be followed during the cadence period. cdbName: description: The database name. The name must begin with an alphabetic character and can contain a maximum of 8 alphanumeric characters. Special characters are not permitted. The database name must be unique in the tenancy. maxLength: 8 minLength: 1 type: string certificateAuthorityId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the certificate authority. ' maxLength: 255 minLength: 1 type: string certificateGenerationType: description: Specify SYSTEM to use Oracle-managed certificates. Specify BYOC when you want to bring your own certificate. enum: - SYSTEM - BYOC type: string certificateId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the certificate to use. ' maxLength: 255 minLength: 1 type: string cloneType: description: The Autonomous AI Database clone type. enum: - FULL - METADATA - PARTIAL type: string cloudExadataInfrastructureId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud Exadata infrastructure. maxLength: 255 minLength: 1 type: string cloudProvider: description: Cloud provider enum: - AZURE type: string x-default-description: 'null' cloudVmClusterId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud VM cluster. maxLength: 255 minLength: 1 type: string clusterId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the VM cluster. maxLength: 255 minLength: 1 type: string clusterPlacementGroupId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cluster placement group of the Exadata Infrastructure. maxLength: 255 minLength: 1 type: string compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string computeCount: description: The number of compute servers for the cloud Exadata infrastructure. format: int32 type: integer consoleConnectionId: description: The OCID of the console connection. maxLength: 255 minLength: 1 type: string consoleHistoryId: description: The OCID of the console history. maxLength: 255 minLength: 1 type: string contacts: description: The list of contacts for the Exadata infrastructure. items: $ref: '#/components/schemas/ExadataInfrastructureContact' maxItems: 10 minItems: 1 type: array csiNumber: description: The CSI Number of the Exadata infrastructure. maxLength: 255 minLength: 1 type: string dataStoragePercentage: description: 'The percentage assigned to DATA storage (user data and database files). See [Storage Configuration](/Content/Database/Concepts/exaoverview.htm#Exadata) in the Exadata documentation for details on the impact of the configuration settings on storage. ' format: int32 maximum: 100 minimum: 0 type: integer databaseId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the database. maxLength: 255 minLength: 1 type: string databaseManagementStatus: description: Status of Database Management for this Autonomous AI Database. enum: - ENABLING - ENABLED - DISABLING - NOT_ENABLED - FAILED_ENABLING - FAILED_DISABLING type: string databaseServerType: description: The database server type of the Exadata infrastructure. maxLength: 255 minLength: 1 type: string x-default-description: 'null' dbHomeId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Database Home. maxLength: 255 minLength: 1 type: string dbNodeId: description: The OCID of the database node. maxLength: 255 minLength: 1 type: string dbSystemId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the DB system. maxLength: 255 minLength: 1 type: string dbSystemUpgradeAction: description: The operating system upgrade action. enum: - PRECHECK - ROLLBACK - UPDATE_SNAPSHOT_RETENTION_DAYS - UPGRADE type: string dbToolsDetails: description: 'The list of database tools details. This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, isLocalDataGuardEnabled, or isFreeTier. ' items: $ref: '#/components/schemas/DatabaseTool' type: array x-default-description: 'null' dbVersion: description: 'A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation. This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. ' type: string dbWorkload: description: 'The Autonomous AI Database workload type. The following values are valid: - OLTP - indicates an Autonomous AI Transaction Processing database - DW - indicates an Autonomous AI Lakehouse database - AJD - indicates an Autonomous AI JSON Database - APEX - indicates an Autonomous AI Database with the Oracle APEX AI Application Development workload type. - LH - indicates an Oracle Autonomous AI Lakehouse database **Note** Starting December 2026, DW will not be supported as a valid value for this parameter. When creating an Autonomous AI Database, if this parameter is not specified, the default value is `OLTP`. This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. ' enum: - OLTP - DW - AJD - APEX - LH type: string dbnodeSnapshotId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata Database Node Snapshot. maxLength: 255 minLength: 1 type: string dbnodeSnapshotLifecycleDetails: description: Additional information about the current lifecycle state of the Exadata Database Node Snapshot. type: string dbnodeSnapshotName: description: The user-friendly name for the Database Node Snapshot. The name should be unique. maxLength: 255 minLength: 1 type: string dbnodeSnapshotTimeCreated: description: The date and time that the Exadata Database Node Snapshot was created. format: date-time type: string definedFileSystemConfigurations: description: Details of the file system configuration of the Exadata infrastructure. items: $ref: '#/components/schemas/DefinedFileSystemConfiguration' maxItems: 1024 type: array definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object dstFileVersion: description: DST Time-Zone File version of the Autonomous Container Database. maxLength: 255 minLength: 1 type: string duration: description: 'Duration window allows user to set a duration they plan to allocate for Scheduling window. The duration is in minutes. ' minimum: 120 type: integer exadataInfrastructureId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure. maxLength: 255 minLength: 1 type: string exadbBackupSubnetId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the backup network subnet associated with the Exadata VM cluster on Exascale Infrastructure. ' maxLength: 255 minLength: 1 type: string exadbClusterName: description: 'The cluster name for Exadata VM cluster on Exascale Infrastructure. The cluster name must begin with an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive. ' maxLength: 11 minLength: 1 type: string exadbDisplayName: description: The user-friendly name for the Exadata VM cluster on Exascale Infrastructure. The name does not need to be unique. maxLength: 255 minLength: 1 type: string exadbDomain: description: "A domain name used for the Exadata VM cluster on Exascale Infrastructure. If the Oracle-provided internet and VCN\nresolver is enabled for the specified subnet, then the domain name for the subnet is used\n(do not provide one). Otherwise, provide a valid DNS domain name. Hyphens (-) are not permitted. \nApplies to Exadata Database Service on Exascale Infrastructure only.\n" type: string exadbEnabledECpuCount: description: 'The number of ECPUs to enable for an Exadata VM cluster on Exascale Infrastructure. ' format: int32 minimum: 0 type: integer exadbHostname: description: "The hostname for the Exadata VM cluster on Exascale Infrastructure. The hostname must begin with an alphabetic character, and \ncan contain alphanumeric characters and hyphens (-). For Exadata systems, the maximum length of the hostname is 12 characters.\n\nThe maximum length of the combined hostname and domain is 63 characters.\n\n**Note:** The hostname must be unique within the subnet. If it is not unique, \nthen the Exadata VM cluster on Exascale Infrastructure will fail to provision.\n" type: string exadbLicenseModel: description: 'The Oracle license model that applies to the Exadata VM cluster on Exascale Infrastructure. The default is BRING_YOUR_OWN_LICENSE. ' enum: - LICENSE_INCLUDED - BRING_YOUR_OWN_LICENSE type: string exadbPrivateZoneId: description: 'The private zone ID in which you want DNS records to be created. ' maxLength: 255 minLength: 1 type: string exadbScanListenerPortTcp: description: The TCP Single Client Access Name (SCAN) port. The default port is 1521. type: integer exadbScanListenerPortTcpSsl: description: 'The Secured Communication (TCPS) protocol Single Client Access Name (SCAN) port. The default port is 2484. ' type: integer exadbSshPublicKeys: description: The public key portion of one or more key pairs used for SSH access to the Exadata VM cluster on Exascale Infrastructure. items: maxLength: 1024 minLength: 1 type: string type: array exadbSubnetId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet associated with the Exadata VM cluster on Exascale Infrastructure. ' maxLength: 255 minLength: 1 type: string exadbTimeZone: description: 'The time zone to use for the Exadata VM cluster on Exascale Infrastructure. For details, see [Time Zones](/Content/Database/References/timezones.htm). ' maxLength: 255 minLength: 1 type: string exadbTotalECpuCount: description: 'The number of Total ECPUs for an Exadata VM cluster on Exascale Infrastructure. ' format: int32 minimum: 2 type: integer exadbVmClusterAdName: description: 'The name of the availability domain in which the Exadata VM cluster on Exascale Infrastructure is located. ' maxLength: 255 minLength: 1 type: string exascaleDbStorageVaultAdName: description: The name of the availability domain in which the Exadata Database Storage Vault is located. maxLength: 255 minLength: 1 type: string exascaleDbStorageVaultAdditionalFlashCacheInPercent: description: 'The size of additional Flash Cache in percentage of High Capacity database storage. ' format: int32 minimum: 0 type: integer exascaleDbStorageVaultDescription: description: Exadata Database Storage Vault description. maxLength: 400 minLength: 1 type: string exascaleDbStorageVaultDisplayName: description: The user-friendly name for the Exadata Database Storage Vault. The name does not need to be unique. maxLength: 255 minLength: 1 type: string exascaleDbStorageVaultId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata Database Storage Vault. maxLength: 255 minLength: 1 type: string exascaleDbStorageVaultLifecycleDetails: description: Additional information about the current lifecycle state. type: string exascaleDbStorageVaultTimeCreated: description: The date and time that the Exadata Database Storage Vault was created. format: date-time type: string exascaleDbStorageVaultTimeZone: description: 'The time zone that you want to use for the Exadata Database Storage Vault. For details, see [Time Zones](/Content/Database/References/timezones.htm). ' maxLength: 255 minLength: 1 type: string executionActionDisplayName: description: The user-friendly name for the execution action. The name does not need to be unique. maxLength: 255 minLength: 1 type: string executionActionOrderList: description: List of action members of this execution action. items: maxLength: 255 minLength: 1 type: string type: array executionActionParams: additionalProperties: type: string description: 'Map where a key value pair describes the specific action parameter. Example: `{"count": "3"}` ' maxProperties: 100 type: object executionActionType: description: The action type of the execution action being performed enum: - DB_SERVER_FULL_SOFTWARE_UPDATE - STORAGE_SERVER_FULL_SOFTWARE_UPDATE - NETWORK_SWITCH_FULL_SOFTWARE_UPDATE - DB_SERVER_ONLINE_SOFTWARE_UPDATE type: string executionWindowDisplayName: description: The user-friendly name for the Execution Window. The name does not need to be unique. maxLength: 255 minLength: 1 type: string executionWindowId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the execution window resource the execution action belongs to. maxLength: 255 minLength: 1 type: string externalContainerDatabaseId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the [external container database](#/en/database/latest/datatypes/CreateExternalContainerDatabaseDetails) that contains the specified [external pluggable database](#/en/database/latest/datatypes/CreateExternalPluggableDatabaseDetails) resource. ' type: string externalDatabaseConnectorAgentId: description: 'The ID of the agent used for the [external database connector](#/en/database/latest/datatypes/CreateExternalDatabaseConnectorDetails). ' type: string externalDatabaseConnectorCredentialName: description: 'The name of the credential information that used to connect to the database. The name should be in "x.y" format, where the length of "x" has a maximum of 64 characters, and length of "y" has a maximum of 199 characters. The name strings can contain letters, numbers and the underscore character only. Other characters are not valid, except for the "." character that separates the "x" and "y" portions of the name. *IMPORTANT* - The name must be unique within the OCI region the credential is being created in. If you specify a name that duplicates the name of another credential within the same OCI region, you may overwrite or corrupt the credential that is already using the name. For example: inventorydb.abc112233445566778899 ' maxLength: 255 minLength: 1 type: string externalDatabaseConnectorDisplayName: description: 'The user-friendly name for the [external database connector](#/en/database/latest/datatypes/CreateExternalDatabaseConnectorDetails). The name does not have to be unique. ' maxLength: 255 minLength: 1 type: string externalDatabaseConnectorId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the [external database connector](#/en/database/latest/datatypes/CreateExternalDatabaseConnectorDetails). ' maxLength: 255 minLength: 1 type: string externalDatabaseConnectorType: default: MACS description: The type of connector used by the external database resource. enum: - MACS type: string externalDatabaseDisplayName: description: The user-friendly name for the external database. The name does not have to be unique. maxLength: 255 minLength: 1 type: string externalDatabaseId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external database resource. type: string externalLicenseModel: description: 'The Oracle license model that applies to the external database. ' enum: - LICENSE_INCLUDED - BRING_YOUR_OWN_LICENSE type: string externalSourceId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the the non-container database that was converted to a pluggable database to create this resource. ' type: string fastStartFailOverLagLimitInSeconds: description: The lag time for my preference based on data loss tolerance in seconds. maximum: 3600 minimum: 5 type: integer fileSystemConfigurationDetails: description: Details of the file system configuration of the VM cluster. items: $ref: '#/components/schemas/FileSystemConfigurationDetail' maxItems: 1024 type: array freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object giVersion: description: A valid Oracle Grid Infrastructure (GI) software version. maxLength: 255 minLength: 1 type: string gridImageId: description: 'Grid Setup will be done using this grid image id. The grid image ID can be obtained using the API /20160918/giVersions/{majorVersion}/minorVersions?compartmentId=&shapeFamily=EXADB_XS&availabilityDomain=. The list of supported major versions can be obtained using the API /20160918/giVersions?compartmentId=&shape=ExaDbXS&availabilityDomain= ' maxLength: 255 minLength: 1 type: string gridImageType: description: The type of Grid Image enum: - RELEASE_UPDATE - CUSTOM_IMAGE type: string isAccessControlEnabled: description: "Indicates if the database-level access control is enabled.\nIf disabled, database access is defined by the network security rules.\nIf enabled, database access is restricted to the IP addresses defined by the rules specified with the `whitelistedIps` property. While specifying `whitelistedIps` rules is optional,\n if database-level access control is enabled and no rules are specified, the database will become inaccessible. The rules can be added later using the `UpdateAutonomousDatabase` API operation or edit option in console.\nWhen creating a database clone, the desired access control setting should be specified. By default, database-level access control will be disabled for the clone.\n\nThis property is applicable only to Autonomous AI Databases on the Exadata Cloud@Customer platform. For Autonomous AI Database Serverless instances, `whitelistedIps` is used.\n" type: boolean isAutomaticFailoverEnabled: description: 'Indicates whether Automatic Failover is enabled for Autonomous Container Database Dataguard Association ' type: boolean isAutoscaleEnabled: description: Indicates if autoscale feature is enabled for the Database Storage Vault. The default value is `FALSE`. type: boolean isDataGuardEnabled: description: '**Deprecated.** Indicates whether the Autonomous AI Database has local (in-region) Data Guard enabled. Not applicable to cross-region Autonomous Data Guard associations, or to Autonomous AI Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure. ' type: boolean isDesupportedVersion: description: If true, the customer acknowledges that the specified Oracle Database software is an older release that is not currently supported by OCI. type: boolean isDevTier: default: false description: 'Autonomous AI Database for Developers are fixed-shape Autonomous AI Databases that developers can use to build and test new applications. On Serverless, these are low-cost and billed per instance, on Dedicated and Cloud@Customer there is no additional cost to create Developer databases. Developer databases come with limited resources and is not intended for large-scale testing and production deployments. When you need more compute or storage resources, you may upgrade to a full paid production database. ' type: boolean isDstFileUpdateEnabled: description: Indicates if an automatic DST Time Zone file update is enabled for the Autonomous Container Database. If enabled along with Release Update, patching will be done in a Non-Rolling manner. type: boolean isEnforcedDuration: default: false description: Indicates if duration the user plans to allocate for scheduling window is strictly enforced. The default value is `FALSE`. type: boolean isFreeTier: default: false description: 'Indicates if this is an Always Free resource. The default value is false. Note that Always Free Autonomous AI Databases have 1 CPU and 20GB of memory. For Always Free databases, memory and CPU cannot be scaled. This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, or isLocalDataGuardEnabled ' type: boolean isLocalDataGuardEnabled: description: Indicates whether the Autonomous AI Database has local (in-region) Data Guard enabled. Not applicable to cross-region Autonomous Data Guard associations, or to Autonomous AI Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure. type: boolean isMtlsConnectionRequired: description: 'Specifies if the Autonomous AI Database requires mTLS connections. This may not be updated in parallel with any of the following: licenseModel, databaseEdition, cpuCoreCount, computeCount, dataStorageSizeInTBs, whitelistedIps, openMode, permissionLevel, db-workload, privateEndpointLabel, nsgIds, customerContacts, dbVersion, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. Service Change: The default value of the isMTLSConnectionRequired attribute will change from true to false on July 1, 2023 in the following APIs: - CreateAutonomousDatabase - GetAutonomousDatabase - UpdateAutonomousDatabase Details: Prior to the July 1, 2023 change, the isMTLSConnectionRequired attribute default value was true. This applies to Autonomous AI Database Serverless. Does this impact me? If you use or maintain custom scripts or Terraform scripts referencing the CreateAutonomousDatabase, GetAutonomousDatabase, or UpdateAutonomousDatabase APIs, you want to check, and possibly modify, the scripts for the changed default value of the attribute. Should you choose not to leave your scripts unchanged, the API calls containing this attribute will continue to work, but the default value will switch from true to false. How do I make this change? Using either OCI SDKs or command line tools, update your custom scripts to explicitly set the isMTLSConnectionRequired attribute to true. ' type: boolean isMultiRackDeployment: description: Indicates if deployment is Multi-Rack or not. type: boolean isRefreshableClone: description: 'Indicates if the Autonomous AI Database is a refreshable clone. This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. ' type: boolean isRemoteDataGuardEnabled: description: Indicates whether the Autonomous AI Database has Cross Region Data Guard enabled. Not applicable to Autonomous AI Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure. type: boolean isThinClone: description: True if Pluggable Database needs to be thin cloned and false if Pluggable Database needs to be thick cloned. type: boolean isUsingRecommendedScheduledActions: description: If true, recommended scheduled actions will be generated for the scheduling plan. type: boolean keyStoreAdminUsername: description: The administrator username to connect to Oracle Key Vault maxLength: 255 minLength: 1 type: string keyStoreConnectionIps: description: The list of Oracle Key Vault connection IP addresses. items: maxLength: 1024 minLength: 1 type: string maxItems: 1024 minItems: 1 type: array keyStoreDisplayName: description: The user-friendly name for the key store. The name does not need to be unique. maxLength: 255 minLength: 1 type: string keyStoreId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the key store of Oracle Vault. maxLength: 255 minLength: 1 type: string keyStoreTypeDetails: $ref: '#/components/schemas/KeyStoreTypeDetails' keyStoreWalletName: description: The wallet name for Oracle Key Vault. maxLength: 255 minLength: 1 type: string kmsKeyId: description: The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. maxLength: 255 minLength: 1 type: string kmsKeyVersionId: description: 'The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous AI Database Serverless does not use key versions, hence is not applicable for Autonomous AI Database Serverless instances. ' maxLength: 255 minLength: 1 type: string lagTimeInSeconds: description: The amount of time, in seconds, that the data of the standby database lags the data of the primary database. Can be used to determine the potential data loss in the event of a failover. type: integer licenseModel: description: 'The Oracle license model that applies to the Oracle Autonomous AI Database. Bring your own license (BYOL) allows you to apply your current on-premises Oracle software licenses to equivalent, highly automated Oracle services in the cloud. License Included allows you to subscribe to new Oracle AI Database software licenses and the Oracle AI Database service. Note that when provisioning an [Autonomous AI Database on dedicated Exadata infrastructure](https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html), this attribute must be null. It is already set at the Autonomous Exadata Infrastructure level. When provisioning an [Autonomous AI Database Serverless] (https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html) database, if a value is not specified, the system defaults the value to `BRING_YOUR_OWN_LICENSE`. Bring your own license (BYOL) also allows you to select the DB edition using the optional parameter. This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, dataStorageSizeInTBs, adminPassword, isMTLSConnectionRequired, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, dbName, scheduledOperations, dbToolsDetails, or isFreeTier. ' enum: - LICENSE_INCLUDED - BRING_YOUR_OWN_LICENSE type: string lifecycleState: description: The current state of the Autonomous AI Database. enum: - PROVISIONING - AVAILABLE - STOPPING - STOPPED - STARTING - TERMINATING - TERMINATED - UNAVAILABLE - RESTORE_IN_PROGRESS - RESTORE_FAILED - BACKUP_IN_PROGRESS - SCALE_IN_PROGRESS - AVAILABLE_NEEDS_ATTENTION - UPDATING - MAINTENANCE_IN_PROGRESS - RESTARTING - RECREATING - ROLE_CHANGE_IN_PROGRESS - UPGRADING - INACCESSIBLE - STANDBY - TRANSPORTING type: string localAdgAutoFailoverMaxDataLossLimit: description: Parameter that allows users to select an acceptable maximum data loss limit in seconds, up to which Automatic Failover will be triggered when necessary for a Local Autonomous Data Guard maximum: 3600 minimum: 0 type: integer longTermBackUpScheduleDetails: $ref: '#/components/schemas/LongTermBackUpScheduleDetails' managementType: default: BASIC description: The Database Management type. enum: - BASIC - ADVANCED type: string multiCloudIdentityConnectorConfigs: description: Details of the multi cloud identity connectors of the VM cluster. items: $ref: '#/components/schemas/IdentityConnectorDetails' maxItems: 10 type: array multiRackConfigurationFile: description: The base64 encoded Multi-Rack configuration json file. format: byte type: string netServicesArchitecture: default: DEDICATED description: Enabling SHARED server architecture enables a database server to allow many client processes to share very few server processes, thereby increasing the number of supported users. enum: - DEDICATED - SHARED - DRCP type: string networkBondingMode: default: - ACTIVE_BACKUP description: The network bonding mode for the Exadata infrastructure. enum: - ACTIVE_BACKUP - LACP type: string nsgIds: description: 'The list of [OCIDs](/Content/General/Concepts/identifiers.htm) for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see [Security Rules](/Content/Network/Concepts/securityrules.htm). ' items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array uniqueItems: true oneOffPatches: description: List of one-off patches for Database Homes. items: type: string type: array oneoffPatchDisplayName: description: One-off patch name. maxLength: 255 minLength: 1 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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' type: string openMode: description: 'Indicates the Autonomous AI Database mode. The database can be opened in `READ_ONLY` or `READ_WRITE` mode. This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, or isFreeTier. ' enum: - READ_ONLY - READ_WRITE type: string x-default-description: 'null' operationsInsightsStatus: description: Status of Operations Insights for this Autonomous AI Database. enum: - ENABLING - ENABLED - DISABLING - NOT_ENABLED - FAILED_ENABLING - FAILED_DISABLING type: string oracleDatabaseEdition: description: 'The Oracle Database Edition that applies to all the databases on the DB system. Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE. ' enum: - STANDARD_EDITION - ENTERPRISE_EDITION - ENTERPRISE_EDITION_HIGH_PERFORMANCE - ENTERPRISE_EDITION_EXTREME_PERFORMANCE - ENTERPRISE_EDITION_DEVELOPER type: string osVersion: description: A valid Oracle Software (OS) version eg. Oracle Linux Server release 8 maxLength: 255 minLength: 1 type: string patchFailureCount: description: Contain the patch failure count. type: integer patchType: description: 'Patch type, either "QUARTERLY" or "TIMEZONE". ' enum: - QUARTERLY - TIMEZONE type: string patchingMode: description: 'Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING. *IMPORTANT*: Non-rolling infrastructure patching involves system down time. See [Oracle-Managed Infrastructure Maintenance Updates](/iaas/Content/Database/Concepts/examaintenance.htm#Oracle) for more information. ' enum: - ROLLING - NONROLLING type: string pdbConversionAction: description: 'The operations used to convert a non-container database to a pluggable database. - Use `PRECHECK` to run a pre-check operation on non-container database prior to converting it into a pluggable database. - Use `CONVERT` to convert a non-container database into a pluggable database. - Use `SYNC` if the non-container database was manually converted into a pluggable database using the dbcli command-line utility. Databases may need to be converted manually if the CONVERT action fails when converting a non-container database using the API. - Use `SYNC_ROLLBACK` if the conversion of a non-container database into a pluggable database was manually rolled back using the dbcli command line utility. Conversions may need to be manually rolled back if the CONVERT action fails when converting a non-container database using the API. ' enum: - PRECHECK - CONVERT - SYNC - SYNC_ROLLBACK type: string pdbConversionTarget: description: "The target container database of the pluggable database created by the database conversion operation. Currently, the database conversion operation only supports creating the pluggable database in a new container database.\n - Use `NEW_DATABASE` to specify that the pluggable database be created within a new container database in the same database home.\n" enum: - NEW_DATABASE type: string pdbName: description: The name for the pluggable database (PDB). The name is unique in the context of a [container database](#/en/database/latest/Database/). The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. The pluggable database name should not be same as the container database name. maxLength: 30 minLength: 1 type: string permissionLevel: description: 'The Autonomous AI Database permission level. Restricted mode allows access only by admin users. This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, or isFreeTier. ' enum: - RESTRICTED - UNRESTRICTED type: string x-default-description: 'null' pluggableDatabaseId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata Pluggable Database. maxLength: 255 minLength: 1 type: string pluggableDatabaseSnapshotId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata Pluggable Database Snapshot. maxLength: 255 minLength: 1 type: string pluggableDatabaseSnapshotLifecycleDetails: description: Additional information about the current lifecycle state of the Exadata Pluggable Database Snapshot. type: string pluggableDatabaseSnapshotName: description: The user-friendly name for the Database Snapshot. The name should be unique. maxLength: 255 minLength: 1 type: string pluggableDatabaseSnapshotTimeCreated: description: 'The date and time that the Exadata Pluggable Database Snapshot was created, as expressed in RFC 3339 format. For example: 2023-06-27T21:10:29Z ' format: date-time type: string privateEndPointId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the private endpoint. ' maxLength: 255 minLength: 1 type: string privateEndpoint: description: The private endpoint for the resource. type: string privateEndpointIp: description: The private endpoint Ip address for the resource. type: string privateEndpointLabel: description: 'The resource''s private endpoint label. - Setting the endpoint label to a non-empty string creates a private endpoint database. - Resetting the endpoint label to an empty string, after the creation of the private endpoint database, changes the private endpoint database to a public endpoint database. - Setting the endpoint label to a non-empty string value, updates to a new private endpoint database, when the database is disabled and re-enabled. This setting cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, dbWorkload, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, or isFreeTier. ' type: string protectionMode: description: 'The protection mode of this Autonomous Data Guard association. For more information, see [Oracle Data Guard Protection Modes](http://docs.oracle.com/database/122/SBYDB/oracle-data-guard-protection-modes.htm#SBYDB02000) in the Oracle Data Guard documentation. ' enum: - MAXIMUM_AVAILABILITY - MAXIMUM_PERFORMANCE type: string providerType: description: 'Use ''EXTERNAL'' for creating a new database or migrating a database key to an External HSM. Use ''AZURE'' for creating a new database or migrating a database key to Azure. ' enum: - EXTERNAL - AZURE type: string x-default-description: 'null' recoStoragePercentage: description: 'The percentage assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). See [Storage Configuration](/Content/Database/Concepts/exaoverview.htm#Exadata) in the Exadata documentation for details on the impact of the configuration settings on storage. ' format: int32 maximum: 100 minimum: 0 type: integer refreshableMode: description: The refresh mode of the clone. AUTOMATIC indicates that the clone is automatically being refreshed with data from the source Autonomous AI Database. enum: - AUTOMATIC - MANUAL type: string refreshableStatus: description: The refresh status of the clone. REFRESHING indicates that the clone is currently being refreshed with data from the source Autonomous AI Database. enum: - REFRESHING - NOT_REFRESHING type: string x-default-description: This property is only valid for refreshable clones and is null for for databases that are not refreshable clones. releaseUpdate: description: The PSU or PBP or Release Updates. To get a list of supported versions, use the [ListDbVersions](#/en/database/latest/DbVersionSummary/ListDbVersions) operation. maxLength: 255 minLength: 1 type: string resourcePoolLeaderId: description: The unique identifier for leader Autonomous AI Database OCID [OCID](/Content/General/Concepts/identifiers.htm). maxLength: 255 minLength: 1 type: string retentionPeriodInDays: description: Retention period, in days, for long-term backups maximum: 3650 minimum: 90 type: integer retentionPeriodInYears: description: The retention period of the long term backup in years. maximum: 10 minimum: 1 type: integer role: description: 'The Data Guard role of the Autonomous Container Database or Autonomous AI Database, if Autonomous Data Guard is enabled. ' enum: - PRIMARY - STANDBY - DISABLED_STANDBY - BACKUP_COPY - SNAPSHOT_STANDBY type: string scheduledActionDisplayName: description: The display name of the Scheduled Action. maxLength: 255 minLength: 1 type: string scheduledActionIdOrders: description: The array of [OCID](/Content/General/Concepts/identifiers.htm) of the Scheduled Action and order paris. items: maxLength: 1024 minLength: 1 type: string maxItems: 200 type: array scheduledActionMembers: description: The list of action members in a scheduled action. items: $ref: '#/components/schemas/ActionMember' maxItems: 200 type: array scheduledActionOrder: description: The order of the scheduled action. maximum: 300 minimum: 1 type: integer scheduledActionParams: additionalProperties: type: string description: 'Map where a key value pair describes the specific action parameter. Example: `{"count": "3"}` ' maxProperties: 100 type: object scheduledActionSchedulePlanid: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Scheduling Plan. maxLength: 255 minLength: 1 type: string scheduledActionSchedulePolicyid: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Scheduling Policy. maxLength: 255 minLength: 1 type: string scheduledActionSchedulingWindowId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Scheduling Window. maxLength: 255 minLength: 1 type: string scheduledActionType: default: DB_SERVER_FULL_SOFTWARE_UPDATE description: The type of the scheduled action being performed enum: - DB_SERVER_FULL_SOFTWARE_UPDATE - STORAGE_SERVER_FULL_SOFTWARE_UPDATE - NETWORK_SWITCH_FULL_SOFTWARE_UPDATE - DB_SERVER_ONLINE_SOFTWARE_UPDATE type: string scheduledOperations: description: 'The list of scheduled operations. Consists of values such as dayOfWeek, scheduledStartTime, scheduledStopTime. This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. ' items: $ref: '#/components/schemas/ScheduledOperationDetails' type: array schedulingPlanDisplayName: description: The display name of the Scheduling Plan. maxLength: 255 minLength: 1 type: string schedulingPlanIntent: default: EXADATA_INFRASTRUCTURE_FULL_SOFTWARE_UPDATE description: The current intent of the Scheduling Plan. Valid states are EXADATA_INFRASTRUCTURE_FULL_SOFTWARE_UPDATE and EXADATA_INFRASTRUCTURE_SECURITY_UPDATE. enum: - EXADATA_INFRASTRUCTURE_FULL_SOFTWARE_UPDATE - EXADATA_INFRASTRUCTURE_SECURITY_UPDATE type: string schedulingPlanResourceId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the resource. maxLength: 255 minLength: 1 type: string schedulingPlanSchedulePolicyid: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Scheduling Policy. maxLength: 255 minLength: 1 type: string schedulingPlanServiceType: description: The service type of the Scheduling Plan. enum: - EXACC - EXACS - FPPPCS type: string schedulingPolicyDisplayName: description: The user-friendly name for the Scheduling Policy. The name does not need to be unique. maxLength: 255 minLength: 1 type: string schedulingWindowDisplayName: description: The user-friendly name for the Scheduling Window. The name does not need to be unique. maxLength: 255 minLength: 1 type: string secretId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [secret](/Content/KeyManagement/Concepts/keyoverview.htm#concepts). maxLength: 255 minLength: 1 type: string 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 [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}` ' type: object serviceName: description: The name of the Oracle Database service that will be used to connect to the database. maxLength: 255 minLength: 1 type: string shape: description: 'The shape of the Exadata VM cluster on Exascale Infrastructure resource ' type: string shapeAttribute: description: 'The type of Exascale storage used for Exadata VM cluster. The default is SMART_STORAGE which supports Oracle Database 23ai and later ' enum: - SMART_STORAGE - BLOCK_STORAGE type: string shouldPdbAdminAccountBeLocked: default: false description: 'The locked mode of the pluggable database admin account. If false, the user needs to provide the PDB Admin Password to connect to it. If true, the pluggable database will be locked and user cannot login to it. ' type: boolean sidPrefix: description: 'Specifies a prefix for the `Oracle SID` of the database to be created. ' maxLength: 12 minLength: 1 type: string snapshotRetentionPeriodInDays: default: 0 description: The retention period, in days, for the snapshot that allows you to perform a rollback of the upgrade operation. After this number of days passes, you cannot roll back the upgrade. maximum: 31 minimum: 0 type: integer source: default: NONE description: 'The source of the database: Use `NONE` for creating a new database. Use `DB_BACKUP` for creating a new database by restoring from a backup. Use `DATABASE` for creating a new database from an existing database, including archive redo log data. The default is `NONE`. ' enum: - NONE - DB_BACKUP - DATABASE - DB_SYSTEM - DATAGUARD type: string sourceDbnodeId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata Database Node. maxLength: 255 minLength: 1 type: string sourcePluggableDatabaseSnapshotId: description: The OCID of the Source Pluggable Database Snapshot id. type: string sparseStoragePercentage: description: 'The percentage assigned to SPARSE storage (Exadata snapshots). See [Storage Configuration](/Content/Database/Concepts/exaoverview.htm#Exadata) in the Exadata documentation for details on the impact of the configuration settings on storage. ' format: int32 maximum: 100 minimum: 0 type: integer startTime: description: The scheduling window start time. The value must use the ISO-8601 format "hh:mm". maxLength: 50 minLength: 1 type: string storageCount: description: The number of storage servers for the cloud Exadata infrastructure. format: int32 type: integer storageServerType: description: The storage server type of the Exadata infrastructure. maxLength: 255 minLength: 1 type: string x-default-description: 'null' storageVolumePerformanceMode: default: BALANCED description: 'The block storage volume performance level. Valid values are `BALANCED` and `HIGH_PERFORMANCE`. See [Block Volume Performance](/Content/Block/Concepts/blockvolumeperformance.htm) for more information. ' enum: - BALANCED - HIGH_PERFORMANCE type: string subnetId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet the resource is associated with. **Subnet Restrictions:** - For bare metal DB systems and for single node virtual machine DB systems, do not use a subnet that overlaps with 192.168.16.16/28. - For Exadata and virtual machine 2-node RAC systems, do not use a subnet that overlaps with 192.168.128.0/20. - For Autonomous AI Database, setting this will disable public secure access to the database. These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and the backup subnet. ' maxLength: 255 minLength: 1 type: string subscriptionId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the subscription with which resource needs to be associated with. maxLength: 255 minLength: 1 type: string systemModel: description: 'Oracle Exadata System Model specification. The system model determines the amount of compute or storage server resources available for use. For more information, please see [System and Shape Configuration Options] (https://docs.oracle.com/en/engineered-systems/exadata-cloud-at-customer/ecccm/ecc-system-config-options.html#GUID-9E090174-5C57-4EB1-9243-B470F9F10D6B) ' enum: - X7 - X8 - X8M - X9M - X11M type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). ' type: object systemVersion: description: Operating system version of the image. maxLength: 255 minLength: 1 type: string tdeKeyStoreType: description: TDE keystore type enum: - AZURE - OCI type: string x-default-description: 'null' timeNextSchedulingWindowStarts: description: The date and time of the next upcoming window associated within the schedulingWindow is planned to start. format: date-time type: string timeNextWindowStarts: description: The date and time of the next scheduling window associated with the schedulingPolicy is planned to start. format: date-time type: string timeOfAutoRefreshStart: description: The the date and time that auto-refreshing will begin for an Autonomous AI Database refreshable clone. This value controls only the start time for the first refresh operation. Subsequent (ongoing) refresh operations have start times controlled by the value of the `autoRefreshFrequencyInSeconds` parameter. format: date-time type: string timeOfJoiningResourcePool: description: The time the member joined the resource pool. format: date-time type: string timeScheduled: description: The scheduled start date and time of the execution window. format: date-time type: string updateAction: enum: - ROLLING_APPLY - NON_ROLLING_APPLY - PRECHECK - ROLLBACK type: string updateType: description: The type of cloud VM cluster maintenance update. enum: - GI_UPGRADE - GI_PATCH - OS_UPDATE type: string upgradeAction: description: The database upgrade action. enum: - PRECHECK - UPGRADE - ROLLBACK type: string upgradeSource: description: "The source of the Oracle Database software to be used for the upgrade.\n - Use `DB_HOME` to specify an existing Database Home to upgrade the database. The database is moved to the target Database Home and makes use of the Oracle Database software version of the target Database Home.\n - Use `DB_VERSION` to specify a generally-available Oracle Database software version to upgrade the database.\n - Use `DB_SOFTWARE_IMAGE` to specify a [database software image](/iaas/Content/Database/Concepts/databasesoftwareimage.htm) to upgrade the database.\n" enum: - DB_HOME - DB_VERSION - DB_SOFTWARE_IMAGE type: string vaultId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [vault](/Content/KeyManagement/Concepts/keyoverview.htm#concepts). This parameter and `secretId` are required for Customer Managed Keys. maxLength: 255 minLength: 1 type: string versionPreference: default: NEXT_RELEASE_UPDATE description: 'The next maintenance version preference. ' enum: - NEXT_RELEASE_UPDATE - LATEST_RELEASE_UPDATE type: string vmClusterId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the VM cluster. maxLength: 255 minLength: 1 type: string vmClusterUpdateAction: enum: - ROLLING_APPLY - PRECHECK - ROLLBACK type: string vmClusterUpdateType: description: The type of VM cluster maintenance update. enum: - GI_UPGRADE - GI_PATCH - OS_UPDATE type: string whitelistedIps: description: 'The client IP access control list (ACL). This feature is available for [Autonomous AI Database Serverless] (https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html) and on Exadata Cloud@Customer. Only clients connecting from an IP address included in the ACL may access the Autonomous AI Database instance. If `arePrimaryWhitelistedIpsUsed` is ''TRUE'' then Autonomous AI Database uses this primary''s IP access control list (ACL) for the disaster recovery peer called `standbywhitelistedips`. For Autonomous AI Database Serverless, this is an array of CIDR (classless inter-domain routing) notations for a subnet or VCN OCID (virtual cloud network Oracle Cloud ID). Multiple IPs and VCN OCIDs should be separate strings separated by commas, but if it’s other configurations that need multiple pieces of information then its each piece is connected with semicolon (;) as a delimiter. Example: `["1.1.1.1","1.1.1.0/24","ocid1.vcn.oc1.sea.","ocid1.vcn.oc1.sea.;1.1.1.1","ocid1.vcn.oc1.sea.;1.1.0.0/16"]` For Exadata Cloud@Customer, this is an array of IP addresses or CIDR notations. Example: `["1.1.1.1","1.1.1.0/24","1.1.2.25"]` For an update operation, if you want to delete all the IPs in the ACL, use an array with a single empty string entry. This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. ' items: maxLength: 1024 minLength: 0 type: string type: array windowType: description: The execution window is of PLANNED or UNPLANNED type. enum: - PLANNED - UNPLANNED type: string