Get Plan History Records
DescriptionIf no start_date and end_date are specified, then the last seven days of data will be returned.
Request
URLURL
Path Parameters
Path Parameters
The ID of a pairing between this Site Recovery Manager server and remote one.
The ID of a recovery plan defined within current pairing.
Query Parameters
Query Parameters
End date of the desired timeframe in milliseconds since the standard base time known as “the epoch”, since January 1, 1970, 00:00:00 GMT. Default value: current time in milliseconds.
end_date example
"1508484583300"
The filter value by which to filter the result data. Must be used in combination with filter_prop parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1&filter=vm-2
The name of the field by which to filter the result data. Must be used in combination with filter parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1
Specify the limit size of the result data. In combination with offset parameter provides paging functionality. If none - configuration property ‘defaultResponsePageSize’ in REST API configuration file is taken into account. If configuration property is not defined - default value of 100 is taken into account.
limit example
"10"
The amount of elements to skip in the response. In combination with limit parameter provides paging functionality. Must be used in combination with limit parameter. If none - default value of 0 is taken into account. Example: https://dr-server/api/vms?limit=10&offset=10
offset example
"10"
Define desired sort order by field of the result data. Must be used in combination with sort_by. Supported values: asc, ascending, desc, descending.
Define desired sort by field of the result data. If order_by is not specified, ascending is used as default.
sort_by example
"name"
Start date of the desired timeframe in milliseconds since the standard base time known as “the epoch”, since January 1, 1970, 00:00:00 GMT. Default value: current time minus 7 days in milliseconds.
start_date example
"1508482583300"
Authentication
Response
Response BodyResponse Body
202 Accepted
A task to monitor the generation of the history list. Result is of type HistoryReport.
{
"_meta": {
"errors": [
{
"code": "string",
"field": "string",
"message": "string"
}
]
},
"complete_time": 0,
"description": "string",
"description_id": "string",
"entity": "string",
"entity_name": "string",
"error": {
"details": "string",
"message": "string"
},
"id": "string",
"progress": 0,
"queued_time": 0,
"result": {},
"start_time": 0,
"status": "QUEUED"
}
Errors
Bad request - the server could not understand the request due to invalid syntax or invalid request body content
Unauthorized - the client must authenticate itself to get the requested response
Forbidden - not sufficient access rights to fulfill the request
Not Found - server cannot find the requested in URL resource
Internal server error - unexpected condition prevents fulfilling the request
Code Samples
PowerCLI Client SDK Example
cURL Command
Vendor Extensions
x-dr-permissions:
permissions: System.View
x-dr-remote-site-connectivity-contract:
not-authenticated: FULL_DATA
server-down: FULL_DATA
