Create Oracle Database Software
post
/rhp-restapi/rhp/workingcopies/{workingCopyId}/databases
Provision a new Oracle Database on a managed working copy.
Request
Supported Media Types
- application/json
Path Parameters
-
workingCopyId(required): string
Name of the working copy.
Header Parameters
-
Authorization(required): string
Base64 encoding of the user name and password of the user making the request. For more information, see Authentication for Fleet Patching and Provisioning.
Root Schema : AddDatabaseBody
Type:
Show Source
object
-
auth:
string
Use an authentication plugin to access the remote node.
-
authArgs:
object authArgs
Additional Properties Allowed: additionalPropertiesAdditional properties for the selected authentication plugin.
-
cardinality:
string
Cardinality for new server pool
-
cdb:
boolean
Default Value:
false
To create database as container database -
datafileDestination:
string
Data file destination location or ASM disk group name
-
dbcaAdditionalArgs:
string
DBCA additional command line arguments separated by space
-
dbcaInitParams:
string
Comma-separated list of name=value pairs of the database initialization parameters and their valuescomma-separated list of name=value pairs of the database initialization parameters and their values
-
dbTemplate:
string
Absolute file path for the template file or relative path to the image home directory on Rapid Home Provisioning Server
-
dbType:
string
Allowed Values:
[ "RAC", "RACONENODE", "SINGLE" ]
Type of database: Oracle RAC One Node or Oracle RAC or Single Instance -
eval:
boolean
Default Value:
false
Evaluate without executing the command. -
gimr:
boolean
Default Value:
false
To perform the operations required for a Grid Infrastructure Management Repository (GIMR) database -
newpool:
string
Server pool name for pool to be created
-
newpqpool:
string
Server pool name for pool to be created
-
nodes:
string
Comma-separated list of nodes on which database will be created
-
numberOfPDBs:
integer(int32)
Number of PDBs to be created
-
pdbname:
string
The pdbname prefix if one or more PDBs need to be created
-
pqcardinality:
string
Cardinality for new PQ pool
-
pqpool:
string
Existing PQ pool name
-
root:
boolean
Default Value:
false
Use root credentials to access the remote node. -
schedule:
string
Preferred time to execute the operation, in ISO-8601 format. For example: 2016-12-21T19:13:17+05.
-
serverpool:
string
Comma-separated list of existing server pool names
-
sudoPath:
string
location of sudo binary.
-
sudoUser:
string
perform super user operations as sudo user name.
-
superUserPasswd:
string
The password for the super user account.
-
targetNode:
string
Node on which operation needs to be executed
-
userActionData:
string
Value to be passed to useractiondata parameter of useraction script
Nested Schema : authArgs
Type:
object
Additional Properties Allowed
Show Source
Additional properties for the selected authentication plugin.
Security
-
basicAuthentication: basic
Type:
basic
Response
Supported Media Types
- application/json
- text/html
202 Response
Accepted. A JSON object containing job resource details of the accepted operation to obtain status and output of the progress.
Headers
-
Location: string
URL to the job that will execute the operation
Root Schema : jobResource
Type:
Show Source
object
-
jobId:
string
-
links:
array links
-
operation:
string
-
output:
object jobOutputResource
-
status:
string
Allowed Values:
[ "SCHEDULED", "UNKNOWN", "EXECUTING", "PAUSED", "ABORTED", "TERMINATED", "FAILED", "SUCCEEDED" ]
Nested Schema : jobOutputResource
Type:
Show Source
object
-
hasMore:
boolean
Default Value:
false
-
limit:
integer
-
links:
array links
-
offset:
integer
-
output:
string
Nested Schema : singleResourceLinks
Type:
Show Source
object
-
href:
string
The referenced hyperlink element provided in an absolute format.
-
rel:
string
Allowed Values:
[ "self", "collection", "up", "describedBy" ]
Specify the type of relationship the link has with the described resource.
Nested Schema : collectionResourceLinks
Type:
Show Source
object
-
href:
string
The referenced hyperlink element provided in an absolute format with the correct URL parameters.
-
rel:
string
Allowed Values:
[ "next", "prev", "first", "last" ]
Specify the type of relationship the link has with the described resource.
400 Response
Bad Request. A JSON object containing error details of the issue found while parsing a parameter value or name.
Root Schema : errorResource
Type:
Show Source
object
-
errorCode:
string
Application specific error code, related to the error message shown at tittle.
-
errorDetails:
array errorDetails
If multiple errors are reported they can be organized in a hierarchical structure in this array.
-
errorPath:
string
XPath or JSON path to indicate where the error occurs.
-
instance:
string
URI to the link that provides more detail about the error.
-
status:
integer
HTTP status code.
-
title:
string
Summary error message.
-
type:
string
Link to HTTP error code page.
Nested Schema : errorDetails
Type:
array
If multiple errors are reported they can be organized in a hierarchical structure in this array.
Show Source
Default Response
Unexpected error. A JSON object containing error details of the issue while executing the operation.
Root Schema : errorResource
Type:
Show Source
object
-
errorCode:
string
Application specific error code, related to the error message shown at tittle.
-
errorDetails:
array errorDetails
If multiple errors are reported they can be organized in a hierarchical structure in this array.
-
errorPath:
string
XPath or JSON path to indicate where the error occurs.
-
instance:
string
URI to the link that provides more detail about the error.
-
status:
integer
HTTP status code.
-
title:
string
Summary error message.
-
type:
string
Link to HTTP error code page.
Nested Schema : errorDetails
Type:
array
If multiple errors are reported they can be organized in a hierarchical structure in this array.
Show Source
Examples
The following example shows how to provision a new Oracle dtabase instance on a managed working copy, where all the arguments are provided in the request body body.json
, by submitting a POST request on the REST resource using cURL.
curl -u restUser -X POST -H "Content-Type: application/json" -d "@body.json" "https://RHP_node_name:8894/rhp-restapi/rhp/workingcopies/DB_Wcopy181/databases"
HTTP Status Code and Response Headers
The following shows an example of the response header.
HTTP/1.1 202
Location: https://RHP_node_name:8894/rhp-restapi/rhp/jobs/1
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Access-Control-Allow-Methods: GET,PUT,POST,DELETE,PATCH,OPTIONS
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Content-Length, Authorization
Connection: keep-alive
Content-Type: application/json
Content-Length: 159
Date: Tue, 19 Jun 2018 14:03:23 GMT
Request Body (body.json)
{
"dbname" : "dbwc1"
}
Response Body
{
"links": [{
"uri": "https://RHP_node_name:8894/rhp-restapi/rhp/jobs/1",
"rel": "self"
}],
"jobId": "1",
"output": { }
}