Jump to

• Request
• Response
• Examples

Start a Recovery Operation

post

/paas/service/dbcs/api/v1.1/instances/{identityDomainId}/{serviceId}/backups/recovery

Starts a recovery operation on a Database Classic Cloud Service instance using the latest backup or to a point in time specified by a backup tag, timestamp, or SCN (System Change Number).

Request

Supported Media Types

• application/json

Path Parameters

• identityDomainId: string
  Identity domain ID for the Database Classic Cloud Service account:
   

  • For a Cloud account with Identity Cloud Service: the identity service ID, which has the form idcs-letters-and-numbers. You can find this ID in the Identity Service Id field on the Overview tab of the Service Details page for Database Classic Cloud Service in My Services.

  • For a traditional cloud account: the name of the identity domain.

• serviceId: string
  Name of the Database Classic Cloud Service instance.

Header Parameters

• Authorization: string
  Base64 encoding of the user name and password of the user making the request. For more information, see Security, Authentication and Authorization.
• X-ID-TENANT-NAME: string
  Identity domain ID for the Database Classic Cloud Service account:
   

  • For a Cloud account with Identity Cloud Service: the identity service ID, which has the form idcs-letters-and-numbers. You can find this ID in the Identity Service Id field on the Overview tab of the Service Details page for Database Classic Cloud Service in My Services.

  • For a traditional cloud account: the name of the identity domain.

Body ()

Root Schema : Request Body

Type: object

Title: Request Body

Show Source

• keepForever(optional): boolean
  Specify whether the backup being recovered is a long term, or "keep forever", backup. Valid values are true or false. Default is false.
• latest(optional): string
  Recover using the latest available backup.
• scn(optional): string
  Recover using a System Change Number.
• tag(optional): string
  Recover using a database tag.
• timestamp(optional): string
  Recover using a timestamp. The timestamp must be UTC and of the format dd-MMM-yyyy HH:mm:ss.

{
    "title":"Request Body",
    "type":"object",
    "description":"",
    "properties":{
        "latest":{
            "type":"string",
            "description":"Recover using the latest available backup."
        },
        "scn":{
            "type":"string",
            "description":"Recover using a System Change Number."
        },
        "tag":{
            "type":"string",
            "description":"Recover using a database tag."
        },
        "timestamp":{
            "type":"string",
            "description":"Recover using a timestamp. The timestamp must be UTC and of the format <code>dd-MMM-yyyy HH:mm:ss</code>."
        },
        "keepForever":{
            "type":"boolean",
            "description":"Specify whether the backup being recovered is a long term, or \"keep forever\", backup. Valid values are <code>true</code> or <code>false</code>. Default is <code>false</code>."
        }
    }
}

Back to Top

Response

202 Response

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

Headers

• Location: string
  A REST URI you can use to check the progress and completion of the recovery operation.

Back to Top

Examples

The following example shows how to start a recovery operation by submitting a POST request on the REST endpoint using cURL.

This example uses a traditional cloud account, so the {identityDomainId} path parameter and the X-ID-TENANT-NAME header parameter are set to the account's domain name, which is usexample. The service instance is db12c-xp-si and the Oracle Cloud user name of the user making the call is dbcsadmin.

As indicated in the request body provided in the cURL command's --data option, this example starts a tag-based recovery operation.

cURL Command

$ curl --include --request POST \
--user dbcsadmin:password \
--header "X-ID-TENANT-NAME:usexample" \
--header "Content-Type: application/json" \
--data '{ "tag" : "TAG20160626T022724" }' \
https://dbaas.oraclecloud.com/paas/service/dbcs/api/v1.1/instances/usexample/db12c-xp-si/backups/recovery

HTTP Status Code and Response Headers

HTTP/1.1 202 Accepted
Date: date-and-time-stamp
Server: Oracle-Application-Server-11g
Location: https://dbaas.oraclecloud.com:443/paas/service/dbcs/api/v1.1/instances/usexample/status/recovery/job/5495684
Content-Length: 0
X-ORACLE-DMS-ECID: id-string
X-ORACLE-DMS-ECID: id-string
X-Frame-Options: DENY
Service-URI: https://dbaas.oraclecloud.com:443/paas/service/dbcs/api/v1.1/instances/usexample/db12c-xp-si
Vary: Accept-Encoding,User-Agent
Retry-After: 60
Content-Language: en
Content-Type: application/json

Back to Top