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

Get Recovery Steps Callout Details

Description

Get detailed information about a callout/prompt for a recovery step in a given recovery view mode.

Will fail if cannot retrieve recovery steps in the desired mode in the current recovery plan state or the recovery step is not callout/prompt-related.

Request

Request

URL

URL


get
https://{api_host}//pairings/{pairing_id}/recovery-management/plans/{plan_id}/recovery-steps/{view_mode}/{recovery_step_id}/callout-data
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.


string
recovery_step_id Required

Id of a recovery step.


Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns CalloutDrResponseEntity of type application/json

Callout/Prompt details.

{
	"_meta": {
		"errors": [
			{
				"code": "string",
				"field": "string",
				"message": "string"
			}
		]
	},
	"callout_type": "PROMPT",
	"content": "string",
	"id": "string",
	"name": "string",
	"step_type": "PRE_POWER_ON",
	"timeout_seconds": 0
}
_meta Optional

Response meta data. Contains data about the response payload data.

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-SrmGetRecoveryStepsCalloutDetails -pairingId "MypairingId" -planId "MyplanId" -viewMode "MyviewMode" -recoveryStepId "MyrecoveryStepId"

cURL Command

curl https://{api_host}/pairings/{pairing_id}/recovery-management/plans/{plan_id}/recovery-steps/{view_mode}/{recovery_step_id}/callout-data
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 latest?
INTRODUCED
Recovery Operations
Feedback

Was this page helpful?