Getting Backup Copy Jobs

You can get a resource representation of a backup copy job with the specified ID.

Request

GET https://<hostname>:4443/v6/CopyJobs/{id}

Request Headers

The request header must contain an authorization token of the current session.

Request Parameters

The following parameter must be specified in the URL of the request:

Parameter

Type

Description

id

string

Specifies the identification number of the backup copy job. For more information on how to get this parameter, see Getting Backup Copy Jobs.

Request Body

None.

Response

The server returns the following response to the client.

Response Codes

A successfully completed operation returns a response code 200 OK.

Response Headers

The response to this request contains the following headers. The response may also include additional standard HTTPS headers.

Header

Description

Content-length

The length of the response body.

Content-type

The media type and syntax of the response body message: application/json; charset=utf-8

Response Body

The response body contains the following properties:

Property

Type

Description

backupJobId

string

Specifies the backup job ID.

id

string

Specifies the backup copy job ID.

name

string

Specifies a name of the backup copy job.

repositoryId

string

Specifies the ID of the backup repository extended with an archive object storage.

lastStatus

string

Specifies the latest status of the backup copy job. The following values are available:

  • Stopped
  • Running
  • Success
  • Warning
  • Failed
  • Disconnected
  • NotConfigured
  • Queued

lastRun

UTC

Specifies the time of the last run of the backup copy job.

nextRun

UTC

Specifies the time of the next run of the backup copy job per schedule.

isEnabled

boolean

If set to true, indicates that the backup copy job is enabled.

schedulePolicy

schedulePolicy

Specifies the backup copy job scheduling options.

_links

Dictionary of string [key] and Object [value]

Links to related resources (navigation property).

schedulePolicy

The backup copy job schedule policy has the following properties:

Property

Type

Description

type

string

Specifies the backup copy job schedule type. The following types are available:

  • Immediate. The backup copy job runs right after the latest restore point appears in a source backup repository.
  • DailyAtTime. The backup copy job runs on the specified days at the specified hours.
  • Periodically. The backup copy job runs repeatedly throughout a day with a specific time interval.

dailyType

string

Specifies the days when the backup copy job will run. The following values are available:

  • Everyday
  • Weekends
  • Workdays
  • Monday
  • Tuesday
  • Wednesday
  • Thursday
  • Friday
  • Saturday
  • Sunday

dailyTime

UTC

Specifies the time to start the backup copy job.

periodicallyEvery

string

Specifies the time interval between the backup copy job runs. The following values are available:

  • Minutes5
  • Minutes10
  • Minutes15
  • Minutes30
  • Hours1
  • Hours2
  • Hours4
  • Hours8

backupCopyWindowEnabled

boolean

If set to true, indicates that a backup copy window feature is enabled for this backup copy job.

backupCopyWindowSettings

backupCopyWindowSettings

Specifies the backup copy window settings. A backup copy window is a time period within which the backup copy job must be completed.

backupCopyWindowSettings

The backup copy window has the following properties:

Property

Type

Description

backupWindow

boolean[]

Defines an hourly scheme for the backup copy window. The scheduling scheme consists of 168 boolean elements. These elements can be logically divided into 7 groups by 24. Each group represents a day of the week starting from Sunday. Each element represents a backup copy hour:

  • true — the allowed backup copy hour
  • false — the prohibited backup copy hour

minuteOffset

integer

Specifies the current minute offset from the UTC time.

Example

The example returns a resource representation of the backup copy job with the ID beace76b-1ac7-4b5a-8fae-6f6cccd83f1f.

Request:

GET https://abc.tech.local:4443/v6/CopyJobs/beace76b-1ac7-4b5a-8fae-6f6cccd83f1f

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200 OK

 

Response Body:

{

 "backupJobId": "b7c1cc0b-2b3c-4096-9ba1-2d665b4ae504",

 "schedulePolicy": {

   "type": "Immediate",

   "backupCopyWindowEnabled": true,

   "backupCopyWindowSettings": {

     "backupWindow": [

       true,

       true,

       ...

       true,

       true,

       true,

       true

     ],

     "minuteOffset": 0

   }

 },

 "id": "beace76b-1ac7-4b5a-8fae-6f6cccd83f1f",

 "repositoryId": "f93dc1b5-5ecd-45ce-b4dd-5519160b6713",

 "name": "Backup1 - copy job",

 "lastRun": "2022-01-20T21:25:38.2557629Z",

 "isEnabled": true,

 "lastStatus": "Success",

 "_links": {

   "self": {

     "href": "/v6/copyJobs/beace76b-1ac7-4b5a-8fae-6f6cccd83f1f"

   },

   "organization": {

     "href": "/v6/organizations/e60dfb9c-ac58-4463-879f-9855ac35576b"

   },

   "backupJob": {

     "href": "/v6/job/b7c1cc0b-2b3c-4096-9ba1-2d665b4ae504"

   },

   "backupRepository": {

     "href": "/v6/backuprepositories/f93dc1b5-5ecd-45ce-b4dd-5519160b6713"

   }

 }

}