Jump to

• Request
• Response
• Examples

Move a Backup (Download or Archive)

post

/paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}/backups/{backupId}

Enables you to move a backup of an Oracle Java Cloud Service instance to:

• Object storage (archive)
• Block storage on the Administration Server (download)

For complete information about contents of backups and where backups are stored, see About Backup and Restoration in Administering Oracle Java Cloud Service.

Request

Supported Media Types

• application/json

Path Parameters

• backupId: string
  Backup ID. To retrieve the backup ID, see View All Backups.
• identityDomainId: string
  Identity domain ID for the Oracle Java Cloud Service account.
• serviceId: string
  Name of the Oracle Java Cloud Service instance.

Header Parameters

• Authorization: string
  Base64 encoded user name and password separated by a colon or OAuth access token obtained from Oracle Identity Cloud Service. See Authenticate.
• X-ID-TENANT-NAME: string
  Identity domain ID for the Oracle Java Cloud Service account.

Body ()

The request body contains details of the archive or download backup request.

Root Schema : archivedownload-request

Type: object

The request body defines the details of the archive or download backup request.

Show Source

• local: boolean
  Flag that specifies whether the backup is to be downloaded and stored locally in block storage on the Administration Server host (true), or archived and stored remotely (false). The remote storage is the specified object storage container or bucket.

{
    "description":"The request body defines the details of the archive or download backup request.",
    "properties":{
        "local":{
            "type":"boolean",
            "description":"Flag that specifies whether the backup is to be downloaded and stored locally in block storage on the Administration Server host (<code>true</code>), or archived and stored remotely (<code>false</code>). The remote storage is the specified object storage container or bucket."
        }
    },
    "required":[
        "local"
    ]
}

Back to Top

Response

Supported Media Types

• application/json

202 Response

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

Body ()

Root Schema : archivedownload-response

Type: object

The response body contains information about the archive or download backup operation.

Show Source

• job_id(optional): string
  Job ID for the archive or download backup operation.
• operationName(optional): string
  Name of operation performed. Set to: move-backup.
• target_uri(optional): string
  URI of the archive or download backup resource.

{
    "description":"The response body contains information about the archive or download backup operation.",
    "properties":{
        "job_id":{
            "type":"string",
            "description":"Job ID for the archive or download backup operation."
        },
        "operationName":{
            "type":"string",
            "description":"Name of operation performed. Set to: <code>move-backup</code>."
        },
        "target_uri":{
            "type":"string",
            "description":"URI of the archive or download backup resource."
        }
    }
}

Back to Top

Examples

The following example shows how to download or archive a backup for an Oracle Java Cloud Service instance by submitting a POST 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 POST -u username:password -d @movebackup.json -H "Content-Type:application/json" -H "X-ID-TENANT-NAME:ExampleIdentityDomain" https://rest_server_url/paas/api/v1.1/instancemgmt/ExampleIdentityDomain/services/jaas/instances/ExampleInstance/backups/1390442367140

Example of Request Body

The following example shows the contents of the request body in JSON format, for a download operation.

{
   "local":true
}

The following example shows the contents of the request body in JSON format, for an archive operation.

{
   "local":false
}

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 202 Accepted
Date: Mon, 07 Dec 2015 23:33:53 GMT
Transfer-Encoding: chunked
Content-Type: application/json

Example of Response Body

The following shows an example of the response body in JSON format.

{
   "operationName":"move-backup",
   "target_uri":"https:\/\/rest_server_url\/paas\/api\/v1.1\/instancemgmt\/ExampleIdentityDomainID\/services\/jaas\/instances\/ExampleInstance\/backups\/1390442367140",
   "job_id":"101"
}

Back to Top