Replication Instance By Id

Replication Instance By Id

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

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

VM replication identifier

replicationId example 
H4-ec991bd5-af9d-446a-8599-5b693842c4a3
string
instanceId
Required

The instance ID.

instanceId example 
replica-528d9fb3-6107-f0f5-7610-63978a849ee5
Query Parameters
string
site
Optional

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

site example 
site1
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 ReplicationInstanceDetails of type(s) application/vnd.vmware.h4-v4.7+json;charset=UTF-8
This response body class contains all of the following: ReplicationInstance 
{
    "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
        }
    ]
}
array of DiskInstanceInfo
diskInstanceInfos
Optional

Information about each disk.


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