Changed1
[{"label":"Latest (2.0.0)","version":"latest"},{"version":"1.0.0"}]
srm-rest-api

Get Recovery Steps

Description

Get 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

Request

URL

URL


get
https://{api_host}//pairings/{pairing_id}/recovery-management/plans/{plan_id}/recovery-steps/{view_mode}
Copy

Path Parameters

Path Parameters

string
pairing_id Required

The ID of a pairing between this Site Recovery Manager server and remote one.


string
plan_id Required

The ID of a recovery plan defined within current pairing.


string
view_mode Required

The view mode of the recovery steps. Possible values are: test, recovery, cleanup, reprotect.


Query Parameters

Query Parameters

string
expanded_step_ids Optional

Comma-separated list of IDs of recovery steps to expand.

expanded_step_ids example
"['123','403','1010']"

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns RecoveryStepDrResponseList of type application/json

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"
			]
		}
	]
}
_meta Optional

List metadata


array of RecoveryStep
list Optional

Information about a recovery step.

Errors

Errors

ResponseError
400

Bad request - the server could not understand the request due to invalid syntax or invalid request body content


401

Unauthorized - the client must authenticate itself to get the requested response


ResponseError
403

Forbidden - not sufficient access rights to fulfill the request


404

Not Found - server cannot find the requested in URL resource


ResponseError
500

Internal server error - unexpected condition prevents fulfilling the request

Code Samples

Code Samples

PowerCLI Client SDK Example

Invoke-SrmGetRecoverySteps -pairingId "MypairingId" -planId "MyplanId" -viewMode "MyviewMode" -expandedStepIds ['123','403','1010']

cURL Command

curl https://{api_host}/pairings/{pairing_id}/recovery-management/plans/{plan_id}/recovery-steps/{view_mode}
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
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


[{"label":"Latest (2.0.0)","version":"latest"},{"version":"1.0.0"}]
srm-rest-api
What's changed in 2.0.0?
INTRODUCED
Recovery Operations
Feedback

Was this page helpful?