Create a new DBCA job in the default Oracle Home
/environment/dbca/jobs/
Request
- application/json
-
Content-Type(optional): string
Allowed Values:
[ "application/json" ]
object
createDBCAJob
-
container_configuration(optional):
array container_configuration
This object specifies that a Container Database is to be created with the PDB settings provided.
-
global_database_name:
string
Global Database Name to identify the database to create or delete
-
operation:
object operation
-
password(optional):
string
Specifies the password for the account with SYSDBA role which DBCA will use to delete the database. Only required for DELETE operations.
-
response_file(optional):
string
The name of the response file for DBCA to use when creating a database.
-
sys_user_password(optional):
string
The password for the sys user in the new database.
-
system_user_password(optional):
string
The password for the system user in the new database.
-
template_name(optional):
string
The name of the template file for DBCA to use when creating a database.
-
total_memory(optional):
integer(int32)
Total amount of physical memory, in megabytes, that can be used by the new database.
-
username(optional):
string
Specifies the account with SYSDBA role which DBCA will use to delete the database. Only required for DELETE operations.
array
-
Array of:
object ContainerConfiguration1
Title:
ContainerConfiguration1
object
-
string
Title:
Operation3
Allowed Values:[ "CREATE", "DELETE" ]
The DBCA operation to perform. -
The DBCA operation to perform.
object
ContainerConfiguration1
-
number_of_pdbs:
integer(int32)
The number of Pluggable Databases to create.
-
pdb_administrator_password:
string
The password for the PDBADMIN user created in each Pluggable Database.
-
pdb_name:
string
The name prefix to use for each Pluggable Database created.
Response
- application/json
201 Response
object
EnvironmentDbcaJobsItem
-
dbca_log(optional):
array dbca_log
The output from the DBCA process as it executes.
-
description(optional):
string
DBCA job description.
-
finished(optional):
string
Timestamp for when the DBCA job request finished.
-
job_id(optional):
string
Unique identifier for the DBCA job in the Oracle Home.
-
job_request(optional):
object job_request
-
links(optional):
array links
-
status(optional):
string
DBCA job status.
-
submitted(optional):
string
Timestamp for when the DBCA job request was submitted.
object
-
object
JobRequest
Title:
JobRequest
Describes the DBCA job request. -
Describes the DBCA job request.
object
JobRequest
-
container_configuration(optional):
object container_configuration
-
database_system_identifier(optional):
string
The database identifier.
-
global_database_name(optional):
string
Global database name.
-
operation(optional):
string
The DBCA operation to be performed: CREATE or DELETE.
-
response_file(optional):
string
Path for response file for DBCA to use when creating a database.
-
template_name(optional):
string
Path for the database template for DBCA to use when creating a database.
-
total_memory(optional):
string
Total memory parameter to provide to DBCA when creating a database.
-
username(optional):
string
The sysdba username for DBCA to use when deleting a database.
object
-
object
ContainerConfiguration
Title:
ContainerConfiguration
This object represents container configuration details for a CDB. -
This object represents container configuration details for a CDB.
object
ContainerConfiguration
-
number_of_pdbs(optional):
string
Number of PDBs to create.
-
pdb_name(optional):
string
Base name of each PDB. A number is appended to each name if number_of_pdbs is greater than 1.
Examples
The following example shows how to submit a new DBCA job in the default Oracle Home by submitting a POST request on the REST resource using cURL. The DBCA job can be a request to create or delete a database in the default Oracle Home.
curl -i -X POST -u username:password
-d @request_body.json
-H "Content-Type:application/json" https://rest_server_url/ords/_/db-api/stable/environment/dbca/jobs/
Example of Request Body
Note:
https://rest_server_url/resource-path
, used in the preceding command has the following components:
rest_server_url
is the REST server where Oracle Rest Data Server is running- The remainder of the URL includes the ORDS context root, the version of ORDS Database API to use, and the path for this operation.
The following is an example request body to create a DBCA job for creating a non-container database. The non-container database is called devdb1
based on the General_Purpose.dbc
template, and the total amount of physical memory used by the new databaase is 700mb.
{
"operation": "CREATE",
"global_database_name": "devdb1",
"template_name": "General_Purpose.dbc",
"sys_user_password": "W3lc0m31",
"system_user_password": "W3lc0m31",
"total_memory": 700
}
Example of Response Header
The following example shows the response header. The Location
header returns the URI that can be used to view the DBCA job status.
HTTP/1.1 201 Created
Content-Type: application/json
Content-Location: https://rest_server_url/ords/_/db-api/stable/environment/dbca/jobs/OzQbsGnbUhVV7w7fiYPbJQ/
X-Frame-Options: SAMEORIGIN
Location: https://rest_server_url/ords/_/db-api/stable/environment/dbca/jobs/OzQbsGnbUhVV7w7fiYPbJQ/
Transfer-Encoding: chunked
Example of Response Body
The following example shows the response body with 201 returned in JSON format:
{
"job_id": "OzQbsGnbUhVV7w7fiYPbJQ",
"description": "Run DBCA to create database",
"status": "RUNNING",
"submitted": "2019-09-06T19:17:23.004Z",
"finished": null,
"job_request": {
"operation": "CREATE",
"container_configuration": null,
"database_system_identifier": null,
"global_database_name": "devdb1",
"response_file": null,
"template_name": "General_Purpose.dbc",
"total_memory": 700,
"username": null
},
"dbca_log": [],
"links": [
{
"rel": "self",
"href": "https://rest_server_url/ords/_/db-api/stable/environment/dbca/jobs/OzQbsGnbUhVV7w7fiYPbJQ/"
},
{
"rel": "describedby",
"href": "https://rest_server_url/ords/_/db-api/stable/metadata-catalog/"
},
{
"rel": "collection",
"href": "https://rest_server_url/ords/_/db-api/stable/environment/dbca/jobs/"
}
]
}