get_backup_catalog_by_day
Alberto Gonzalez edited this page Oct 29, 2015
·
1 revision
Returns the list of restorable backups in a structured way given the view selected. Individual instances can also be specified.
GET /api/backups/catalog/?sid={sid}&view=day
Host: <server host name>
Accept: application/json
AuthToken: <authentication token returned from authenticate>
The following parameters may be added on the URL for additional filtering.
| Name | Description | Type | Required |
|---|---|---|---|
| ?sid={sid} | The system ID for the system for which we want to get backups | long | No |
| &iid={iid} | The instance for which we want to get backups | long | No |
| &cid={cid} | The client for which we want to get backups | long | No |
| &start_date={date} | The start date for which we want to get backups | date string | No |
| &end_date={date} | The end date for which we want to get backups | date string | No |
| &grandclient={true/false} | Return replicated backups or not (default false) | boolean | No |
| Index | Value | Type | Returned |
|---|---|---|---|
| client_id | Client id associated with this backup | long | always |
| client_name | Client name associated with this backup | long | always |
| instance_id | id of instance | long | always |
| instance_name | Name of instance or server | string | always ("" if not defined) |
| database_name | Name of database or VM or virtual machine for vm types | string | always ("" if not defined) |
| system_name | Name of system on which this instance is associated | string | always |
| system_id | id of system to which this instance is associated | long | always |
| app_name | name of application | string | always |
| grandclient | client is a replicated or direct client | boolean | always |
| backups | array of backup info | array | always |
The backup array consists of:
| Index | Value | Type | Returned |
|---|---|---|---|
| id | Backup id | long | for types with backup id |
| type | Backup type formatted nicely | string | always |
| start_date | nicely printed backup start date | string | always |
| disks | disks included in backup | array | always, empty array if not present |
| volumes | volumes included in backup | array | always, empty if not present |
| replicated | the backup is replicated or not | boolean | always |
| status | backup status as a nicely-formatted string of "Success", "Warning", "Failure" | string | always |
| legal_hold | the back up is legally held or not | boolean | always |
| storage | the name of the storage on which the backup is located, e.g., "Internal", "Default" | string | always |
| hold | number of days remaining that the backup is on hold, e.g., "5 days remaining", "1 day remaining" | string | always, may be "" |
| size | size of backup in MB, e.g., "22 MB" | string | always |
| app_name | type of application that the backup resides on ('Physical Server' for agent based backups) | string | always |
Disks and Volumes return an array of information as follows:
| Index | Value | Type | Returned |
|---|---|---|---|
| id | id of the disk or volume | long | always |
| name | name of the disk or volume | string | always |
| mb_size | size of the disk or volume in MB | long | always |
GET /api/backups/catalog/?view=instance
Host: <server host name>
Accept: application/json
AuthToken: 8a00sjerhterqerjlqkjlk443l4j56869h4f_)(fjdkasHHHHHkdal324
{
"catalog": [
{
"day": "9/22/2014",
"instances": [
{
"app_name": "VMware",
"backups": [
{
"id": 66,
"type": "Full",
"start_date": "9/22/2014 7:05PM",
"disks": [
{
"id": 101,
"name": "Hard disk 1",
"mb_size": 42949672960
},
{
"id": 107,
"name": "Hard disk 2",
"mb_size": 21474836480
}
],
"legal_hold": false,
"replicated": false,
"storage": "Internal",
"hold": "",
"size": "22 MB"
}
],
"client_id": 4,
"client_name": "vCenter-RRC",
"database_name": "Win2012",
"grandclient": false,
"instance_id": 402,
"instance_name": "10.101.208.189",
"system_id": 1,
"system_name": "CentOS6-UEB"
},
{
"app_name": "",
"backups": [
{
"id": 58,
"start_date": "9/21/2014 7:05PM",
"type": "Incremental",
"legal_hold": false,
"replicated": false,
"storage": "Internal",
"hold": "",
"size": "22 MB",
"volumes": [
{
"id": 101,
"name": "C:",
"mb_size": 21474836480
}
]
}
],
"client_id": 3,
"client_name": "Win-2012",
"database_name": "",
"grandclient": false,
"instance_id": 34,
"instance_name": "",
"system_id": 1,
"system_name": "CentOS6-UEB"
}
]
},
{
"day": "9/21/2014",
"instances": [
{
"app_name": "VMware",
"backups": [
"backups": [
{
"start_date": "9/21/2014 7:05PM",
"disks": [
{
"id": 101,
"name": "Hard disk 1",
"mb_size": 42949672960
},
{
"id": 107,
"name": "Hard disk 2",
"mb_size": 21474836480
}
],
"id": 61,
"storage": "Internal",
"type": "Incremental"
}
],
"client_id": 4,
"client_name": "vCenter-RRC",
"database_name": "Win2012",
"grandclient": false,
"instance_id": 402,
"instance_name": "10.101.208.189",
"system_id": 1,
"system_name": "CentOS6-UEB"
},
{
"app_name": "",
"backups": [
{
"start_date": "9/22/2014 7:05PM",
"database_name": "",
"id": 62,
"instance_name": "",
"legal_hold": false,
"replicated": false,
"storage": "Internal",
"hold": "",
"size": "220 MB",
"type": "Full",
"volumes": [
{
"id": 101,
"name": "C:",
"mb_size": 21474836480
}
]
}
],
"client_id": 3,
"client_name": "Win-2012",
"database_name": "",
"grandclient": false,
"instance_id": 34,
"instance_name": "",
"system_id": 1,
"system_name": "CentOS6-UEB"
}
]
}
]
}