Get Recovery Steps Callout Details

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

URI

GET

https://{api_host}/pairings/{pairing_id}/recovery-management/plans/{plan_id}/recovery-steps/{view_mode}/{recovery_step_id}/callout-data

COPY

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

This operation uses the following authentication methods.

SessionHeader

Responses

200

Callout/Prompt details.

Returns CalloutDrResponseEntity of type(s) application/json

This response body class contains all of the following: InlineCalloutDrResponseEntity1

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

400

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

Returns ResponseError of type(s) application/json

"ResponseError Object"

string

error_code

Optional

The code of the error.

string

message

Optional

The message of the error.

string As uuid As uuid

op_id

Optional

The ID of the operation.

401

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

Operation doesn't return any data structure

403

Forbidden - not sufficient access rights to fulfill the request

Returns ResponseError of type(s) application/json

"ResponseError Object"

string

error_code

Optional

The code of the error.

string

message

Optional

The message of the error.

string As uuid As uuid

op_id

Optional

The ID of the operation.

404

Not Found - server cannot find the requested in URL resource

Operation doesn't return any data structure

500

Internal server error - unexpected condition prevents fulfilling the request

Returns ResponseError of type(s) application/json

"ResponseError Object"

string

error_code

Optional

The code of the error.

string

message

Optional

The message of the error.

string As uuid As uuid

op_id

Optional

The ID of the operation.

Code Samples

COPY

                    curl -H 'Authorization: <value>' https://{api_host}/pairings/{pairing_id}/recovery-management/plans/{plan_id}/recovery-steps/{view_mode}/{recovery_step_id}/callout-data

On This Page

Description

Request

Path Parameters

Authentication

Response

200 Response Body

Errors

Recovery Operations

GET

Get All Plan History Records

GET