Replication Instances

Replication Instances

This request returns a list of replication instances for the specified VM replication.

Request
URI
GET
https://{api_host}/replications/{replicationId}/instances
COPY
Path Parameters
string
replicationId
Required

VM replication identifier

replicationId example 
H4-ec991bd5-af9d-446a-8599-5b693842c4a3
Query Parameters
string
site
Optional

Optional site to run the operation on. When omitted, defaults to the local site.

site example 
site1
integer
limit
Optional

Query limit - maximum number of items this query should retrieve. If omitted or higher than the server's limits, defaults to 100.

limit example 
10
integer
offset
Optional

Query offset - how many items to skip, before retrieving the actual items. If omitted, defaults to 0.

offset example 
10
Header Parameters
string
operationID
Optional

Operation ID for correlating logs across multiple services

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns QueryResult_of_ReplicationInstanceDetails of type(s) application/vnd.vmware.h4-v4.7+json;charset=UTF-8 
{
    "items": [
        {
            "key": "replica-520b41f1-9899-776c-93bd-2c6f470508f5",
            "sequenceNumber": 8,
            "timestamp": 1674727638000,
            "transferBytes": 0,
            "transferSeconds": 10,
            "isPinned": false,
            "quiescedType": "none",
            "diskInstanceInfos": [
                {
                    "diskKey": 2000,
                    "vcId": "530e97d8-1dcf-4e70-b4a4-2f40b587a1ab",
                    "datastoreId": "datastore-12",
                    "datastoreUuid": "63c8a760-89d86402-6c4a-00505687d916",
                    "path": "v2v-replicas-vm-31-1674466955049/r001_SEtf.vmdk",
                    "isBaseDisk": true
                }
            ]
        }
    ],
    "limit": 100,
    "offset": 0,
    "total": 3
}
array of ReplicationInstanceDetails
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.7+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.7+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.


On This Page
Replications Operations
DELETE
Replication Clean Failover Test
POST
Replication Failover
POST
Replication Failover Test
GET
Replication Get
GET
Replication Get Placement
GET
Replication Get Recovery Settings
GET
Replication Get Replicated Disks
GET
Replication Instance By Id
GET
Replication Instances
POST
Replication Migrate
POST
Replication Pause
GET
Replication Query Replications
PATCH
Replication Reconfigure
PATCH
Replication Reconfigure Disks
POST
Replication Resume
POST
Replication Reverse
POST
Replication Start
DELETE
Replication Stop
POST
Replication Stop Offline Sync
POST
Replication Sync
PUT
Replication Update Recovery Settings
GET
Replication Virtual Hardware