Get Restore Status Report

Get currently running or last Restore job status

Request

URI

GET

https://vrni.example.com/api/ni/settings/restore/status

COPY

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Responses

200

Returns BackupRestoreStatusResponse of type(s) application/json

{
    "status": "IN_PROGRESS",
    "backup_file_name": "vrni_backup-10000-2020-12-15-13-00-40.tar",
    "status_updated_timestamp": "vrni_backup-10000-2020-12-15-13-00-40.tar",
    "failed_components": [
        "string"
    ],
    "failed_components_entities": [
        {
            "componentName": "DATA_SOURCES",
            "failedEntities": [
                {
                    "nickName": "SiteT_24_Openshift-VC",
                    "errorCode": "Unknown host",
                    "entityAttributes": [
                        {
                            "key": "Data Source Type",
                            "value": "VCENTER"
                        }
                    ]
                }
            ]
        }
    ]
}

string

status

Optional

Status of currently executing or last backup-restore job

string

backup_file_name

Optional

File name of backup tar file

string

status_updated_timestamp

Optional

TimeStamp of the last status update

array of string

failed_components

Optional

List of components failed to backup or restore

array of FailedComponentEntity

failed_components_entities

Optional

List of entities in a component which failed to restore

400

Bad Request

Returns ApiError of type(s) application/json

{
    "code": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}

integer As int32 As int32

code

Optional

code

string

message

Optional

message

array of ErrorDetail

details

Optional

details

401

Unauthorized

Returns ApiError of type(s) application/json

{
    "code": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}

integer As int32 As int32

code

Optional

code

string

message

Optional

message

array of ErrorDetail

details

Optional

details

404

Not Found

Returns ApiError of type(s) application/json

{
    "code": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}

integer As int32 As int32

code

Optional

code

string

message

Optional

message

array of ErrorDetail

details

Optional

details