- URL:
- https://<root>/system/disasterrecovery/status
- Methods:
GET- Version Introduced:
- 10.9
Access requirements
Required privileges
The Enterprise Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.
Tokens
This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Enterprise Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.
Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generate operation in the Enterprise Directory API. For security reasons, all POST requests made to the Enterprise Administrator API must include a token in the request body.
Description
The status resource returns information about the last submitted disaster recovery job. At 10.9, status returned the status of a current, or previously executed, backup.
Request parameters
| Parameter | Details |
|---|---|
| The response format. The default format is Values: |
Example usage
The following is a sample request URL used to access the status resource:
https://organization.example.com/<context>/admin/system/disasterrecovery/status?f=pjsonJSON Response example
{
"status": {
"code": 3,
"scheduleType": "SCHEDULED",
"stages": [
{
"duration": "3096 millis (~ 0 minutes)",
"lastUpdated": 1635285646933,
"name": "Validation",
"state": "completed"
},
{
"duration": "5149 millis (~ 0 minutes)",
"lastUpdated": 1635285646933,
"name": "Stage Relational store",
"state": "completed"
},
{
"duration": "50405 millis (~ 0 minutes)",
"lastUpdated": 1635285646933,
"name": "Stage Object store",
"state": "completed"
},
{
"duration": "6517 millis (~ 0 minutes)",
"lastUpdated": 1635285646933,
"name": "Stage system configuration",
"state": "completed"
},
{
"duration": "0 millis (~ 0 minutes)",
"lastUpdated": 1635285646933,
"name": "Post backup operation cleanup",
"state": "completed"
}
],
"completeTime": 1635285728493,
"startTime": 1635285646935,
"state": "success",
"backupStore": "default",
"message": "",
"operation": "Backup",
"overallDuration": "00hr:01min:04sec:221millisec",
"backupName": "schedule1-2021-10-26-22-00-46"
}
}JSON Response example (10.9)
The following sample response is returned when a backup has yet to be created for the deployment:
{
"status": {
"code": 0,
"messages": [],
"state": "no_op"
}
}The following response is returned when a backup is created:
{
"status": {
"code": 3,
"messages": [
{
"code": 4014,
"message": "Started backup process.",
"when": 1618868887759
},
{
"code": 4015,
"message": "Started relational data store backup.",
"when": 1618868938768
},
{
"code": 4017,
"message": "Completed relational data store backup.",
"when": 1618869085290
},
{
"code": 4018,
"message": "Persisted relational data store backup results.",
"when": 1618869085292
},
{
"code": 4019,
"message": "Started object store backup.",
"when": 1618869085320
},
{
"code": 4021,
"message": "Completed objectstore backup.",
"when": 1618869134849
},
{
"code": 4022,
"message": "Persisted objectstore backup.",
"when": 1618869134866
},
{
"code": 4023,
"message": "Started runtime infrastructure & configuration backup.",
"when": 1618869134866
},
{
"code": 4025,
"message": "Completed runtime infrastructure & configuration backup.",
"when": 1618869140040
},
{
"code": 4026,
"message": "Persisted runtime infrastructure & configuration backup results.",
"when": 1618869140041
},
{
"code": 4027,
"message": "Persisted backup results.",
"when": 1618869141431
},
{
"code": 4028,
"message": "Completed backup results.",
"when": 1618869141440
}
],
"state": "success"
}
}