Jump to

• Request
• Response
• Examples

View the Status of a Restoration Operation

get

/paas/api/v1.1/instancemgmt/{domainName}/services/SOA/instances/{serviceId}/restoredbackups/{jobId}

Returns the status of the specified restoration operation of an Oracle SOA Cloud Service instance.

Request

Path Parameters

• domainName: string
  Identity domain ID for the Oracle SOA Cloud Service account.
• jobId: string
  Job ID of the restoration operation. To retrieve the job ID, see View All Restoration Operations.
• serviceId: string
  Name of the Oracle SOA Cloud Service instance.

Header Parameters

• X-ID-TENANT-NAME: string
  Identity domain ID for the Oracle SOA Cloud Service account.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK. See Status Codes for information about other possible HTTP status codes.

Body ()

Root Schema : restoreHistory

Type: object

Show Source

• backupDate: string
  Date and time of the backup.
• backupId: string
  Backup ID.
• configDataIncluded: boolean
  Flag that specifies configuration data was restored (true).
• jobId: string
  Job ID for the restore operation.
• notes: string
  Free-form text that provides additional information about the restoration operation.
• otdIncluded: boolean
  Flag that specifies whether the load balancer was restored (true). If OTD is not provisioned or was not provisioned at the time of the backup, the value is false.
• recoveryCompleteDate: string
  Date and time that the restoration operation completed. This information is not displayed for restorations that are still in progress.
• recoveryStartDate: string
  Date and time that the restoration operation started.
• staticDataIncluded: boolean
  Flag that specifies the static binary files were not included (false) or included (true) in the restoration operation.
• status: string
  Status of the operation. Valid values include: Completed, Failed, or In Progress.
• statusDetails: string
  History of system messages. Each message is separated by an ellipses (...).

{
    "required":[
        "backupId",
        "backupDate",
        "configDataIncluded",
        "jobId",
        "notes",
        "otdIncluded",
        "recoveryCompleteDate",
        "recoveryStartDate",
        "staticDataIncluded",
        "status",
        "statusDetails"
    ],
    "properties":{
        "backupId":{
            "type":"string",
            "description":"Backup ID."
        },
        "backupDate":{
            "type":"string",
            "description":"Date and time of the backup."
        },
        "configDataIncluded":{
            "type":"boolean",
            "description":"Flag that specifies configuration data was restored (<code>true</code>)."
        },
        "jobId":{
            "type":"string",
            "description":"Job ID for the restore operation."
        },
        "notes":{
            "type":"string",
            "description":"Free-form text that provides additional information about the restoration operation."
        },
        "otdIncluded":{
            "type":"boolean",
            "description":"Flag that specifies whether the load balancer was restored (<code>true</code>). If OTD is not provisioned or was not provisioned at the time of the backup, the value is <code>false</code>."
        },
        "recoveryCompleteDate":{
            "type":"string",
            "description":"Date and time that the restoration operation completed. This information is not displayed for restorations that are still in progress."
        },
        "recoveryStartDate":{
            "type":"string",
            "description":"Date and time that the restoration operation started."
        },
        "staticDataIncluded":{
            "type":"boolean",
            "description":"Flag that specifies the static binary files were not included (<code>false</code>) or included (<code>true</code>) in the restoration operation."
        },
        "status":{
            "type":"string",
            "description":"Status of the operation. Valid values include: <code>Completed</code>, <code>Failed</code>, or <code>In Progress</code>."
        },
        "statusDetails":{
            "type":"string",
            "description":"History of system messages. Each message is separated by an ellipses (...)."
        }
    }
}

Back to Top

Examples

The following example shows how to view the status of a restoration operation for an Oracle SOA Cloud Service instance by submitting a GET request on the REST resource using cURL.

Note: The command in this example uses the URL structure https://rest_server_url/resource-path, where rest_server_url is the REST server to contact for your identity domain (or Cloud account). See Send Requests.

cURL Command

curl -i -X GET -u username:Password! -H "X-ID-TENANT-NAME:ExampleIdentityDomain" https://rest_server_url/paas/api/v1.1/instancemgmt/{domainName}/services/SOA/instances/ExampleInstance/restoredbackups/8226

Example of Response Header

The following example shows the response header.

HTTP/1.1 200 OK
Date: Sat, 05 Dec 2015 23:39:23 GMT
Transfer-Encoding: chunked
Content-Type: application/json

Example of Response Body

The following example shows the response body in JSON format. Your response output will differ depending on your Oracle SOA Cloud Service environment and service instance configuration.

{
    "backupId":"1449332100032",
    "backupDate":"Sat Dec 05 16:15:00 GMT 2015",
    "jobId":"8226",
    "recoveryStartDate":"Sat Dec 05 23:39:02 GMT 2015",
    "recoveryCompleteDate":"Sat Dec 05 23:57:53 GMT 2015",
    "status":"Completed",
    "statusDetails":"The backup archive already exists in the block storage and does not need to be downloaded from the Oracle Storage Cloud Service container...
       Submitted the restoration precheck for remote execution...Restoration precheck passed...
       Disabled the load balancer...Submitted the restoration for remote execution...
       These managed servers were added after the backup was created: ['exampleinstance-wls-3']. The instance will be scaled in with force=true to remove these managed servers...
       Stopping WebLogic Server...Stopped WebLogic Server...
       Restoring the configuration data for WebLogic Server administration server on host exampleinstance-wls-1...
       Restored the configuration data for WebLogic Server administration server on host exampleinstance-wls-1...
       Restoring Oracle Traffic Director on host exampleinstance-lb-1...
       Restored Oracle Traffic Director on host exampleinstance-lb-1...
       Restoring the configuration data for WebLogic Server administration server on host exampleinstance-wls-2...
       Restored the configuration data for WebLogic Server administration server on host exampleinstance-wls-2...
       Starting WebLogic Server...Started WebLogic Server...Unlocked the WebLogic Server domain configuration...
       Completed the restoration...Enabled the load balancer...Validated the load balancer",
    "staticDataIncluded":false,
    "configDataIncluded":true,
    "otdIncluded":true,
    "notes":"restore from backup before scale out"
}

Back to Top