{ "swagger":"2.0", "info":{ "version":"2026.02.23", "title":"REST APIs for Oracle Database Appliance Release 19.30", "description":"REST APIs for Oracle Database Appliance Release 19.30", "license":{ "name":"Oracle Corporation (c) 2026. All rights reserved." }, "x-summary":"REST APIs for Oracle Database Appliance Release 19.30" }, "schemes":[ "http" ], "consumes":[ "application/json" ], "produces":[ "application/json" ], "tags":[ { "name":"Database", "description":"Database Lifecycle Management REST Endpoints" }, { "name":"General", "description":"General REST Endpoints" }, { "name":"KVM Database System", "description":"KVM DBSystem REST Endpoints" }, { "name":"ObjectStoreSwift", "description":"ObjectStoreSwift Operations REST Endpoints" } ], "paths":{ "/databases":{ "get":{ "tags":[ "Database" ], "summary":"Get databases", "description":"List all databases on the Oracle Database Appliance", "operationId":"listDatabases", "parameters":[ { "$ref":"#/parameters/DatabaseNameQueryParam" }, { "$ref":"#/parameters/DatabaseUniqueNameQueryParam" }, { "$ref":"#/parameters/IncludeLocalEntityQueryParam" }, { "$ref":"#/parameters/IncludeDBVMEntityQueryParam" }, { "$ref":"#/parameters/DbvmNamesSourceQueryParam" }, { "$ref":"#/parameters/ShowAllQueryParam" } ], "responses":{ "200":{ "description":"OK", "schema":{ "type":"array", "items":{ "$ref":"#/definitions/DB" } } }, "default":{ "$ref":"#/responses/Exception" } }, "x-internal-id":"databases-get", "x-filename-id":"databases-get" }, "post":{ "tags":[ "Database" ], "summary":"Create database", "description":"Create new database in Oracle Database Appliance using DBRequest parameters. Ensure that the repository is updated with Oracle RDBMS Clone files for the database version, before creating the database.", "operationId":"createDatabase", "parameters":[ { "in":"body", "name":"body", "description":"database creation parameters", "required":true, "schema":{ "$ref":"#/definitions/DBRequest" } }, { "$ref":"#/parameters/IdempotencyToken" } ], "responses":{ "200":{ "description":"database deployment state using name filter.", "schema":{ "$ref":"#/definitions/ServiceJobReport" } }, "default":{ "$ref":"#/responses/Exception" } }, "x-internal-id":"databases-post", "x-filename-id":"databases-post" }, "put":{ "tags":[ "Database" ], "description":"Update database parameters using its name", "operationId":"updateDatabaseByName", "parameters":[ { "in":"body", "name":"body", "description":"database creation parameters using name filter", "required":true, "schema":{ "$ref":"#/definitions/DBUpdateRequest" } }, { "$ref":"#/parameters/DatabaseNameQueryParam" }, { "$ref":"#/parameters/IdempotencyToken" } ], "responses":{ "200":{ "description":"OK", "schema":{ "$ref":"#/definitions/ServiceJobReport" } }, "default":{ "$ref":"#/responses/Exception" } }, "summary":"Update database parameters using its name", "x-internal-id":"databases-put", "x-filename-id":"databases-put" }, "delete":{ "tags":[ "Database" ], "summary":"Deletes database by name", "description":"Deletes the database by name. Deletes the file system, and the underlying ADVM volumes assigned to the database. For example, deleting a database named hrdb also deletes the file system /u02/app/oracle/oradata/hrdb. Do not keep any other files on this database file location.", "operationId":"deleteDatabaseByName", "parameters":[ { "$ref":"#/parameters/DatabaseNameQueryParam" }, { "$ref":"#/parameters/PluggableDatabaseNameQueryParam" }, { "$ref":"#/parameters/IdempotencyToken" }, { "$ref":"#/parameters/ForceDelete" }, { "$ref":"#/parameters/RetainOKVWallets" } ], "responses":{ "200":{ "description":"database delete state using name filter." }, "default":{ "$ref":"#/responses/Exception" } }, "x-internal-id":"databases-delete", "x-filename-id":"databases-delete" } }, "/databases/{databaseId}":{ "get":{ "tags":[ "Database" ], "summary":"Get database details by ID", "description":"Get database details by ID", "operationId":"getDatabase", "parameters":[ { "$ref":"#/parameters/DatabaseIdPathParam" }, { "$ref":"#/parameters/IncludeLocalEntityQueryParam" }, { "$ref":"#/parameters/IncludeDBVMEntityQueryParam" }, { "$ref":"#/parameters/DbvmNamesSourceQueryParam" } ], "responses":{ "200":{ "description":"OK", "schema":{ "$ref":"#/definitions/DB" } }, "default":{ "$ref":"#/responses/Exception" } }, "x-internal-id":"databases-{databaseId}-get", "x-filename-id":"databases-databaseid-get" }, "put":{ "tags":[ "Database" ], "summary":"Modify database parameters", "description":"Modify the configuration of a database using DBModificationRequest parameters. Modifies backup configuration, database class, and database type", "operationId":"updateDatabase", "parameters":[ { "in":"body", "name":"body", "description":"database creation parameters", "required":true, "schema":{ "$ref":"#/definitions/DBUpdateRequest" } }, { "$ref":"#/parameters/DatabaseIdPathParam" }, { "$ref":"#/parameters/IdempotencyToken" } ], "responses":{ "200":{ "description":"OK", "schema":{ "$ref":"#/definitions/ServiceJobReport" } }, "default":{ "$ref":"#/responses/Exception" } }, "x-internal-id":"databases-{databaseId}-put", "x-filename-id":"databases-databaseid-put" }, "delete":{ "tags":[ "Database" ], "summary":"Deletes database by ID", "description":"Deletes the database by ID. Deletes the file system, and the underlying ADVM volumes assigned to the database. For example, deleting a database named hrdb also deletes the file system /u02/app/oracle/oradata/hrdb. Do not keep any other files on this database file location.", "operationId":"deleteDatabase", "parameters":[ { "$ref":"#/parameters/DatabaseIdPathParam" }, { "$ref":"#/parameters/PluggableDatabaseNameQueryParam" }, { "$ref":"#/parameters/IdempotencyToken" }, { "$ref":"#/parameters/ForceDelete" }, { "$ref":"#/parameters/RetainOKVWallets" } ], "responses":{ "200":{ "description":"database delete state." }, "default":{ "$ref":"#/responses/Exception" } }, "x-internal-id":"databases-{databaseId}-delete", "x-filename-id":"databases-databaseid-delete" } }, "/databases/modifyDb":{ "put":{ "tags":[ "Database" ], "description":"Modifying database parameters", "operationId":"modifyDb", "parameters":[ { "in":"body", "name":"body", "description":"Database parameters", "required":true, "schema":{ "$ref":"#/definitions/DBModificationRequest" } }, { "$ref":"#/parameters/IdempotencyToken" } ], "responses":{ "200":{ "description":"Database modification state.", "schema":{ "$ref":"#/definitions/ServiceJobReport" } }, "default":{ "$ref":"#/responses/Exception" } }, "summary":"Modifying database parameters", "x-internal-id":"databases-modifyDb-put", "x-filename-id":"databases-modifydb-put" } }, "/dbhomes":{ "get":{ "tags":[ "Database" ], "summary":"Get database homes", "description":"Get the list of Oracle Database Homes on the system", "operationId":"listDatabaseHomes", "parameters":[ { "$ref":"#/parameters/ShowAllQueryParam" } ], "responses":{ "200":{ "description":"OK", "schema":{ "type":"array", "items":{ "$ref":"#/definitions/DbHome" } } }, "default":{ "$ref":"#/responses/Exception" } }, "x-internal-id":"dbhomes-get", "x-filename-id":"dbhomes-get" }, "post":{ "tags":[ "Database" ], "summary":"Create database home", "description":"Creates a new database home for Oracle Database with the supplied parameters", "operationId":"createDatabaseHome", "parameters":[ { "in":"body", "name":"body", "description":"Database Home parameters", "required":true, "schema":{ "$ref":"#/definitions/DbHomeRequest" } }, { "$ref":"#/parameters/IdempotencyToken" } ], "responses":{ "200":{ "description":"database deployment state.", "schema":{ "$ref":"#/definitions/ServiceJobReport" } }, "default":{ "$ref":"#/responses/Exception" } }, "x-internal-id":"dbhomes-post", "x-filename-id":"dbhomes-post" } }, "/dbhomes/name/{dbhomeName}":{ "get":{ "tags":[ "Database" ], "summary":"Get database home by name", "description":"Get details about the Oracle Database Home given the Database Home Name", "operationId":"getDatabaseHomeByName", "parameters":[ { "$ref":"#/parameters/DbHomeNamePathParam" } ], "responses":{ "200":{ "description":"OK", "schema":{ "$ref":"#/definitions/DbHome" } }, "default":{ "$ref":"#/responses/Exception" } }, "x-internal-id":"dbhomes-name-{dbhomeName}-get", "x-filename-id":"dbhomes-name-dbhomename-get" }, "delete":{ "tags":[ "Database" ], "summary":"Deletes database home by name", "description":"Deletes Oracle home that is not associated with a database. Note that, to delete, or uninstall, an Oracle home by database home name, there must not be any associated databases in the Oracle home.", "operationId":"deleteDbHomeByName", "parameters":[ { "$ref":"#/parameters/DbHomeNamePathParam" }, { "$ref":"#/parameters/IdempotencyToken" } ], "responses":{ "200":{ "description":"Database Home delete state" }, "default":{ "$ref":"#/responses/Exception" } }, "x-internal-id":"dbhomes-name-{dbhomeName}-delete", "x-filename-id":"dbhomes-name-dbhomename-delete" }, "put":{ "tags":[ "Database" ], "summary":"Patch database home by name with available patch", "description":"Patches Oracle home that is associated with a database. Note that, to patch an Oracle home by database home name, there must be some associated databases in the Oracle home.", "operationId":"updateDbHomeByName", "parameters":[ { "$ref":"#/parameters/DbHomeNamePathParam" }, { "in":"body", "name":"body", "description":"patching parameters", "required":true, "schema":{ "$ref":"#/definitions/DbHomePatchingRequest" } }, { "$ref":"#/parameters/IdempotencyToken" } ], "responses":{ "200":{ "description":"update Database Home status", "schema":{ "$ref":"#/definitions/ServiceJobReport" } }, "default":{ "$ref":"#/responses/Exception" } }, "x-internal-id":"dbhomes-name-{dbhomeName}-put", "x-filename-id":"dbhomes-name-dbhomename-put" } }, "/dbhomes/{dbhomeId}":{ "get":{ "tags":[ "Database" ], "summary":"Get database home by ID", "description":"Get details about the Oracle Database Home given the Database Home Identifier", "operationId":"getDatabaseHome", "parameters":[ { "$ref":"#/parameters/DbHomeIdPathParam" } ], "responses":{ "200":{ "description":"OK", "schema":{ "$ref":"#/definitions/DbHome" } }, "default":{ "$ref":"#/responses/Exception" } }, "x-internal-id":"dbhomes-{dbhomeId}-get", "x-filename-id":"dbhomes-dbhomeid-get" }, "put":{ "tags":[ "Database" ], "description":"Patch Database Home with available patch", "operationId":"updateDbHome", "parameters":[ { "$ref":"#/parameters/DbHomeIdPathParam" }, { "in":"body", "name":"body", "description":"patching parameters parameters", "required":true, "schema":{ "$ref":"#/definitions/DbHomePatchingRequest" } }, { "$ref":"#/parameters/IdempotencyToken" } ], "responses":{ "200":{ "description":"update Database Home status.", "schema":{ "$ref":"#/definitions/ServiceJobReport" } }, "default":{ "$ref":"#/responses/Exception" } }, "summary":"Patch Database Home with available patch", "x-internal-id":"dbhomes-{dbhomeId}-put", "x-filename-id":"dbhomes-dbhomeid-put" }, "delete":{ "tags":[ "Database" ], "summary":"Deletes database home by ID", "description":"Deletes Oracle home that is not associated with a database. Note that, to delete, or uninstall, an Oracle home by database home ID, there must not be any associated databases in the Oracle home.", "operationId":"deleteDbHome", "parameters":[ { "$ref":"#/parameters/DbHomeIdPathParam" }, { "$ref":"#/parameters/IdempotencyToken" } ], "responses":{ "200":{ "description":"Database Home delete state." }, "default":{ "$ref":"#/responses/Exception" } }, "x-internal-id":"dbhomes-{dbhomeId}-delete", "x-filename-id":"dbhomes-dbhomeid-delete" } }, "/dbshapes":{ "get":{ "tags":[ "General" ], "summary":"Get database shapes", "description":"Get the available database shapes based on the parameters like dbVersion, dbEdition and dbClass", "operationId":"getDbShapes", "parameters":[ { "$ref":"#/parameters/DbVersionQueryParam" }, { "$ref":"#/parameters/DbEditionQueryParam" }, { "$ref":"#/parameters/DbClassQueryParam" }, { "$ref":"#/parameters/DbHomeIdQueryParam" } ], "responses":{ "200":{ "description":"OK", "schema":{ "type":"array", "items":{ "$ref":"#/definitions/DbShape" } } }, "default":{ "$ref":"#/responses/Exception" } }, "x-internal-id":"dbshapes-get", "x-filename-id":"dbshapes-get" } }, "/jobs":{ "get":{ "tags":[ "General" ], "summary":"Get jobs", "description":"List all jobs, job details and status of each job. Job details includes the job IDs, status, the job created date and time stamp, etc. Use optional parameters to filter the job results", "operationId":"getJobsList", "parameters":[ { "$ref":"#/parameters/CountQueryParam" }, { "$ref":"#/parameters/TailQueryParam" }, { "$ref":"#/parameters/HeadQueryParam" }, { "$ref":"#/parameters/DescriptionQueryParam" }, { "$ref":"#/parameters/NotMatchDescriptionQueryParam" }, { "$ref":"#/parameters/StatusQueryParam" }, { "$ref":"#/parameters/FromQueryParam" }, { "$ref":"#/parameters/ToQueryParam" }, { "$ref":"#/parameters/ForQueryParam" }, { "$ref":"#/parameters/ECQueryParam" }, { "$ref":"#/parameters/AllJobsQueryParam" }, { "$ref":"#/parameters/LastQueryParam" }, { "$ref":"#/parameters/MessageQueryParam" }, { "$ref":"#/parameters/NotMatchMessageQueryParam" } ], "responses":{ "200":{ "description":"Ok", "schema":{ "type":"array", "items":{ "$ref":"#/definitions/ServiceJobReportSummary" } } }, "default":{ "$ref":"#/responses/Exception" } }, "x-internal-id":"jobs-get", "x-filename-id":"jobs-get" } }, "/jobs/pending":{ "get":{ "tags":[ "General" ], "summary":"Get pending jobs", "description":"List all pending jobs which are submitted, but not completed", "operationId":"getPendingJobsList", "parameters":[ { "$ref":"#/parameters/CountQueryParam" } ], "responses":{ "200":{ "description":"Ok", "schema":{ "type":"array", "items":{ "$ref":"#/definitions/ServiceJobReportSummary" } } }, "default":{ "$ref":"#/responses/Exception" } }, "x-internal-id":"jobs-pending-get", "x-filename-id":"jobs-pending-get" } }, "/jobs/{jobId}":{ "get":{ "tags":[ "General" ], "summary":"Get job by ID", "description":"Describe job details and job status by job ID. Job details includes the job ID, status, the job created date and time stamp, etc.", "operationId":"getJobDetail", "parameters":[ { "$ref":"#/parameters/JobIdPathParam" } ], "responses":{ "200":{ "description":"job details", "schema":{ "$ref":"#/definitions/ServiceJobReport" } }, "default":{ "$ref":"#/responses/Exception" } }, "x-internal-id":"jobs-{jobId}-get", "x-filename-id":"jobs-jobid-get" } }, "/objectstoreswifts":{ "get":{ "tags":[ "ObjectStoreSwift" ], "summary":"Get ObjectStoreSwift objects by name", "description":"List Oracle object store details. When Object Store Swift object name is null, it will list details of all the Oracle object store details. Otherwise, it lists the details of the Oracle object store matching the object name supplied", "operationId":"listObjectStoreSwifts", "parameters":[ { "$ref":"#/parameters/ObjectStoreSwiftNameQueryParam" } ], "responses":{ "200":{ "description":"swift Object stores list using name filter", "schema":{ "type":"array", "items":{ "$ref":"#/definitions/ObjectStoreSwift" } } }, "default":{ "$ref":"#/responses/Exception" } }, "x-internal-id":"objectstoreswifts-get", "x-filename-id":"objectstoreswifts-get" }, "post":{ "tags":[ "ObjectStoreSwift" ], "summary":"Create ObjectStoreSwift object", "description":"Create and store the credentials required to backup to the Oracle object store", "operationId":"createObjectStoreSwift", "parameters":[ { "in":"body", "name":"body", "description":"Object store creation parameters", "required":true, "schema":{ "$ref":"#/definitions/ObjectStoreSwiftRequest" } }, { "$ref":"#/parameters/IdempotencyToken" } ], "responses":{ "200":{ "description":"Object Store state.", "schema":{ "$ref":"#/definitions/ServiceJobReport" } }, "default":{ "$ref":"#/responses/Exception" } }, "x-internal-id":"objectstoreswifts-post", "x-filename-id":"objectstoreswifts-post" }, "put":{ "tags":[ "ObjectStoreSwift" ], "summary":"Update ObjectStoreSwift object by name", "description":"Update the credentials for the Oracle object store matching the supplied object store swift object name", "operationId":"updateObjectStoreSwiftUsingName", "parameters":[ { "$ref":"#/parameters/ObjectStoreSwiftNameQueryParam" }, { "in":"body", "name":"body", "description":"Modify Object Store parameters", "required":true, "schema":{ "$ref":"#/definitions/ObjectStoreSwiftUpdateRequest" } }, { "$ref":"#/parameters/IdempotencyToken" } ], "responses":{ "200":{ "description":"Modify Object Store status using name filter.", "schema":{ "$ref":"#/definitions/ServiceJobReport" } }, "default":{ "$ref":"#/responses/Exception" } }, "x-internal-id":"objectstoreswifts-put", "x-filename-id":"objectstoreswifts-put" }, "delete":{ "tags":[ "ObjectStoreSwift" ], "summary":"Deletes ObjectStoreSwift object by name", "description":"Deletes the credentials of the Oracle object store by supplying object store swift object name", "operationId":"deleteObjectStoreSwiftUsingName", "parameters":[ { "$ref":"#/parameters/ObjectStoreSwiftNameQueryParam" }, { "$ref":"#/parameters/IdempotencyToken" } ], "responses":{ "200":{ "description":"Deletes object store delete state using name filter." }, "default":{ "$ref":"#/responses/Exception" } }, "x-internal-id":"objectstoreswifts-delete", "x-filename-id":"objectstoreswifts-delete" } }, "/objectstoreswifts/{objectstoreswiftId}":{ "get":{ "tags":[ "ObjectStoreSwift" ], "summary":"Get ObjectStoreSwift object by ID", "description":"Describe Oracle object store details by supplying object store swift object ID", "operationId":"getObjectStoreSwift", "parameters":[ { "$ref":"#/parameters/ObjectStoreSwiftIdPathParam" } ], "responses":{ "200":{ "description":"object store details", "schema":{ "$ref":"#/definitions/ObjectStoreSwift" } }, "default":{ "$ref":"#/responses/Exception" } }, "x-internal-id":"objectstoreswifts-{objectstoreswiftId}-get", "x-filename-id":"objectstoreswifts-objectstoreswiftid-get" }, "put":{ "tags":[ "ObjectStoreSwift" ], "summary":"Update ObjectStoreSwift object by ID", "description":"Update the credentials for the Oracle object store matching the supplied object store swift object Id", "operationId":"updateObjectStoreSwift", "parameters":[ { "$ref":"#/parameters/ObjectStoreSwiftIdPathParam" }, { "in":"body", "name":"body", "description":"Modify Object Store parameters", "required":true, "schema":{ "$ref":"#/definitions/ObjectStoreSwiftUpdateRequest" } }, { "$ref":"#/parameters/IdempotencyToken" } ], "responses":{ "200":{ "description":"Modify Object Store status.", "schema":{ "$ref":"#/definitions/ServiceJobReport" } }, "default":{ "$ref":"#/responses/Exception" } }, "x-internal-id":"objectstoreswifts-{objectstoreswiftId}-put", "x-filename-id":"objectstoreswifts-objectstoreswiftid-put" }, "delete":{ "tags":[ "ObjectStoreSwift" ], "summary":"Deletes ObjectStoreSwift object by ID", "description":"Deletes the credentials for the Oracle object store by supplying object store swift object ID", "operationId":"deleteObjectStoreSwift", "parameters":[ { "$ref":"#/parameters/ObjectStoreSwiftIdPathParam" }, { "$ref":"#/parameters/IdempotencyToken" } ], "responses":{ "200":{ "description":"Deletes object store delete state." }, "default":{ "$ref":"#/responses/Exception" } }, "x-internal-id":"objectstoreswifts-{objectstoreswiftId}-delete", "x-filename-id":"objectstoreswifts-objectstoreswiftid-delete" } }, "/kvm/vm":{ "get":{ "tags":[ "KVM Database System" ], "description":"Gets all VMs", "operationId":"getAllVms", "responses":{ "200":{ "description":"OK", "schema":{ "type":"array", "items":{ "$ref":"#/definitions/Vm" } } }, "default":{ "$ref":"#/responses/Exception" } }, "summary":"Gets all VMs", "x-internal-id":"kvm-vm-get", "x-filename-id":"kvm-vm-get" }, "post":{ "tags":[ "KVM Database System" ], "summary":"Creates a new VM", "description":"Creates a new VM in Oracle Database Appliance using VmCreateParams. Pre-requisites - Ensure VM Storage and VM CPU Pool are present in the system.", "operationId":"createVm", "parameters":[ { "in":"body", "name":"params", "description":"Parameters to create a VM", "required":true, "schema":{ "$ref":"#/definitions/VmCreateParams" } } ], "responses":{ "200":{ "description":"OK", "schema":{ "$ref":"#/definitions/KvmJob" } }, "default":{ "$ref":"#/responses/Exception" } }, "x-internal-id":"kvm-vm-post", "x-filename-id":"kvm-vm-post" } }, "/dbsystem":{ "get":{ "tags":[ "KVM Database System" ], "summary":"Get all the KVM DB systems", "description":"Get all the KVM DB systems present in the system.", "operationId":"getAllDbSystems", "parameters":[ { "name":"metadataOnly", "in":"query", "type":"boolean", "required":false, "description":"Specify whether or not to add extra information to the response, apart from the metadata" } ], "responses":{ "200":{ "description":"OK", "schema":{ "type":"array", "items":{ "$ref":"#/definitions/DbSystem" } } }, "default":{ "$ref":"#/responses/Exception" } }, "x-internal-id":"dbsystem-get", "x-filename-id":"dbsystem-get" }, "post":{ "tags":[ "KVM Database System" ], "summary":"Create KVM DB System", "description":"Create a new KVM DB System in Oracle Database Appliance using DbSystemCreateParams. Make sure Oracle Database Appliance KVM DB System Image is downloaded and the repository is updated with the image first.", "operationId":"createDbSystem", "parameters":[ { "in":"body", "name":"params", "description":"Parameters to create a DB System", "required":true, "schema":{ "$ref":"#/definitions/DbSystemCreateParams" } } ], "responses":{ "200":{ "description":"OK", "schema":{ "$ref":"#/definitions/KvmJob" } }, "default":{ "$ref":"#/responses/Exception" } }, "x-internal-id":"dbsystem-post", "x-filename-id":"dbsystem-post" } } }, "parameters":{ "DatabaseNameQueryParam":{ "name":"dbName", "in":"query", "description":"database Name", "type":"string", "required":false }, "ToQueryParam":{ "name":"to", "in":"query", "description":"job created on and before a specific date", "type":"string", "required":false }, "DescriptionQueryParam":{ "name":"descriptionPattern", "in":"query", "description":"filter jobs by their description", "type":"string", "required":false }, "IncludeLocalEntityQueryParam":{ "name":"includeLocalEntity", "in":"query", "type":"boolean", "default":true, "required":false, "description":"include local entities" }, "DbClassQueryParam":{ "name":"dbClass", "in":"query", "description":"Database Class (OLTP/DSS/IMDB)", "type":"string", "required":false }, "NotMatchMessageQueryParam":{ "name":"notMatchMessagePattern", "in":"query", "description":"filter jobs that do not match their message", "type":"string", "required":false }, "LastQueryParam":{ "name":"last", "in":"query", "description":"jobs created until a certain time", "type":"string", "required":false }, "DbvmNamesSourceQueryParam":{ "name":"dbvms", "in":"query", "required":false, "type":"string", "description":"DBVMs where the entity comes from. Name list is delimited by comma, like 's1,s2'." }, "ObjectStoreSwiftIdPathParam":{ "name":"objectstoreswiftId", "in":"path", "type":"string", "required":true, "description":"object store ID" }, "TailQueryParam":{ "name":"tail", "in":"query", "description":"Get the number of latest jobs", "type":"integer", "required":false, "minimum":1, "maximum":200 }, "FromQueryParam":{ "name":"from", "in":"query", "description":"job created on and after a specific date", "type":"string", "required":false }, "DbHomeNamePathParam":{ "name":"dbhomeName", "in":"path", "description":"database home Name", "type":"string", "required":true }, "CountQueryParam":{ "name":"count", "in":"query", "description":"Get the number of last events", "type":"integer", "required":false, "default":100, "maximum":200 }, "ForceDelete":{ "name":"forceEnable", "in":"header", "required":false, "description":"A flag to specify whether force delete is enabled", "type":"string" }, "DbHomeIdQueryParam":{ "name":"dbhomeId", "in":"query", "description":"Database Home ID", "type":"string", "required":false }, "ECQueryParam":{ "name":"ec", "in":"query", "description":"jobs created by Error Correlation framework", "type":"boolean", "required":false }, "DatabaseUniqueNameQueryParam":{ "name":"dbUniqueName", "in":"query", "description":"database unique name", "type":"string", "required":false }, "DbHomeIdPathParam":{ "name":"dbhomeId", "in":"path", "type":"string", "required":true, "description":"database home ID" }, "HeadQueryParam":{ "name":"head", "in":"query", "description":"Get the number of oldest jobs", "type":"integer", "required":false, "minimum":1, "maximum":200 }, "DatabaseIdPathParam":{ "name":"databaseId", "in":"path", "type":"string", "required":true, "description":"database ID" }, "ForQueryParam":{ "name":"for", "in":"query", "description":"job created on a specific date", "type":"string", "required":false }, "AllJobsQueryParam":{ "name":"all", "in":"query", "description":"jobs created by both DCS and Error Correlation framework", "type":"boolean", "required":false }, "ShowAllQueryParam":{ "name":"showAll", "in":"query", "type":"boolean", "default":false, "required":false, "description":"show all instances of an entity in the system" }, "DbEditionQueryParam":{ "name":"dbEdition", "in":"query", "description":"Database Edition (SE/EE)", "type":"string", "required":false }, "NotMatchDescriptionQueryParam":{ "name":"notMatchDescriptionPattern", "in":"query", "description":"filter jobs that do not match their description", "type":"string", "required":false }, "StatusQueryParam":{ "name":"status", "in":"query", "description":"job status", "type":"string", "required":false }, "IdempotencyToken":{ "name":"opc-idempotency-token", "type":"string", "in":"header", "description":"A user-supplied token that uniquely identifies a request. A single request will be acted upon among many requests that share the same token. Idempotency tokens expire after 30 minutes.", "minLength":1, "maxLength":64 }, "JobIdPathParam":{ "name":"jobId", "in":"path", "type":"string", "required":true, "description":"job ID" }, "DbVersionQueryParam":{ "name":"dbVersion", "in":"query", "description":"Database Version (11.2/12.1/12.2)", "type":"string", "required":false }, "RetainOKVWallets":{ "name":"retainOKVWallets", "in":"header", "required":false, "description":"A flag to specify whether retain wallets on OKV server is enabled", "type":"string" }, "MessageQueryParam":{ "name":"messagePattern", "in":"query", "description":"filter jobs by their message", "type":"string", "required":false }, "IncludeDBVMEntityQueryParam":{ "name":"includeDBVMEntity", "in":"query", "type":"boolean", "default":false, "required":false, "description":"include DBVM entities" }, "PluggableDatabaseNameQueryParam":{ "name":"pdbName", "in":"query", "description":"Pluggable database Name", "type":"string", "required":false }, "ObjectStoreSwiftNameQueryParam":{ "name":"objstrName", "in":"query", "description":"Objectstoreswift Name", "type":"string", "required":false } }, "definitions":{ "VmConfigCpuDetail":{ "type":"object", "properties":{ "vCpuId":{ "type":"integer" }, "effectiveCpuSet":{ "type":"string" }, "pinned":{ "type":"boolean" } } }, "TaskReport":{ "properties":{ "taskId":{ "type":"string" }, "taskName":{ "type":"string" }, "nodeName":{ "type":"string" }, "taskResult":{ "type":"string" }, "startTime":{ "type":"string", "format":"date-time" }, "endTime":{ "type":"string", "format":"date-time" }, "duration":{ "type":"string" }, "status":{ "type":"string", "enum":[ "Created", "Scheduled", "Running", "Success", "Failure", "Retrying", "Waiting", "InternalError", "Reverting", "Reverted", "NodeDisconnectedFailure", "Skipped" ] }, "taskDescription":{ "type":"string" }, "parentTaskId":{ "type":"string" }, "jobId":{ "type":"string" }, "tags":{ "type":"array", "items":{ "type":"string" } }, "reportLevel":{ "type":"string", "enum":[ "Verbose", "Info", "Error" ] }, "updatedTime":{ "type":"string", "format":"date-time" } } }, "ObjectStoreSwiftUpdateRequest":{ "description":"Modify Object Store Swift Credentials for the Backup/recovery", "type":"object", "properties":{ "userName":{ "type":"string" }, "swiftPassword":{ "type":"string" } } }, "DbSystemCreateBaseDbParams":{ "type":"object", "properties":{ "bootImageId":{ "type":"string", "description":"ID of the DB System VM image artifact" }, "bootOptions":{ "type":"string", "description":"Boot options for DB System VM" }, "ccVersion":{ "type":"string", "description":"ASM client cluster version" }, "sshKey":{ "type":"string", "description":"SSH key for root user in the DB System VM" }, "databag":{ "type":"string", "description":"Databag to be placed inside DB System VM" }, "bootstrapRpmId":{ "type":"string", "description":"ID of the bootstrap RPM artifact" }, "bootstrapScript":{ "type":"string", "description":"Bootstrap script location within DB System VM" }, "u01Size":{ "type":"string", "description":"Size of the u01 vDisk, defaults to 100G" } } }, "DBUpdateRequest":{ "properties":{ "backupConfigId":{ "type":"string" }, "backupConfigName":{ "type":"string" }, "isAutoBackupDisabled":{ "type":"boolean" }, "rmanBkupPassword":{ "type":"string" }, "dbId":{ "description":"Database Id", "type":"string" }, "level0BackupDay":{ "type":"string", "enum":[ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] }, "isBackupDisabled":{ "type":"boolean" } } }, "DbSystemCpuPool":{ "type":"object", "properties":{ "name":{ "type":"string" }, "type":{ "type":"string" }, "numberOfCores":{ "type":"integer" }, "perNodeAllocations":{ "type":"array", "items":{ "$ref":"#/definitions/CpuPoolNodeAllocation" } } } }, "DbSystemVm":{ "type":"object", "properties":{ "name":{ "type":"string" }, "nodeNumber":{ "type":"integer" }, "currentNodeNumber":{ "type":"integer" }, "nodeName":{ "type":"string" }, "currentNodeName":{ "type":"string" }, "hostName":{ "type":"string" }, "vmSnapshotPath":{ "type":"string" }, "diskImagePath":{ "type":"string" }, "numberOfCores":{ "type":"integer" }, "memorySizeInMb":{ "type":"integer" }, "memorySizeFormatted":{ "type":"string" }, "status":{ "$ref":"#/definitions/VmStatus" }, "disks":{ "type":"array", "items":{ "$ref":"#/definitions/DbSystemDisk" } }, "vnetworks":{ "type":"array", "items":{ "$ref":"#/definitions/DbSystemVNetwork" } }, "customVNetworks":{ "type":"array", "items":{ "$ref":"#/definitions/DbSystemCustomVNetwork" } }, "vdisks":{ "type":"array", "items":{ "$ref":"#/definitions/DbSystemVDisk" } } } }, "VmConfigCpu":{ "type":"object", "properties":{ "vCpuCount":{ "type":"integer" }, "maxVCpuCount":{ "type":"integer" }, "cpuPoolName":{ "type":"string" }, "effectiveCpuSet":{ "type":"string" }, "detail":{ "type":"array", "items":{ "$ref":"#/definitions/VmConfigCpuDetail" } } } }, "DbSystemCreateRestoreDatabaseParams":{ "type":"object", "required":[ "sysPassword", "backupReportDetails", "sourceDetails" ], "properties":{ "backupReportDetails":{ "$ref":"#/definitions/DbSystemCreateRestoreBackupReportDetails" }, "sourceDetails":{ "$ref":"#/definitions/DbSystemCreateRestoreBackupSourceDetails" }, "customization":{ "$ref":"#/definitions/DbSystemCreateRestoreBackupDatabaseCustomization" }, "sysPassword":{ "type":"string", "description":"Admin password of the database." }, "tdePassword":{ "type":"string", "description":"Password used for password protected software keystore" }, "backupPasswords":{ "type":"array", "items":{ "type":"string", "description":"RMAN backup password used to encrypt backups" } }, "numberOfRmanChannels":{ "type":"integer", "description":"Number of RMAN channel that must be used while creating the database from backup" }, "enableForceDelete":{ "type":"boolean", "description":"Deletes the filegroups, FRA and archived logs of database that is getting created from backup, if present" } } }, "DbSystemCustomVNetwork":{ "type":"object", "properties":{ "name":{ "type":"string" }, "vnetworkName":{ "type":"string" }, "dbSystemVmName":{ "type":"string" }, "ipAddress":{ "type":"string" }, "netmask":{ "type":"string" }, "gateway":{ "type":"string" }, "macAddress":{ "type":"string" }, "type":{ "type":"string" } } }, "DbHome":{ "properties":{ "id":{ "type":"string" }, "name":{ "description":"display name for the resource", "type":"string" }, "dbVersion":{ "type":"string" }, "dbHomeLocation":{ "description":"Name of the database home.", "type":"string" }, "dbEdition":{ "description":"Database Home Edition(EE/SE).", "type":"string" }, "unifiedAuditing":{ "description":"Enable unified auditing for the database or not (TRUE/FALSE).", "type":"string" }, "createTime":{ "type":"string", "format":"date-time" }, "state":{ "$ref":"#/definitions/ResourceState" }, "updatedTime":{ "type":"string", "format":"date-time" } } }, "QuotaSpec":{ "type":"object", "properties":{ "diskGroupName":{ "type":"string", "description":"Name of the diskgroup" }, "quota":{ "type":"string", "description":"Quota for the diskgroup" } } }, "DbSystemCreateGroupParams":{ "type":"object", "required":[ "id", "name", "role" ], "properties":{ "id":{ "type":"integer", "description":"ID for the group" }, "name":{ "type":"string", "description":"Name for the group" }, "role":{ "type":"string", "description":"Role for the group" } } }, "DbSystemCreateNetworkParams":{ "type":"object", "required":[ "domainName", "ntpServers", "dnsServers", "nodes" ], "properties":{ "domainName":{ "type":"string", "description":"Domain name of the network" }, "ntpServers":{ "type":"array", "description":"NTP servers of the network", "items":{ "type":"string" } }, "dnsServers":{ "type":"array", "description":"DNS servers of the network", "items":{ "type":"string" } }, "scanName":{ "type":"string", "description":"SCAN name for the DB system database" }, "scanIps":{ "type":"array", "description":"SCAN IPs for the DB system database", "items":{ "type":"string" } }, "nodes":{ "type":"array", "items":{ "$ref":"#/definitions/DbSystemCreateNetworkNodeParams" } }, "publicVNetwork":{ "description":"Name of the public virtual network", "type":"string" }, "clusterInterconnect":{ "$ref":"#/definitions/DbSystemClusterInterconnect" } } }, "DbSystemCreateRestoreBackupDatabaseCustomization":{ "type":"object", "description":"Database parameters that can be customized for restored database within a new DB System", "properties":{ "dbName":{ "type":"string", "description":"Name of the database" }, "dbUniqueName":{ "type":"string", "description":"Unique name of the database" }, "dbClass":{ "type":"string", "description":"Class of the database (OLTP|DSS|IMDB)" }, "dbType":{ "type":"string", "description":"Type of the database (RAC|RACOne|SI)" }, "dbEdition":{ "type":"string", "description":"Edition of the database (SE|EE)" }, "dbRedundancy":{ "type":"string", "description":"Redundancy of the database" }, "dbDomainName":{ "type":"string", "description":"Domain name of the database" }, "dbShape":{ "type":"string", "description":"Shape of the database (odb1s|odb1|odb2|odb4|odb6| odb8|odb10|odb12|odb16|odb20|odb24|odb28|odb32| odb36|odb42|odb48|odb56|odb64)" }, "dbConsoleEnable":{ "type":"boolean", "description":"Whether or not the database console is enabled" }, "enableSEHA":{ "description":"Enable HA for SE for 19c and later SI database", "type":"boolean" }, "enableEEHA":{ "description":"Enable HA for EE SI database", "type":"boolean" }, "backupLocation":{ "type":"string", "description":"Database backup location" }, "tdeFilesLocation":{ "type":"string", "description":"TDE wallet backup location" } } }, "DbHomeRequest":{ "properties":{ "dbVersion":{ "type":"string" }, "dbEdition":{ "description":"Database Home Edition(EE/SE).", "type":"string" }, "unifiedAuditing":{ "description":"Enable unified auditing for the database or not (TRUE/FALSE).", "type":"string" } } }, "DB":{ "properties":{ "id":{ "type":"string" }, "name":{ "description":"display name for the resource", "type":"string" }, "dbName":{ "type":"string" }, "databaseUniqueName":{ "type":"string" }, "dbVersion":{ "type":"string" }, "dbHomeId":{ "description":"The database home resource identifier for associating this database.", "type":"string" }, "instanceOnly":{ "description":"do not create the database files. Used in case of standby case to create standby instance.", "type":"boolean" }, "registerOnly":{ "description":"Use to migrate existing database", "type":"boolean" }, "dbId":{ "description":"The database id", "type":"string" }, "isCdb":{ "type":"boolean" }, "isAutoBackupDisabled":{ "type":"boolean" }, "pdBName":{ "type":"string" }, "pdbAdminUserName":{ "type":"string" }, "pdbs":{ "description":"List of PDB objects that are present in the CDB", "type":"array", "items":{ "$ref":"#/definitions/Pdb" } }, "enableTDE":{ "type":"boolean", "description":"Flag to create TDE enabled database" }, "tdeWalletManagement":{ "description":"Specify wallet management method for TDE enabled database. Allowed values are ODA and EXTERNAL.", "type":"string" }, "dbType":{ "type":"string", "enum":[ "RAC", "RACOne", "SI" ] }, "dbRole":{ "description":"Database role (PRIMARY/STANDBY).", "type":"string" }, "dbTargetNodeNumber":{ "type":"string" }, "dbClass":{ "type":"string", "enum":[ "OLTP", "DSS", "IMDB" ] }, "dbShape":{ "type":"string", "enum":[ "odb1s", "odb1", "odb2", "odb4", "odb6", "odb8", "odb10", "odb12", "odb16", "odb20", "odb24", "odb28", "odb32", "odb36", "odb42", "odb48", "odb56", "odb64" ] }, "dbStorage":{ "type":"string", "enum":[ "ASM", "ACFS", "PMEM" ] }, "dbRedundancy":{ "type":"string" }, "quota":{ "type":"string", "description":"disk space quota for a database." }, "dbCharacterSet":{ "$ref":"#/definitions/DbCharacterSet" }, "dbConsoleEnable":{ "type":"boolean" }, "backupConfigId":{ "type":"string" }, "cloudStorageContainer":{ "type":"string", "description":"if the object store backup is selected, then which container should the database backup go to." }, "state":{ "$ref":"#/definitions/ResourceState" }, "createTime":{ "type":"string", "format":"date-time" }, "updatedTime":{ "type":"string", "format":"date-time" }, "rmanBkupPassword":{ "type":"string" }, "dbEdition":{ "description":"Database Edition.", "type":"string" }, "dbDomainName":{ "type":"string" }, "level0BackupDay":{ "type":"string", "enum":[ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] }, "isBcfgInSync":{ "type":"boolean" }, "associatedNetworks":{ "type":"array", "items":{ "type":"string" } }, "enableSEHA":{ "type":"boolean" }, "enableEEHA":{ "description":"Enable HA for EE SI database", "type":"boolean" }, "dbTargetNodeName":{ "type":"string" }, "cpupool":{ "description":"Defines the CPU Pool name", "type":"string" }, "entitySource":{ "description":"Where the database is created. Null for local system.", "type":"string" }, "remark":{ "description":"Remark for database status", "type":"string" }, "keystoreType":{ "description":"Type of keystore, which stores TDE Master Encryption Key. Either Software or OKV. Default is Software", "type":"string" }, "okvServerConfigName":{ "description":"Name of the OKV Server Config object which represents the metadata of OKV server where TDE Master Encryption Keys are stored", "type":"string" } } }, "DbSystemCreateRestoreBackupReportDetails":{ "type":"object", "description":"Details of the backup report that must be used to restore the database within a new DB System", "properties":{ "backupReportId":{ "type":"string", "description":"ODA resource ID of the backup report" }, "backupReportPath":{ "type":"string", "description":"Path of the backup report JSON file present in local Bare Metal" }, "backupReport":{ "$ref":"#/definitions/BackupReport" } } }, "DbSystemCreateRestoreBackupSourceDetails":{ "type":"object", "description":"Details of the backup and its destination", "properties":{ "objectStoreDetails":{ "$ref":"#/definitions/DbSystemCreateRestoreBackupObjectStoreDetails" }, "nfsDetails":{ "$ref":"#/definitions/DbSystemCreateRestoreBackupNfsDetails" }, "tdeEnabled":{ "type":"boolean", "description":"Flag to indicate backups are encryted using TDE enabled" }, "rmanBackupEncrypted":{ "type":"boolean", "description":"Flag to indicate backups are encrypted by RMAN." } } }, "DbSystemCreateNetworkNodeParams":{ "type":"object", "required":[ "number", "name", "ipAddress", "netmask", "gateway" ], "properties":{ "number":{ "type":"integer", "description":"Number of the DB system node" }, "name":{ "type":"string", "description":"Name of the DB system node" }, "ipAddress":{ "type":"string", "description":"IP address of the DB system node" }, "netmask":{ "type":"string", "description":"Netmask of the DB system node" }, "gateway":{ "type":"string", "description":"Gateway of the DB system node" }, "vipName":{ "type":"string", "description":"Virtual IP name of the DB system node" }, "vipAddress":{ "type":"string", "description":"Virtual IP address of the DB system node" } } }, "DbSystemClusterInterconnect":{ "type":"object", "required":[ "vlanId", "gateway", "subnet", "interfaceName" ], "properties":{ "vlanId":{ "type":"string", "description":"vlan id for the Cluster Interconnect" }, "gateway":{ "type":"string", "description":"gateway address for Cluster Interconnect" }, "subnet":{ "type":"string", "description":"subnet mask for Cluster Interconnect" }, "interfaceName":{ "type":"string", "description":"interface for Cluster Interconnect" } } }, "DbShape":{ "properties":{ "name":{ "type":"string" }, "cpuCores":{ "type":"string" }, "memorySize":{ "type":"string" } } }, "Error":{ "required":[ "code", "message" ], "properties":{ "code":{ "type":"string" }, "message":{ "type":"string" } } }, "DbSystemCreateDbHomeParams":{ "type":"object", "required":[ "version" ], "properties":{ "version":{ "type":"string", "description":"Version of the database home" }, "edition":{ "type":"string", "description":"Edition of the database home (SE|EE)", "enum":[ "SE", "EE" ] }, "enableUnifiedAuditing":{ "type":"boolean", "description":"Whether or not enable unified auditing" } } }, "CpuPoolNodeAllocation":{ "type":"object", "properties":{ "nodeName":{ "type":"string" }, "effectiveCpuSet":{ "type":"string" }, "cpus":{ "type":"array", "items":{ "$ref":"#/definitions/PhysicalCpu" } } } }, "DbSystemCreateIdmParams":{ "properties":{ "isMultiUserAccessEnabled":{ "type":"boolean", "description":"Set this flag to true to enable multi user access on this environment." }, "isMultiUserAccessPLEnabled":{ "type":"boolean", "description":"Set this flag to true to enable passwordless multi user access on this environment." }, "userCredentials":{ "$ref":"#/definitions/DbSystemCreateIdmUserCredentialsParams" }, "configurations":{ "$ref":"#/definitions/DbSystemCreateIdmConfigurationsParams" } } }, "VmVDisk":{ "type":"object", "properties":{ "vDiskName":{ "type":"string" }, "vmName":{ "type":"string" }, "targetDev":{ "type":"string" }, "dbSystemName":{ "type":"string" } } }, "DbSystemDisk":{ "type":"object", "properties":{ "name":{ "type":"string" }, "devicePath":{ "type":"string" }, "targetDevice":{ "type":"string" } } }, "ServiceJobReportSummary":{ "description":"Job Request summary", "properties":{ "jobId":{ "type":"string" }, "status":{ "type":"string", "enum":[ "Created", "Scheduled", "Running", "Success", "Failure", "Retrying", "Waiting", "InternalError", "Reverting", "Reverted", "NodeDisconnectedFailure" ] }, "message":{ "type":"string" }, "createTimestamp":{ "type":"string", "format":"date-time" }, "duration":{ "type":"string" }, "description":{ "type":"string" }, "jobType":{ "type":"string" } } }, "DbSystemCreateRoleSeparationParams":{ "type":"object", "required":[ "groups", "users" ], "properties":{ "groups":{ "type":"array", "items":{ "$ref":"#/definitions/DbSystemCreateGroupParams" } }, "users":{ "type":"array", "items":{ "$ref":"#/definitions/DbSystemCreateUserParams" } } } }, "DbHomePatchingRequest":{ "properties":{ "version":{ "type":"string", "description":"patch version or patch release version" }, "local":{ "type":"boolean", "description":"local flag to patch only local system. By default it will be false." }, "precheck":{ "type":"boolean", "description":"option to not apply the patch but just to analyze the patch" }, "nodeName":{ "type":"string", "description":"Node name to support remote node patching" }, "force":{ "type":"boolean", "description":"force flag to force patching. By default it will be false." }, "ignoreMissingPatches":{ "type":"boolean", "description":"force flag to ignore all missing patches and force patching. By default it will be false." } } }, "DbSystemCreateParams":{ "type":"object", "required":[ "system", "network" ], "properties":{ "system":{ "$ref":"#/definitions/DbSystemCreateSystemParams" }, "network":{ "$ref":"#/definitions/DbSystemCreateNetworkParams" }, "grid":{ "$ref":"#/definitions/DbSystemCreateGridParams" }, "dbHome":{ "$ref":"#/definitions/DbSystemCreateDbHomeParams" }, "database":{ "$ref":"#/definitions/DbSystemCreateDatabaseParams" }, "restoreDatabase":{ "$ref":"#/definitions/DbSystemCreateRestoreDatabaseParams" }, "baseDb":{ "$ref":"#/definitions/DbSystemCreateBaseDbParams" }, "forced":{ "type":"boolean", "description":"Whether or not to force the DB System create operation" } } }, "JobResourceInfo":{ "description":"resource information", "properties":{ "resourceId":{ "type":"string" }, "resourceType":{ "type":"string", "enum":[ "Backup", "BackupConfig", "DB", "DbHome", "Grid", "Pdb", "Recovery", "Report", "Tde", "ObjectStoreSwift" ] }, "resourceNewType":{ "type":"string" }, "jobId":{ "type":"string" }, "updatedTime":{ "type":"string", "format":"date-time" } } }, "DbSystemVDisk":{ "type":"object", "properties":{ "name":{ "type":"string" }, "vdiskName":{ "type":"string" }, "dbSystemVmName":{ "type":"string" }, "targetDevice":{ "type":"string" } } }, "DbSystem":{ "type":"object", "properties":{ "id":{ "type":"string" }, "name":{ "type":"string" }, "state":{ "type":"string" }, "createTime":{ "type":"string", "format":"date-time" }, "updateTime":{ "type":"string", "format":"date-time" }, "image":{ "type":"string" }, "version":{ "type":"string" }, "shapeName":{ "type":"string" }, "clusterName":{ "type":"string" }, "numaEnabled":{ "type":"boolean" }, "freeformTags":{ "type":"string" }, "storage":{ "$ref":"#/definitions/DbSystemStorage" }, "extraStorages":{ "type":"array", "items":{ "$ref":"#/definitions/DbSystemStorage" } }, "cpuPool":{ "$ref":"#/definitions/DbSystemCpuPool" }, "vms":{ "type":"array", "items":{ "$ref":"#/definitions/DbSystemVm" } }, "databases":{ "type":"array", "items":{ "$ref":"#/definitions/DB" } }, "gridHome":{ "$ref":"#/definitions/DbSystemGridHome" }, "idmInfo":{ "$ref":"#/definitions/DbSystemIdmConfig" } } }, "ResourceState":{ "properties":{ "status":{ "type":"string", "enum":[ "CREATING", "CONFIGURED", "UPDATING", "DELETING", "FAILED", "RUNNING", "ENABLED", "DISABLED", "STALE" ] } } }, "ObjectStoreSwiftRequest":{ "description":"Object Store swift details for the Backup/recovery", "type":"object", "properties":{ "name":{ "type":"string" }, "tenantName":{ "type":"string" }, "userName":{ "type":"string" }, "endpointUrl":{ "type":"string" }, "swiftPassword":{ "type":"string" } } }, "DbSystemGridHome":{ "type":"object", "properties":{ "name":{ "type":"string" }, "version":{ "type":"string" }, "location":{ "type":"string" } } }, "DbSystemIdmConfig":{ "type":"object", "properties":{ "idmState":{ "type":"string" }, "dcsUserPasswdExpDurationInDays":{ "type":"integer" }, "tokenExpirationInMins":{ "type":"integer" }, "maxNumFailedLoginAttempts":{ "type":"integer" } } }, "BackupReport":{ "properties":{ "id":{ "type":"string" }, "dbResId":{ "type":"string" }, "tag":{ "type":"string" }, "dbId":{ "type":"string" }, "dbName":{ "type":"string" }, "dbUniqueName":{ "type":"string" }, "backupType":{ "type":"string" }, "keepDays":{ "type":"integer" }, "backupLocation":{ "type":"string" }, "cfBackupHandle":{ "type":"string" }, "spfBackupHandle":{ "type":"string" }, "pitrTimeStamp":{ "type":"string", "format":"date-time" }, "pitrSCN":{ "type":"string" }, "resetLogsTimeStamp":{ "type":"string", "format":"date-time" }, "resetLogsSCN":{ "type":"string" }, "oraHomeVersion":{ "type":"string" }, "sqlPatches":{ "type":"string" }, "backupLogLoc":{ "type":"string" }, "tdeWalletLoc":{ "type":"string" }, "dbConfigLoc":{ "type":"string" }, "name":{ "description":"display name for the resource", "type":"string" }, "createTime":{ "type":"string", "format":"date-time" }, "state":{ "$ref":"#/definitions/ResourceState" }, "updatedTime":{ "type":"string", "format":"date-time" }, "backupReportLogDetail":{ "type":"string" }, "dbInfo":{ "$ref":"#/definitions/DbInfo" }, "dbDataSize":{ "type":"string" }, "dbRedoSize":{ "type":"string" }, "rmanBackupPieces":{ "type":"string" }, "compressionAlgo":{ "type":"string", "description":"The RMAN compression algorithm that the database is configured." }, "cpuPool":{ "description":"Defines the CPU Pool name", "type":"string" }, "numberOfCores":{ "description":"Defines the number of cores", "type":"integer" }, "keystoreType":{ "description":"Type of keystore, which stores TDE Master Encryption Key. Either Software or OKV.", "type":"string" } } }, "DbSystemCreateGridParams":{ "type":"object", "properties":{ "version":{ "type":"string", "description":"version of the grid home" }, "language":{ "type":"string", "description":"Language setting for the grid installation" } } }, "DbSystemVNetwork":{ "type":"object", "properties":{ "name":{ "type":"string" }, "type":{ "type":"string" }, "ipAddress":{ "type":"string" }, "netmask":{ "type":"string" }, "gateway":{ "type":"string" }, "targetDevice":{ "type":"string" }, "virtualFunction":{ "type":"string" }, "bridgeName":{ "type":"string" }, "vlanName":{ "type":"string" } } }, "VmConfig":{ "type":"object", "properties":{ "memoryConfig":{ "$ref":"#/definitions/VmConfigMemory" }, "cpuConfig":{ "$ref":"#/definitions/VmConfigCpu" }, "vmVDisks":{ "type":"array", "items":{ "$ref":"#/definitions/VmVDisk" } }, "vmVNetworks":{ "type":"array", "items":{ "$ref":"#/definitions/VmVNetwork" } } } }, "DBRequest":{ "required":[ "dbName" ], "properties":{ "dbName":{ "type":"string" }, "databaseUniqueName":{ "type":"string" }, "dbVersion":{ "type":"string" }, "dbHomeId":{ "description":"The database home resource identifier for associating this database to.", "type":"string" }, "instanceOnly":{ "description":"do not create the database files. Used in case of standby case to create standby instance.", "type":"boolean" }, "registerOnly":{ "description":"Use to migrate existing database", "type":"boolean" }, "isCdb":{ "type":"boolean" }, "pdBName":{ "type":"string" }, "pdbAdminuserName":{ "type":"string" }, "pdbSourceType":{ "description":"The source type to create the PDB", "type":"string", "enum":[ "SEED", "PDB", "ARCHIVE" ] }, "sourcePdbName":{ "description":"The source PDB name if PDB is used in pdbSource", "type":"string" }, "sourcePdbArchivePath":{ "description":"The absolute file name of the PDB archive file if ARCHIVE used in sourceType", "type":"string" }, "enableTDE":{ "description":"Transparent Data Encryption (TDE) feature in the database being created. By default, TDE will not be configured.", "type":"boolean" }, "okvClientPath":{ "description":"Absolute path to okvclient.jar file. Multiple values must be comma separated.", "type":"string" }, "tdePassword":{ "description":"Password used for password protected software keystore.", "type":"string" }, "sourceTDEPassword":{ "description":"TDE password of source PDB.", "type":"string" }, "adminPassword":{ "type":"string" }, "dbType":{ "type":"string", "enum":[ "RAC", "RACOne", "SI" ] }, "dbRole":{ "description":"Database role (PRIMARY/STANDBY).", "type":"string" }, "dbClass":{ "type":"string", "enum":[ "OLTP", "DSS", "IMDB" ] }, "dbShape":{ "type":"string", "enum":[ "odb1s", "odb1", "odb2", "odb4", "odb6", "odb8", "odb10", "odb12", "odb16", "odb20", "odb24", "odb28", "odb32", "odb36", "odb42", "odb48", "odb56", "odb64" ] }, "dbStorage":{ "type":"string", "enum":[ "ASM", "ACFS", "PMEM" ] }, "dbRedundancy":{ "type":"string" }, "quota":{ "type":"string", "description":"disk space quota for a database." }, "dbCharacterSet":{ "$ref":"#/definitions/DbCharacterSet" }, "dbConsoleEnable":{ "type":"boolean" }, "backupConfigId":{ "type":"string" }, "backupConfigName":{ "type":"string" }, "dbOnFlashStorage":{ "description":"Option to select FLASH for storing database data files", "type":"boolean" }, "dbEdition":{ "description":"Database Home Edition(EE/SE).", "type":"string" }, "rmanBkupPassword":{ "type":"string" }, "dbDomainName":{ "type":"string" }, "enableFlashCache":{ "description":"Option to enable FLASH CACHE", "type":"boolean" }, "level0BackupDay":{ "type":"string", "enum":[ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] }, "associatedNetworks":{ "description":"ids of associated networks", "type":"array", "items":{ "type":"string" } }, "associatedNetworkNames":{ "description":"names of associated networks", "type":"array", "items":{ "type":"string" } }, "unifiedAuditing":{ "description":"Enable unified auditing for the database or not (TRUE/FALSE).", "type":"string" }, "enableSEHA":{ "description":"Enable HA for SE for 19c and later SI database", "type":"boolean" }, "enableEEHA":{ "description":"Enable HA for EE SI database", "type":"boolean" }, "dbTargetNodeName":{ "description":"Target node where the database runs on. Applies to EE dbType.", "type":"string" }, "cpuPool":{ "description":"Defines the CPU Pool name", "type":"string" }, "isFileConversionComplete":{ "description":"Flag to check if the permissions and ownership of db files have been modified", "type":"boolean" }, "keystoreType":{ "description":"Type of keystore, which stores TDE Master Encryption Key. Either Software or OKV. Default is Software", "type":"string" }, "okvServerConfigName":{ "description":"Name of the OKV Server Config object which represents the metadata of OKV server where TDE Master Encryption Keys are stored", "type":"string" } } }, "DbSystemCreateIdmUserCredentialsParams":{ "type":"object", "properties":{ "oracleUserPasswd":{ "type":"string", "description":"Password for the system user with oracleUser role" }, "gridUserPasswd":{ "type":"string", "description":"Password for the system user with gridUser role" }, "odaadminUserPasswd":{ "type":"string", "description":"Password for the system user with ODA-ADMINISTRATOR role" } } }, "VmCreateParams":{ "type":"object", "properties":{ "name":{ "type":"string", "description":"Name of the VM" }, "description":{ "type":"string", "description":"Description of the VM" }, "diskSize":{ "type":"string", "description":"Size of the VM disk" }, "vmStorageName":{ "type":"string", "description":"Storage name of the VM" }, "source":{ "type":"string", "description":"Source installation. If local it can be an ISO or a bootable disk image. If remote it can be a URI pointing to an install tree hosted remotely over HTTP, HTTPS, FTP or NFS" }, "memorySize":{ "type":"string", "description":"Size of the VM memory" }, "maxMemorySize":{ "type":"string", "description":"Maximum size of the VM memory" }, "vnetworkNames":{ "type":"array", "description":"Names of the virtual Networks to use", "items":{ "type":"string" } }, "vdiskNames":{ "type":"array", "description":"Names of the virtual Disks to use", "items":{ "type":"string" } }, "vcpuCount":{ "type":"integer", "description":"Number of virtual CPUs to use" }, "maxVcpuCount":{ "type":"integer", "description":"Maximum number of virtual CPUs to use" }, "cpuPoolName":{ "type":"string", "description":"Name of the CPU Pool" }, "cpusToPin":{ "type":"array", "description":"CPUs to pin", "items":{ "type":"string" } }, "graphicsSettings":{ "type":"string", "description":"Graphics settings for the VM" }, "osVariant":{ "type":"string", "description":"OS variant" }, "prefNode":{ "type":"string", "description":"Preferred node to run the VM" }, "extraArgs":{ "type":"string", "description":"Extra arguments for the VM installer" }, "extraSrcs":{ "type":"string", "description":"Extra sources for the guest, they are mounted as cdrom devices" }, "bootOptions":{ "type":"string", "description":"VM boot options" }, "ksConfig":{ "type":"string", "description":"Base64 encoded contents of the kickstart file. Should be < max-request-size (configured at 2MB for micronaut)" }, "cloudInitParams":{ "$ref":"#/definitions/VmCreateCloudInitParams" } } }, "Vm":{ "type":"object", "properties":{ "id":{ "type":"string" }, "name":{ "type":"string" }, "state":{ "type":"string" }, "createTime":{ "type":"string", "format":"date-time" }, "updateTime":{ "type":"string", "format":"date-time" }, "description":{ "type":"string" }, "vmStorageName":{ "type":"string" }, "diskImagePath":{ "type":"string" }, "diskSizeInGb":{ "type":"number", "format":"double" }, "diskSizeFormatted":{ "type":"string" }, "source":{ "type":"string" }, "runningConfig":{ "$ref":"#/definitions/VmConfig" }, "nonRunningConfig":{ "$ref":"#/definitions/VmConfig" }, "graphicsSettings":{ "type":"string" }, "displayPort":{ "type":"string" }, "osType":{ "type":"string" }, "osVariant":{ "type":"string" }, "autoStart":{ "type":"boolean" }, "bootOptions":{ "type":"string" }, "failOver":{ "type":"boolean" }, "prefNode":{ "type":"string" }, "numaEnabled":{ "type":"boolean" }, "status":{ "$ref":"#/definitions/VmStatus" }, "clonedFrom":{ "type":"string" } } }, "DbSystemCreateSystemParams":{ "type":"object", "required":[ "name", "systemPassword", "timeZone" ], "properties":{ "name":{ "type":"string", "description":"Name of the DB System" }, "shape":{ "type":"string", "description":"Shape of the DB System (odb2|odb4|odb6|odb8|odb10| odb12|odb16|odb20|odb24|odb28|odb32|odb36|odb42| odb48|odb56|odb64)" }, "customMemorySize":{ "type":"string", "description":"Memory of the DB System" }, "cpuPoolName":{ "type":"string", "description":"Name of the shared DB System CPU Pool" }, "useReservedCores":{ "type":"boolean", "description":"Whether or not to use reserved CPU cores" }, "diskGroup":{ "type":"string", "description":"ASM disk group" }, "quotaGroups":{ "type":"array", "items":{ "$ref":"#/definitions/QuotaSpec" }, "description":"Quotas for the databases within the DB System" }, "systemPassword":{ "type":"string", "description":"Password for the DB System" }, "timeZone":{ "type":"string", "description":"Time zone of the DB System" }, "enableRoleSeparation":{ "type":"boolean", "description":"Whether or not to enable the role separation" }, "singleNode":{ "type":"string" }, "failOver":{ "type":"boolean" }, "customRoleSeparation":{ "$ref":"#/definitions/DbSystemCreateRoleSeparationParams" }, "redundancy":{ "type":"string", "description":"Redundancy of the VM storage", "enum":[ "MIRROR", "HIGH" ] }, "multiUserAccess":{ "$ref":"#/definitions/DbSystemCreateIdmParams" }, "clusterName":{ "type":"string", "description":"Cluster name to assign instead of autogenerated one" } } }, "DbSystemStorage":{ "type":"object", "properties":{ "diskGroup":{ "type":"string" }, "volumeName":{ "type":"string" }, "volumeDevice":{ "type":"string" }, "sizeInMb":{ "type":"integer", "format":"int64" }, "freeInMb":{ "type":"integer", "format":"int64" }, "usedInMb":{ "type":"integer", "format":"int64" }, "humanReadableSize":{ "type":"string" }, "humanReadableFreeSize":{ "type":"string" }, "humanReadableUsedSize":{ "type":"string" }, "humanReadablePercentageUsed":{ "type":"string" }, "hasAccVolume":{ "type":"boolean" }, "accVolumeName":{ "type":"string" }, "accVolumeDevice":{ "type":"string" }, "accVolumeSizeInMb":{ "type":"integer", "format":"int64" }, "humanReadableAccVolumeSize":{ "type":"string" }, "mountPoint":{ "type":"string" }, "redundancy":{ "type":"string", "description":"Redundancy of the VM storage", "enum":[ "MIRROR", "HIGH", "REBALANCE_IN_PROGRESS", "EXTERNAL", "EXTENDED", "UNAVAILABLE" ] }, "isExtraStorage":{ "type":"boolean", "description":"True if storage type is extra, false if type is base" } } }, "DbInfo":{ "properties":{ "dbClass":{ "type":"string" }, "dbType":{ "type":"string" }, "dbShape":{ "type":"string" }, "dbEdition":{ "type":"string" }, "dbStorage":{ "type":"string" }, "dbRedundancy":{ "type":"string" }, "pdbName":{ "type":"string" }, "isCdb":{ "type":"boolean" } } }, "ServiceJobReport":{ "description":"Job Request Status", "properties":{ "jobId":{ "type":"string" }, "status":{ "type":"string", "enum":[ "Created", "Scheduled", "Running", "Success", "Failure", "Retrying", "Waiting", "InternalError", "Reverting", "Reverted", "NodeDisconnectedFailure", "RunningTaskOnFail" ] }, "message":{ "type":"string" }, "reports":{ "type":"array", "items":{ "$ref":"#/definitions/TaskReport" } }, "createTimestamp":{ "type":"string", "format":"date-time" }, "resourceList":{ "type":"array", "items":{ "$ref":"#/definitions/JobResourceInfo" } }, "description":{ "type":"string" }, "updatedTime":{ "type":"string", "format":"date-time" }, "jobType":{ "type":"string" }, "cpsMetadata":{ "type":"string" } } }, "VmStatus":{ "type":"object", "properties":{ "currNode":{ "type":"string" }, "currState":{ "type":"string" }, "targetState":{ "type":"string" } } }, "KvmJob":{ "type":"object", "properties":{ "syncJob":{ "type":"boolean" }, "jobId":{ "type":"string" }, "jobReport":{ "$ref":"#/definitions/ServiceJobReport" } } }, "ObjectStoreSwift":{ "description":"Object Store details for the Backup/recovery", "type":"object", "properties":{ "id":{ "type":"string" }, "name":{ "type":"string" }, "tenantName":{ "type":"string" }, "userName":{ "type":"string" }, "endpointUrl":{ "type":"string" }, "swiftPassword":{ "type":"string" }, "createTime":{ "type":"string", "format":"date-time" }, "updatedTime":{ "type":"string", "format":"date-time" }, "flags":{ "type":"integer", "description":"Flags internally used by DCS to control backward compatibility" } } }, "VmVNetwork":{ "type":"object", "properties":{ "vNetworkName":{ "type":"string" }, "vmName":{ "type":"string" }, "dbSystemName":{ "type":"string" }, "macAddress":{ "type":"string" }, "pciAddress":{ "type":"string" } } }, "DbSystemCreateUserParams":{ "type":"object", "required":[ "id", "name", "role" ], "properties":{ "id":{ "type":"integer", "description":"ID for the user" }, "name":{ "type":"string", "description":"Name for the user" }, "role":{ "type":"string", "description":"Role for the user" } } }, "DbSystemCreateIdmConfigurationsParams":{ "type":"object", "properties":{ "providerName":{ "type":"string", "description":"Name of the IDM service provider" }, "metadataStoreName":{ "type":"string", "description":"Persistent Store for the IDM service provider" }, "dcsUserPasswdExpDurationInDays":{ "type":"integer", "description":"Password expiry duration in days for DCS user" }, "tokenExpirationInMins":{ "type":"integer", "description":"Auth Token expiration duration in minutes" }, "maxNumFailedLoginAttempts":{ "type":"integer", "description":"Max number of failed login attempts allowed after which the user account gets locked" }, "passwordResetDurationInMins":{ "type":"integer", "description":"Time duration in minutes in which password needs to be reset for a locked account" } } }, "DBModificationRequest":{ "properties":{ "dbId":{ "description":"Database resource ID", "type":"string" }, "dbName":{ "description":"Database resource Name", "type":"string" }, "backupConfigId":{ "type":"string" }, "backupConfigName":{ "type":"string" }, "isAutoBackupDisabled":{ "type":"boolean" }, "rmanBkupPassword":{ "type":"string" }, "level0BackupDay":{ "type":"string", "enum":[ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] }, "databaseId":{ "description":"Database Id", "type":"string" }, "isBackupDisabled":{ "type":"boolean" }, "currentTDEPassword":{ "type":"string", "description":"Current Password for Password Protected KeyStore" }, "newTDEPassword":{ "type":"string", "description":"New password for Password Protected Keystore" }, "okvClientPath":{ "type":"string", "description":"Absolute path to okvclient.jar file. Multiple values must be comma separated." }, "tdeWalletMgmt":{ "type":"boolean", "description":"When specified TDE wallet management will be changed from EXTERNAL to ODA." }, "isReKey":{ "type":"boolean", "description":"When specified TDE Master Encryption key will be Re-Keyed. Default is False" }, "dbClass":{ "type":"string" }, "dbShape":{ "type":"string" }, "networksToAdd":{ "type":"array", "items":{ "type":"string" } }, "networksToRemove":{ "type":"array", "items":{ "type":"string" } }, "enableSEHA":{ "description":"Enable HA for SE for 19c and later SI database", "type":"boolean" }, "enableEEHA":{ "description":"Enable HA for EE SI database", "type":"boolean" }, "dbType":{ "type":"string" }, "dbTargetNodeName":{ "type":"string" }, "dbRedundancy":{ "type":"string" }, "cpuPool":{ "description":"Defines the CPU Pool name", "type":"string" }, "noCpuPool":{ "description":"Removes the attached CPU Pool", "type":"boolean" }, "cdbName":{ "description":"Convert a singleton database to a Pluggable database of a newly specified Container database(CDB). If the specified CDB does not exist, then a new CDB will be created with the specified name.", "type":"string" }, "adminPassword":{ "description":"Password for the newly created CDB", "type":"string" }, "deleteExistingNonCDB":{ "description":"Deletes previous non CDB after converting it into a CDB", "type":"boolean" }, "unplugPDB":{ "description":"Unplug a PDB from a CDB", "type":"boolean" }, "pdbName":{ "description":"Pluggable database name.", "type":"string" }, "pdbFilePath":{ "description":"Absolute file path for ARCHIVE file (.tar file)", "type":"string" }, "tdePassword":{ "description":"Password for Password Protected KeyStore", "type":"string" }, "isChangeTdePassword":{ "description":"Flag specified to change the TDE password of the database.", "type":"boolean" } } }, "DbSystemCreateRestoreBackupNfsDetails":{ "description":"Details to NFS location where backups are present", "required":[ "serverIP", "serverLocation" ], "properties":{ "serverIP":{ "description":"IP address of the machine where NFS server location is available", "type":"string" }, "serverLocation":{ "description":"NFS server location", "type":"string" } } }, "Pdb":{ "properties":{ "id":{ "description":"PDB Id", "type":"string" }, "pdbName":{ "description":"Name of the PDB", "type":"string" }, "state":{ "$ref":"#/definitions/ResourceState" }, "sourceType":{ "description":"The source type to create the PDB", "type":"string", "enum":[ "SEED", "PDB", "ARCHIVE" ] }, "sourcePdbName":{ "description":"The source PDB name if PDB is used in pdbSource", "type":"string" }, "sourcePdbArchivePath":{ "description":"The absolute file name of the PDB archive file if ARCHIVE is used in sourceType", "type":"string" } } }, "PhysicalCpu":{ "type":"object", "properties":{ "cpuId":{ "type":"integer" }, "online":{ "type":"boolean" } } }, "VmConfigMemory":{ "type":"object", "properties":{ "memorySizeInMb":{ "type":"integer" }, "memorySizeFormatted":{ "type":"string" }, "maxMemorySizeInMb":{ "type":"integer" }, "maxMemorySizeFormatted":{ "type":"string" } } }, "VmCreateCloudInitParams":{ "type":"object", "properties":{ "userData":{ "type":"string", "description":"Base64 encoded user-data parameters" }, "vendorData":{ "type":"string", "description":"Base64 encoded vendor-data parameters" }, "networkConfig":{ "type":"string", "description":"Base64 encoded network-config parameters" }, "metaData":{ "type":"string", "description":"Base64 encoded metadata parameters" } } }, "DbCharacterSet":{ "properties":{ "characterSet":{ "type":"string" }, "nlsCharacterset":{ "type":"string" }, "dbTerritory":{ "type":"string" }, "dbLanguage":{ "type":"string" } } }, "DbSystemCreateDatabaseParams":{ "type":"object", "required":[ "name", "uniqueName", "domainName", "adminPassword", "version", "edition", "type", "dbClass", "shape", "role" ], "properties":{ "name":{ "type":"string", "description":"Name of the database" }, "uniqueName":{ "type":"string", "description":"Unique name of the database" }, "domainName":{ "type":"string", "description":"Domain name of the database" }, "adminPassword":{ "type":"string", "description":"Admin password of the database" }, "version":{ "type":"string", "description":"Version of the database" }, "edition":{ "type":"string", "description":"Edition of the database (SE|EE)", "enum":[ "SE", "EE" ] }, "type":{ "type":"string", "description":"Type of the database (RAC|RACOne|SI)", "enum":[ "RAC", "RACOne", "SI" ] }, "dbClass":{ "type":"string", "description":"Class of the database (OLTP|DSS|IMDB)", "enum":[ "OLTP", "DSS", "IMDB" ] }, "shape":{ "type":"string", "description":"Shape of the database (odb1s|odb1|odb2|odb4|odb6| odb8|odb10|odb12|odb16|odb20|odb24|odb28|odb32| odb36|odb42|odb48|odb56|odb64)", "enum":[ "odb1s", "odb1", "odb2", "odb4", "odb6", "odb8", "odb10", "odb12", "odb16", "odb20", "odb24", "odb28", "odb32", "odb36", "odb42", "odb48", "odb56", "odb64" ] }, "role":{ "type":"string", "description":"Role of the database (PRIMARY|STANDBY)", "enum":[ "PRIMARY", "STANDBY" ] }, "redundancy":{ "type":"string", "description":"Redundancy of the database. If the diskgroup redundancy is FLEX, then database redundancy must be set to one of \"HIGH\" or \"MIRROR\", otherwise, can be null" }, "characterSet":{ "$ref":"#/definitions/DbCharacterSet" }, "enableDbConsole":{ "type":"boolean", "description":"Whether or not the database console is enabled" }, "enableSEHA":{ "type":"boolean", "description":"Whether or not to enable HA for SE for 19c and later SI database" }, "enableEEHA":{ "type":"boolean", "description":"Whether or not to enable HA for EE SI database" }, "enableFlashStorage":{ "type":"boolean", "description":"Whether or not enable flash storage" }, "enableFlashCache":{ "type":"boolean", "description":"Whether or not enable flash cache" }, "rmanBackupPassword":{ "type":"string", "description":"RMAN backup password of the database" }, "level0BackupDay":{ "type":"string", "description":"Backup day of the database (monday|tuesday|wednesday|thursday|friday|saturday|sunday)", "enum":[ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] }, "enableTDE":{ "type":"boolean", "description":"Whether or not enable TDE" }, "tdePassword":{ "type":"string", "description":"TDE password of the database" }, "enableUnifiedAuditing":{ "type":"boolean", "description":"Whether or not enable unified auditing" }, "isCdb":{ "type":"boolean", "description":"Whether or not the database is CDB" }, "pdbName":{ "type":"string", "description":"Name of the PDB" }, "pdbAdminUser":{ "type":"string", "description":"Name of the PDB admin user" }, "targetNodeName":{ "type":"string", "description":"Target node name of the database" }, "dbStorage":{ "type":"string", "description":"Storage type of the database (ASM|PMEM) - The default value is ASM", "enum":[ "ASM", "PMEM" ] } } }, "DbSystemCreateRestoreBackupObjectStoreDetails":{ "description":"Details of the Object Store where backups are present", "required":[ "objectStoreSwiftName" ], "properties":{ "objectStoreSwiftName":{ "description":"Name of the Object Store Swift object", "type":"string" }, "tenantName":{ "description":"Name of the Object Store tenancy", "type":"string" }, "userName":{ "description":"Object Store user name", "type":"string" }, "endPointURL":{ "description":"Object Store end point URL", "type":"string" }, "password":{ "description":"Object Store password", "type":"string" } } } }, "responses":{ "Exception":{ "description":"An unexpected error has occurred", "schema":{ "$ref":"#/definitions/Error" } } } }