Get Recovery Plan Report | VMware Cloud Director Availability API

Get Recovery Plan Report

This request returns the execution details of a specific recovery plan execution

Request

URI

GET

https://{api_host}//recovery-plans/{recoveryPlanId}/executions/{executionId}/report

COPY

Path Parameters

string

recoveryPlanId

Required

recoveryPlanId

recoveryPlanId example

e7bf7128-2825-48ca-9075-3f496de70ffe

string

executionId

Required

executionId

executionId example

112f9661-ebec-45ad-875b-18e2e3f9e39b

Header Parameters

string

operationID

Optional

Operation ID for correlating logs across multiple services

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Responses

200

Returns CloudRecoveryPlanExecutionReport of type(s) application/vnd.vmware.h4-v4.6+json;charset=UTF-8

This response body class contains all of the following: BaseRecoveryPlanExecutionReport , InlineCloudRecoveryPlanExecutionReport1

{
    "error": {
        "args": [],
        "code": "Forbidden",
        "msg": "Permission denied.",
        "stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
    },
    "execEnd": 1645707066012,
    "execStart": 1645707065923,
    "executionId": "271c8c0b-aba5-425c-b8f3-3ada3d4d2e14",
    "operation": "TEST",
    "planDescription": "The example of the plan.",
    "planId": "6556244a-5d1a-4166-8ed6-38db17e037b8",
    "planName": "271c8c0b-aba5-425c-b8f3-3ada3d4d2e14",
    "planOwner": "root",
    "planType": "RECOVERY",
    "result": "SUCCEEDED",
    "site": "site1",
    "executedSteps": [],
    "notExecutedSteps": []
}

401

The returned error codes include (but are not limited to): NotAuthenticated

Returns ApiError of type(s) application/vnd.vmware.h4-v4.6+json;charset=UTF-8

{
    "args": [],
    "code": "Forbidden",
    "msg": "Permission denied.",
    "stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
}

array of string

args

Optional

Positional arguments.

string

code

Optional

Specific error code.

string

msg

Optional

Detailed error message.

string

stacktrace

Optional

Exception stacktrace.

500

The returned error codes include (but are not limited to): GeneralServerFailure

Returns ApiError of type(s) application/vnd.vmware.h4-v4.6+json;charset=UTF-8

{
    "args": [],
    "code": "Forbidden",
    "msg": "Permission denied.",
    "stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
}

array of string

args

Optional

Positional arguments.

string

code

Optional

Specific error code.

string

msg

Optional

Detailed error message.