Get Recovery Plan

Get Recovery Plan

Recovery plans are used for automating the recovery execution during a migration or a failover.

Request
URI
GET
https://{api_host}/pairings/{pairing_id}/recovery-management/plans/{plan_id}
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


Authentication
This operation uses the following authentication methods.
Responses
200

Information about a recovery plan.

Returns RecoveryPlanInfoDrResponseEntity of type(s) application/json
This response body class contains all of the following: RecoveryPlanInfo
{
    "id": "string",
    "status": "string",
    "protected_site_name": "string",
    "recovery_site_name": "string",
    "protected_vc_guid": "string",
    "recovery_vc_guid": "string",
    "name": "string",
    "description": "string",
    "location": "string",
    "location_name": "string",
    "progress": 0,
    "is_running": false,
    "_meta": {
        "errors": [
            {
                "code": "string",
                "message": "string",
                "field": "string"
            }
        ]
    }
}
_meta
Optional

_meta


400

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

Returns ResponseError of type(s) application/json
{
    "error_code": "string",
    "message": "string",
    "op_id": "string"
}
string
error_code
Optional

error_code

string
message
Optional

message

string As uuid As uuid
op_id
Optional

op_id


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
{
    "error_code": "string",
    "message": "string",
    "op_id": "string"
}
string
error_code
Optional

error_code

string
message
Optional

message

string As uuid As uuid
op_id
Optional

op_id


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
{
    "error_code": "string",
    "message": "string",
    "op_id": "string"
}
string
error_code
Optional

error_code

string
message
Optional

message

string As uuid As uuid
op_id
Optional

op_id