Get All Backup Objects

Last modified: 24 May 2024

Gets the list of all backup objects.

Endpoint

https://<Director_IP_address>:4443/c/router

Tenant Endpoint

For tenants of the multi-tenant product the endpoint must be:
https://<Director_IP_address>:4443/t/<tenant_UUID>/c/router

Request Example

curl

Copy

{
  "action": "TapeBackupManagement",
  "method": "getBackupObjects",
  "data": [{
    "filter": {
      "start": 0,
      "count": 200,
      "sort": "NAME",
      "sortAsc": true,
      "criteria": [{
        "type": "EQ",
        "name": "HV_TYPE",
        "value": "VMWARE"
      }],
      "criteria": [{
        "type": "LIKE",
        "name": "NAME",
        "value": "Cent"
      }],
      "criteria": [{
        "type": "EQ",
        "name": "LOCATION_ID",
        "value": "1"
      }]
    }
  }],
  "type": "rpc",
  "tid": 1
}

Request Fields

Field	Type	Value(s)
`action`	string	`TapeBackupManagement`
`method`	string	`getBackupObjects`
`data`	array	Filter parameters. See the `filter` table below
`type`	string	`rpc`
`tid`	int	`1`

filter

Field	Type	Description
`start`	int	A start ID of the backup object to be returned
`count`	int	Number of backup objects to be returned
`sort`	string	Backup object parameter to be sorted with
`sortAsc`	boolean	`true` if the order is ascending
`criteria`	array	Filter criteria. See the rows below
`type`	string	Type of criterion
`name`	string	Name of criterion. `NAME` means the backup object name
type	string	Type of the criterion. `EQ` means the equality relational operator
value	string	Value of the criterion

Response Sample

curl

Copy

{
    "action": "TapeBackupManagement",
    "method": "getBackupObjects",
    "tid": "1",
    "type": "rpc",
    "message": null,
    "where": null,
    "cause": null,
    "data": {
        "children": [
            {
                "vid": "BACKUP_OBJECT-23",
                "name": "Centos7",
                "hvType": "VMWARE",
                "tapeCartridgeCount": 2,
                "savepointCount": 4,
                "firstSavepoint": null,
                "lastSavepoint": "2019-03-28T10:59:11.575+07:00",
                "locationNames": [
                    "My office"                ],
                "totalSize": null,
                "isOffline": false,
                "isMarkedAsFree": true,
                "incompleteBackups": false
            },
            {
                "vid": "BACKUP_OBJECT-24",
                "name": "Centos7",
                "hvType": "VMWARE",
                "tapeCartridgeCount": 2,
                "savepointCount": 1,
                "firstSavepoint": null,
                "lastSavepoint": "2019-03-22T14:20:37.644+07:00",
                "locationNames": [
                    "My office"                ],
                "totalSize": null,
                "isOffline": false,
                "isMarkedAsFree": true,
                "incompleteBackups": false
            }
        ],
        "totalCount": 2
    }
}

Response Fields

Field	Value	Description
`message`	string	Message if the request failed
`where`	string	Reference to the method where the problem occurred
`cause`	string	Cause of failure
`data`	Json	Backup object info

data.children

Field	Value	Description
`vid`	string	Backup object VID
`name`	string	Backup object name
`hvType`	string	Platform type. Possible values: `VMWARE, AWS, HYPERV, NONE, PHYSICAL, NUTANIX`
`tapeCartridgeCount`	long	Number of tape cartridges
`savepointCount`	long	Number of recovery points
`firstSavepoint`	DateTime	Date of the first recovery point
`lastSavepoint`	DateTime	Date of the last recovery point
`locationNames`	array	Location names
`isOffline`	boolean	`true` if the tape cartridge is offline
`isMarkedAsFree`	boolean	`true` if the tape cartridge was marked as free
`incompleteBackups`	boolean	`true` if the backup object has incomplete backups