Get a List of Recovery Points
Returns the list of the recovery points of the specified backup object.
This method can be used for purposes other than getting the recovery points list. This article describes this particular application of the method.
Endpoint
https://<Director_IP_address>:4443/c/router
Request Example
curl --request POST \
--url https://<Director_IP_address>:4443/c/router \
--header "content-type: application/json" \
--cookie @cookies.txt \
--data "{
"action": "InventoryManagement",
"method": "list",
"data": [{
"nodeType": "BACKUP_OBJECT",
"nodeId": 16,
"includeTypes": ["SAVEPOINT"]}],
"type": "rpc",
"tid": 1}"
Request Fields
Field
|
Type
|
Value(s)
|
---|---|---|
action
|
string |
|
method
|
string |
|
data
|
array | Request parameters. See below |
type
|
string | rpc
|
tid
|
integer | 1 |
Data
Field
|
Type
|
Description
|
---|---|---|
nodeType
|
string | The type of node. Must be BACKUP_OBJECT in this case |
nodeId
|
int | The ID of the backup object |
|
boolean |
If |
includeTypes
|
array of string | Must be SAVEPOINT in this case |
Response Sample
{
"action": "InventoryManagement",
"method": "list",
"tid": "1",
"type": "rpc",
"message": null,
"where": null,
"cause": null,
"data": {
"children": [
{
"extendedInfo": null,
"identifier": 243,
"vid": "SAVEPOINT-243",
"type": "SAVEPOINT",
"subType": null,
"name": "VoT-NBR",
"description": null,
"accessible": true,
"isDisabled": false,
"replicable": false,
"hvType": "NONE",
"flags": 0,
"children": null
}
}
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 | The parameters of the recovery points |
data.children
Field
|
Value
|
Description
|
---|---|---|
|
|
Extended info (if present) |
identifier
|
long | Recovery point ID |
vid
|
string | Recovery point VID |
type
|
string | Type of the object. SAVEPOINT in this case |
subType
|
string | The subtype of the object. Not applicable in this case |
name
|
string | Display name |
description
|
string | Description (null if absent) |
accessible
|
boolean | If true , the object is accessible |
isDisabled
|
boolean |
Checks if the object is accessible |
replicable
|
boolean | Checks if the object is replicable |
hvType
|
string | Platform type. Not applicable in this case (NONE ) |
flags
|
int |
For VMware ESXi hosts:
|
children
|
array | The children objects. Not applicable in this case |