Upgrade an unmanaged Oracle Database Software home
put
/rhp-restapi/rhp/databases/{dbUniqueName}
Upgrade a database on the specified Oracle Database Software home
Request
Supported Media Types
- application/json
Path Parameters
-
dbUniqueName(required): string
Name of database (DB_UNIQUE_NAME) to be provisioned
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 : UpgradeDatabaseBody
Type:
Show Source
object
-
abort:
string
Abort the ongoing operation
-
auth:
string
Use an authentication plugin to access the remote node.
-
authArgs:
object authArgs
Additional Properties Allowed: additionalPropertiesAdditional properties for the selected authentication plugin.
-
client:
string
Client cluster name
-
dbuaArgs:
string
Quoted string containing optional arguments for DBUA
-
destwc:
string
Name of the destination working copy to which the database needs to be upgraded
-
drainTimeout:
string
Service drain timeout specified in seconds
-
eval:
boolean
Default Value:
false
Evaluate without executing the command. -
fra:
string
Location of the flash recovery area.
-
grp:
string
Autoupgrade generates a guarantee restore point (GRP) for database restoration. Default is YES.
-
ignoreGroupCheck:
string
Skip group check except for OSDBA and OSASM during upgrade database
-
ignoreMissingPatches:
string
Proceed with the move/upgrade even though the specified patches, which are present in the source path or working copy, might be missing from the destination path or working copy
-
ignoreprereq:
boolean
Default Value:
false
To ignore the CVU pre-requisite checks. -
imageName:
string
Name of the image.
-
path:
string
Absolute path location of the software home to be imported (For database images, this will be the ORACLE_HOME).
-
preupg:
string
Execute the pre-upgrade checks for the specified database.
-
revert:
string
Revert the failed upgrade of Oracle Database
-
root:
boolean
Default Value:
false
Use root credentials to access the remote node. -
runUtlrp:
string
Enable or disable the recompilation of invalid objects as part of the autoupgrade process. Default is YES.
-
schedule:
string
Preferred time to execute the operation, in ISO-8601 format. For example: 2016-12-21T19:13:17+05.
-
sourceHome:
string
Source Oracle home path.
-
sourcewc:
string
Name of the source working copy from which the Oracle Grid Infrastructure needs to be upgraded.
-
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
-
tgtCdbName:
string
DB_UNIQUE_NAME of the target CDB into which the non-CDB Oracle database will be plugged in.
-
tgtPdbName:
string
New name to assign to the non-CDB source database once is plugged in as a PDB to target CDB.
-
upgTimezone:
string
Enable or disable time zone upgrade as part of the autoupgrade. Default is YES.
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 upgrade a database from a specified Oracle database software home to the destination working copy, by submitting a PUT request on the REST resource using cURL.
curl -u restUser -X PUT -H "Content-Type: application/json" -d "@body.json" "https://RHP_node_name:8894/rhp-restapi/rhp/databases/dbwc1"
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)
{
"sourceHome" : "/oracle/database/src/home",
"destwc" : "DB_Wcopy181"
}
Response Body
{
"links": [{
"uri": "https://RHP_node_name:8894/rhp-restapi/rhp/jobs/1",
"rel": "self"
}],
"jobId": "1",
"output": { }
}