REST APIs for Oracle Database Appliance Release 19.26

Patch database home by name with available patch

put

/dbhomes/name/{dbhomeName}

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.

Request

Supported Media Types

application/json

Path Parameters

dbhomeName(required): string

database home Name

Header Parameters

opc-idempotency-token: string

Minimum Length: 1

Maximum Length: 64

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.

patching parameters

Root Schema : DbHomePatchingRequest

Type: object

Show Source

force: boolean

force flag to force patching. By default it will be false.
ignoreMissingPatches: boolean

force flag to ignore all missing patches and force patching. By default it will be false.
local: boolean

local flag to patch only local system. By default it will be false.
nodeName: string

Node name to support remote node patching
precheck: boolean

option to not apply the patch but just to analyze the patch
version: string

patch version or patch release version

{
    "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."
        }
    }
}

Response

Supported Media Types

application/json

200 Response

update Database Home status

Root Schema : ServiceJobReport

Type: object

Job Request Status

Show Source

cpsMetadata: string
createTimestamp: string(date-time)
description: string
jobId: string
jobType: string
message: string
reports: array reports
resourceList: array resourceList
status: string

Allowed Values: [ "Created", "Scheduled", "Running", "Success", "Failure", "Retrying", "Waiting", "InternalError", "Reverting", "Reverted", "NodeDisconnectedFailure" ]
updatedTime: string(date-time)

{
    "description":"Job Request Status",
    "properties":{
        "jobId":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "enum":[
                "Created",
                "Scheduled",
                "Running",
                "Success",
                "Failure",
                "Retrying",
                "Waiting",
                "InternalError",
                "Reverting",
                "Reverted",
                "NodeDisconnectedFailure"
            ]
        },
        "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"
        }
    }
}

Nested Schema : reports

Type: array

Show Source

Array of: object TaskReport

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/TaskReport"
    }
}

Nested Schema : resourceList

Type: array

Show Source

Array of: object JobResourceInfo

resource information

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/JobResourceInfo"
    }
}

Nested Schema : TaskReport

Type: object

Show Source

duration: string
endTime: string(date-time)
jobId: string
nodeName: string
parentTaskId: string
reportLevel: string

Allowed Values: [ "Verbose", "Info", "Error" ]
startTime: string(date-time)
status: string

Allowed Values: [ "Created", "Scheduled", "Running", "Success", "Failure", "Retrying", "Waiting", "InternalError", "Reverting", "Reverted", "NodeDisconnectedFailure", "Skipped" ]
tags: array tags
taskDescription: string
taskId: string
taskName: string
taskResult: string
updatedTime: string(date-time)

{
    "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"
        }
    }
}

Nested Schema : tags

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : JobResourceInfo

Type: object

resource information

Show Source

jobId: string
resourceId: string
resourceNewType: string
resourceType: string

Allowed Values: [ "Backup", "BackupConfig", "DB", "DbHome", "Grid", "Pdb", "Recovery", "Report", "Tde", "ObjectStoreSwift" ]
updatedTime: string(date-time)

{
    "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"
        }
    }
}

Default Response

An unexpected error has occurred

Root Schema : Error

Type: object

Show Source

code(required): string
message(required): string

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string"
        },
        "message":{
            "type":"string"
        }
    }
}