Get Recovery Plan Steps | VMware Cloud Director Availability API

Get Recovery Plan Steps

This request returns the specified plan steps.

Request

URI

GET

https://{api_host}//recovery-plans/{recoveryPlanId}/steps

COPY

Path Parameters

string

recoveryPlanId

Required

recoveryPlanId

recoveryPlanId example

e7bf7128-2825-48ca-9075-3f496de70ffe

Query Parameters

integer

limit

Optional

limit

limit example

integer

offset

Optional

offset

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 QueryResult_of_RecoveryStepInfo of type(s) application/json;charset=UTF-8

{
    "items": [
        {
            "delay": 30000,
            "id": "57aefff3-9fd0-4185-ae75-2cce62de43df",
            "isRecovered": false,
            "name": "Step 1",
            "prompt": "Prompt message",
            "recoveryPlanId": "536ece79-1f49-4d6d-b558-41fde41c7c72",
            "replications": [],
            "sequence": 0,
            "state": "string"
        }
    ],
    "limit": 100,
    "offset": 0,
    "total": 3
}

array of RecoveryStepInfo

items

Optional

A list of items.

integer As int32 As int32

limit

Optional

Maximum number of items that this query could retrieve.

integer As int32 As int32

offset

Optional

How much items were skipped, before retrieving the actual items.

integer As int64 As int64

total

Optional

The total number of items.

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.