Get Recovery Steps
DescriptionGet information about recovery steps in a given recovery view mode.
Will fail if unable to retrieve recovery steps in the desired mode in the current recovery plan state.
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.
The view mode of the recovery steps. Possible values are: test
, recovery
, cleanup
, reprotect
.
Query Parameters
Query Parameters
Comma-separated list of IDs of recovery steps to expand.
expanded_step_ids example
"['123','403','1010']"
Authentication
Response
Response BodyResponse Body
200 OK
List of recovery steps.
{
"_meta": {
"errors": [
{
"code": "string",
"field": "string",
"message": "string"
}
],
"limit": 0,
"links": {
"next": {
"href": "string"
},
"previous": {
"href": "string"
},
"self": {
"href": "string"
}
},
"offset": 0,
"total": 0
},
"list": [
{
"child_count": 0,
"depth": 0,
"errors": [
"string"
],
"expanded": false,
"finish_time": 0,
"id": 0,
"plan_callout_position_spec": {
"position_spec_index": 0,
"position_spec_position": "AT_BEGIN"
},
"progress": 0,
"referred_object": "string",
"start_time": 0,
"status": "INACTIVE",
"step_number": "string",
"title": "string",
"vm_callout_position_spec": {
"index": 0,
"pre_power_on": false,
"vm_id": "string"
},
"warnings": [
"string"
]
}
]
}
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
- System.Read
x-dr-remote-site-connectivity-contract:
not-authenticated: DEPENDS_ON_PROVIDED_PARAMS
server-down: DEPENDS_ON_PROVIDED_PARAMS