Jump to

• Request
• Response
• Examples

Create a Restore

post

/backupservice/v1/restore

This endpoint is not available on Oracle Cloud Machine.

Restores a storage volume from a previously completed backup. Before sending a request to restore, verify that the backup to be restored is in the completed state by retrieving details of the backup and checking the state field. You can only restore backups that are in the Completed state.

Required Role: To complete this task, you must have the Compute_Operations role. If this role isn't assigned to you or you're not sure, then ask your system administrator to ensure that the role is assigned to you in Oracle Cloud My Services. See Modifying User Roles in Managing and Monitoring Oracle Cloud.

Request

Supported Media Types

• application/oracle-compute-v3+json
• application/json

Body ()

Restore to execute

Root Schema : RestoreInput

Type: object

Show Source

• backupName: string
  Pattern: (^/$|^(/[\w@\.-]+)+$)

  Multi-part name of the backup that you want to restore. The backup must be in the completed state.
• description(optional): string
  Description of the Restore
• name(optional): string
  Pattern: (^/$|^(/[\w@\.-]+)+$)

  The multi-part name of the object. Object names can contain only alphanumeric characters, hyphens, underscores, @ and periods. Object names are case-sensitive.
• volumeUri: string(uri)
  The entire URI of the storage volume that should be created when the backup is restored. Ensure that another volume with the same URI does not exist.

{
    "required":[
        "backupName",
        "volumeUri"
    ],
    "type":"object",
    "properties":{
        "description":{
            "type":"string",
            "description":"Description of the Restore"
        },
        "volumeUri":{
            "type":"string",
            "description":"The entire URI of the storage volume that should be created when the backup is restored. Ensure that another volume with the same URI does not exist.",
            "format":"uri"
        },
        "name":{
            "pattern":"(^/$|^(/[\\w@\\.-]+)+$)",
            "type":"string",
            "description":"The multi-part name of the object. Object names can contain only alphanumeric characters, hyphens, underscores, @ and periods. Object names are case-sensitive."
        },
        "backupName":{
            "pattern":"(^/$|^(/[\\w@\\.-]+)+$)",
            "type":"string",
            "description":"Multi-part name of the backup that you want to restore. The backup must be in the <code>completed</code> state."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/oracle-compute-v3+json
• application/json

201 Response

Successfully triggered restore.

Body ()

Root Schema : Restore

Type: object

Show Source

• backupConfigurationName(optional): string
  Pattern: (^/$|^(/[\w@\.-]+)+$)

  Multi-part name of the backup configuration.
• backupName(optional): string
  Pattern: (^/$|^(/[\w@\.-]+)+$)

  Multi-part name of the backup that you want to restore. The backup must be in the completed state.
• bootable(optional): boolean
  Default Value: false

  True if the restored volume is bootable
• description(optional): string
  Description of the Restore
• detailedErrorMessage(optional): string
  Read Only: true

  Human readable detailed error message
• errorMessage(optional): string
  Read Only: true

  Human readable error message
• name(optional): string
  Pattern: (^/$|^(/[\w@\.-]+)+$)

  The multi-part name of the object. Object names can contain only alphanumeric characters, hyphens, underscores, @ and periods. Object names are case-sensitive.
• runAsUser(optional): string
  Pattern: (^/$|^(/[\w@\.-]+)+$)

  Any actions on this model will be performed as this user.
• state(optional): string
  Allowed Values: [ "SUBMITTED", "INPROGRESS", "COMPLETED", "FAILED", "CANCELLING", "CANCELED", "TIMEDOUT", "DELETE_SUBMITTED", "DELETING", "DELETED" ]

  State of this resource.
• tagId(optional): string(uuid)
  ID used to tag other cloud resources
• uri(optional): string(uri)
  Uniform Resource Identifier
• volumeUri(optional): string(uri)
  The target volume created from this restore job

{
    "type":"object",
    "properties":{
        "volumeUri":{
            "type":"string",
            "description":"The target volume created from this restore job",
            "format":"uri"
        },
        "runAsUser":{
            "pattern":"(^/$|^(/[\\w@\\.-]+)+$)",
            "type":"string",
            "description":"Any actions on this model will be performed as this user."
        },
        "bootable":{
            "default":false,
            "type":"boolean",
            "description":"True if the restored volume is bootable"
        },
        "description":{
            "type":"string",
            "description":"Description of the Restore"
        },
        "errorMessage":{
            "readOnly":true,
            "type":"string",
            "description":"Human readable error message"
        },
        "uri":{
            "type":"string",
            "description":"Uniform Resource Identifier",
            "format":"uri"
        },
        "name":{
            "pattern":"(^/$|^(/[\\w@\\.-]+)+$)",
            "type":"string",
            "description":"The multi-part name of the object. Object names can contain only alphanumeric characters, hyphens, underscores, @ and periods. Object names are case-sensitive."
        },
        "backupConfigurationName":{
            "pattern":"(^/$|^(/[\\w@\\.-]+)+$)",
            "type":"string",
            "description":"Multi-part name of the backup configuration."
        },
        "state":{
            "enum":[
                "SUBMITTED",
                "INPROGRESS",
                "COMPLETED",
                "FAILED",
                "CANCELLING",
                "CANCELED",
                "TIMEDOUT",
                "DELETE_SUBMITTED",
                "DELETING",
                "DELETED"
            ],
            "type":"string",
            "description":"State of this resource."
        },
        "detailedErrorMessage":{
            "readOnly":true,
            "type":"string",
            "description":"Human readable detailed error message"
        },
        "tagId":{
            "type":"string",
            "description":"ID used to tag other cloud resources",
            "format":"uuid"
        },
        "backupName":{
            "pattern":"(^/$|^(/[\\w@\\.-]+)+$)",
            "type":"string",
            "description":"Multi-part name of the backup that you want to restore. The backup must be in the <code>completed</code> state."
        }
    }
}

400 Response

Backup does not exist or is not completed. Not authorized to access or use backup referenced by the restore.

401 Response

Not authorized to create the restore.

500 Response

The server encountered an error handling this request.

Back to Top

Examples

cURL Command

The following example shows how to restore a storage volume from a previously completed backup by submitting a POST request on the REST resource using cURL. For more information about cURL, see Use cURL.

Enter the command on a single line. Line breaks are used in this example for readability.

curl -i -X POST
     -H "Cookie: $COMPUTE_COOKIE"
     -H "Content-Type: application/oracle-compute-v3+json"
     -H "Accept: application/oracle-compute-v3+json"
     -d "@requestbody.json"
        https://api-z999.compute.us0.oraclecloud.com/backupservice/v1/restore/

• COMPUTE_COOKIE is the name of the variable in which you stored the authentication cookie earlier. For information about retrieving the authentication cookie and storing it in a variable, see Authentication.

• api-z999.compute.us0.oraclecloud.com is an example REST endpoint URL. Change this value to the REST endpoint URL of your Compute Classic site. For information about finding out REST endpoint URL for your site, see Send Requests.

Example of Request Body

The following shows an example of the request body content in the requestbody.json file to restore a storage volume from backup /Compute-acme/[e-mail]/BACKUP-A and create a new storage volume by the name /Compute-acme/[e-mail]/restored-example-volume.

{
  "name": "/Compute-acme/[e-mail]/RESTORE-A",
  "backupName": "/Compute-acme/[e-mail]/BACKUP-A",
  "volumeUri": "http://api-z999.compute.us0.oraclecloud.com/storage/volume/Compute-acme/[e-mail]/restored-example-volume",
  "description": null
}

Example of Response Body

The following example shows the response body in JSON format.

{
  "uri": "https://api-z999.compute.us0.oraclecloud.com/backupservice/v1/restore/Compute-acme/[e-mail]/RESTORE-A",
  "runAsUser": "/Compute-acme/[e-mail]",
  "name": "/Compute-acme/[e-mail]/RESTORE-A",
  "backupName": "/Compute-acme/[e-mail]/BACKUP-A",
  "backupConfigurationName": "Compute-acme/[e-mail]/backupConfigVol1",
  "volumeUri": "http://api-z999.compute.us0.oraclecloud.com/storage/volume/Compute-acme/[e-mail]/restored-example-volume",
  "errorMessage": "",
  "detailedErrorMessage": "",
  "state": "SUBMITTED",
  "bootable": false,
  "description": null
}

Back to Top