Replication

Replication

The details for an individual vApp-level replication.

Request
URI
GET
https://localhost/vapp-replications/{replicationId}
COPY
Path Parameters
string
operationID
Optional

Operation ID for correlating logs across multiple services

string
replicationId
Required

The vApp Replication unique identifier

replicationId example 
C4VAPP-d38b426f-dbfa-4ab7-851d-a538c23bd268
Query Parameters
string
site
Optional

site

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns VappReplicationInfo of type(s) application/vnd.vmware.h4-v4+json;charset=UTF-8 
{
    "descriptor": {
        "description": "vapp description in vCD",
        "metadata": {},
        "name": "my vapp 1"
    },
    "destination": {
        "org": "org2",
        "recoveredVappId": "null",
        "site": "site2",
        "vdcId": "5ee9224f-305d-46f6-865f-b605e70acef8",
        "vdcName": "Virtual DC 2"
    },
    "id": "C4VAPP-ccbe771e-b685-46c7-8c7a-4ed36915d963",
    "isMigration": "boolean",
    "lastUpdated": "integer",
    "overallHealth": "GREEN",
    "owner": "org1@site2",
    "source": {
        "org": "org1",
        "site": "site1",
        "vappId": "d6977f40-4d90-46b2-a34e-5077e8648eda",
        "vdcId": "f61d60d2-698a-46dc-a266-88df27644956",
        "vdcName": "Virtual DC 1"
    },
    "vmReplications": [
        {
            "computerName": "null",
            "dataConnectionState": "SYNCING",
            "destinationState": {
                "currentRpoViolation": 25,
                "isMovingReplica": "boolean",
                "lastError": {
                    "args": [
                        "string"
                    ],
                    "code": "string",
                    "msg": "string",
                    "stacktrace": "string"
                },
                "latestInstance": {
                    "key": "replica-52f3e775-a8fa-13e3-e9be-39264ed2dfe2",
                    "quiescedType": "fileSystemQuiesced",
                    "sequenceNumber": 11,
                    "timestamp": 1469701818743,
                    "transferBytes": 512000,
                    "transferSeconds": 4
                },
                "recoveryInfo": {
                    "recoveryState": "NOT_STARTED",
                    "vAppId": "null",
                    "vcdVmId": "null"
                },
                "spaceRequirement": "integer",
                "state": "opened",
                "stateAge": "integer"
            },
            "id": "C4-11111111-af9d-446a-8599-5b693842c4a3",
            "isMigration": true,
            "isPaused": "boolean",
            "isReversed": "boolean",
            "lastUpdated": 618094800000,
            "metadata": {},
            "overallHealth": "GREEN",
            "settings": {
                "dataConnectionType": "ENCRYPTED_COMPRESSED",
                "description": "new description",
                "initialSyncTime": "integer",
                "quiesced": true,
                "retentionPolicy": {
                    "rules": [
                        {
                            "distance": 15,
                            "numberOfInstances": 3
                        }
                    ]
                },
                "rpo": 15
            },
            "sourceState": {
                "progress": {
                    "bytesToTransfer": 1000,
                    "bytesTransferred": 400,
                    "checksumComparedBytes": 1000,
                    "checksumTotalBytes": 1000,
                    "progress": 40
                },
                "state": "idle",
                "stateAge": "integer"
            },
            "startupInfo": {
                "order": "integer",
                "startAction": "powerOn",
                "startDelay": "integer",
                "stopAction": "powerOff",
                "stopDelay": "integer"
            },
            "storageProfile": "null",
            "vimLocation": {
                "datastore": "datastore",
                "datastoreMoref": "datastore-33",
                "vimServer": "vim server",
                "vimServerInstanceUuid": "b260ac0-eec6-4437-9184-54ee34a1e28d"
            },
            "vmDescription": "null",
            "vmId": "d1d9739f-9e3b-4c24-9cbb-3a9fdddaf47c",
            "vmName": "my vm 1"
        }
    ]
}
VappDescriptor
descriptor
Optional

descriptor

DestinationInfo
destination
Optional

destination

string
id
Optional

The vApp-level replication ID.

boolean
isMigration
Optional

True if the VM replication is a migration. Otherwise, it's a protection.

integer As int64 As int64
lastUpdated
Optional

StartTime of the latest task associated with this vApp replication.

string
overallHealth
Optional

Representation of the replication health suitable for UI purposes.

string
owner
Optional

The id of the user that owns the replication.

SourceInfo
source
Optional

source

array of VmReplicationInfo
vmReplications
Optional

A list of child VM-level replications.


401

Returned error codes include (but are not limited to):

  • NotAuthenticated
  • RemoteAuthenticationFailure
Returns ApiError of type(s) application/vnd.vmware.h4-v4+json;charset=UTF-8 
{
    "args": [
        "string"
    ],
    "code": "string",
    "msg": "string",
    "stacktrace": "string"
}
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

Returned error codes include (but are not limited to):

  • VAppReplicationNotFound
  • SiteNotFound
Returns ApiError of type(s) application/vnd.vmware.h4-v4+json;charset=UTF-8 
{
    "args": [
        "string"
    ],
    "code": "string",
    "msg": "string",
    "stacktrace": "string"
}
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

Returned error codes include (but are not limited to):

  • GeneralServerFailure
Returns ApiError of type(s) application/vnd.vmware.h4-v4+json;charset=UTF-8 
{
    "args": [
        "string"
    ],
    "code": "string",
    "msg": "string",
    "stacktrace": "string"
}
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
Vapp Replications Operations
POST
Apply Storage Profile
PATCH
Chown
DELETE
Cleanup Failover Test
POST
Failover
POST
Failover Test
GET
Get Network Settings
POST
Migrate
POST
Pause
PATCH
Reconfigure
GET
Replication
GET
Replications
POST
Resume
POST
Reverse
POST
Start
DELETE
Stop
POST
Sync
PATCH
Update Network Settings