Get Active Replication Image

Get Active Replication Image

There are two types of images: test-bubble and failover. A test-bubble image is expected to be reverted after any testing is completed. Optionally, it is possible to promote the image to a recovery image. A failover image will either be reverted or committed. Will return 404 Not Found in case there is no active replication image. Operation is available only on recovery site (for incoming replications).

Request
URI
GET
https://{api_host}/pairings/{pairing_id}/replications/{replication_id}/active-image
COPY
Path Parameters
string
pairing_id
Required

The ID of the pairing between this vSphere Replication server and the remote one.

string
replication_id
Required

The ID of a replication


Authentication
This operation uses the following authentication methods.
Responses
200

Information about a replication image.

Returns ReplicationImageDrResponseEntity of type(s) application/json
{
    "id": "string",
    "created_time": "string",
    "snapshots_for_pit_instances": false,
    "instance_id": "string",
    "committed": false,
    "vm_ids": [
        {}
    ],
    "test_bubble_image": false,
    "_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}/replications/{replication_id}/active-image