Instance Vm Replication

Instance Vm Replication

This request returns the details for the specified instance of the specified VM replication.

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

instanceId

string
replicationId
Required

The VM Replication unique identifier

replicationId example 
C4-09b2917c-bbe9-4693-ae3f-95b43a94b244
Query Parameters
string
site
Optional

site

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 C4ReplicationInstanceDetails of type(s) application/json;charset=UTF-8 
{
    "disksInfo": [
        {
            "diskKey": 2000
        }
    ],
    "isPinned": false,
    "key": "replica-52f3e775-a8fa-13e3-e9be-39264ed2dfe2",
    "quiescedType": "fileSystemQuiesced",
    "sequenceNumber": 11,
    "timestamp": 1469701818743,
    "transferBytes": 512000,
    "transferSeconds": 4
}
array of C4DiskInstanceInfo
disksInfo
Optional

An array of disks included in the instance.

boolean
isPinned
Optional

isPinned

string
key
Optional

PIT instance identifier. Should be used when failing over.

string
quiescedType
Optional

Type of quiescing.

Possible values are : none, applicationQuiesced, fileSystemQuiesced,
integer As int64 As int64
sequenceNumber
Optional

Counter, which represents the sequential number of this instance

integer As int64 As int64
timestamp
Optional

When was this instance created.

integer As int64 As int64
transferBytes
Optional

Total bytes in this instance (transferred during the delta and, for VMs running on MN.next+hosts, any preceding full sync). For VMs replicating from older (MN) hosts, this does not include the bytes for any full sync, just the delta.

integer As int64 As int64
transferSeconds
Optional

Total time in seconds it took to transfer this instance(for VMs running on MN.next+ hosts, this includes any preceeding full sync).


401

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

  • NotAuthenticated
  • RemoteAuthenticationFailure
Returns ApiError of type(s) application/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.


404

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

  • VmReplicationNotFound
  • SiteNotFound
Returns ApiError of type(s) application/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/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
Vm Replications Operations
POST
Apply Storage Profile Vm Replication
PATCH
Chown Vm Replication
DELETE
Cleanup Failover Test Vm Replication
GET
Disk Samples Vm Replication
POST
Failover Test Vm Replication
POST
Failover Vm Replication
GET
Get Network Settings Vm Replication
GET
Get Virtual Hardware
GET
Get Vm Replication
GET
Instance Vm Replication
GET
Instances Vm Replication
POST
Migrate Vm Replication
POST
Pause Vm Replication
PATCH
Reconfigure Disks Vm Replication
PATCH
Reconfigure Vm Replication
PUT
Replace Network Settings Vm Replication
POST
Resume Vm Replication
POST
Reverse Vm Replication
POST
Start Vm Replication
DELETE
Stop Vm Replication
POST
Sync Vm Replication
GET
Traffic Samples Vm Replication
PATCH
Update Network Settings Vm Replication
GET
Vm Replications