Get Vm Replication | VMware Cloud Director Availability API

Get Vm Replication

This request returns the details of the specified VM replication.

Request

URI

GET

https://{api_host}//vm-replications/{replicationId}

COPY

Path Parameters

string

replicationId

Required

Cloud VM-level replication identifier

replicationId example

C4-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

Header Parameters

string

operationID

Optional

Operation ID for correlating logs across multiple services

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Responses

200

Returns SingleVmReplicationInfo of type(s) application/vnd.vmware.h4-v4.5+json;charset=UTF-8

This response body class contains all of the following: VmReplicationInfo , InlineSingleVmReplicationInfo1

{
    "computerName": "computerName",
    "dataConnectionState": "string",
    "destinationState": {
        "currentRpoViolation": 25,
        "isMovingReplica": false,
        "lastError": {
            "args": [],
            "code": "Forbidden",
            "msg": "Permission denied.",
            "stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
        },
        "latestInstance": {
            "isPinned": false,
            "key": "replica-52f3e775-a8fa-13e3-e9be-39264ed2dfe2",
            "quiescedType": "string",
            "sequenceNumber": 11,
            "timestamp": 1469701818743,
            "transferBytes": 512000,
            "transferSeconds": 4
        },
        "spaceRequirement": 0,
        "state": "string",
        "stateAge": 0
    },
    "guestCustomization": {
        "adminAutoLogonCount": 3,
        "adminPassword": "sEcUrEpAsS",
        "adminPasswordAuto": true,
        "adminPasswordEnabled": true,
        "changeSid": true,
        "computerName": "workload-69",
        "customizationScript": "echo 'hello world'",
        "domainName": "workgroup",
        "domainOrgUnit": "computers",
        "domainUserName": "user1",
        "domainUserPassword": "sEcUrEpAsS",
        "enabled": true,
        "joinDomainEnabled": true,
        "resetPasswordRequired": true,
        "useOrgSettings": true
    },
    "id": "C4-11111111-af9d-446a-8599-5b693842c4a3",
    "isMigration": true,
    "isPaused": false,
    "isReversed": false,
    "lastUpdated": 618094800000,
    "metadata": {},
    "overallHealth": "string",
    "owner": "org1@site1",
    "placementPolicy": "ecde053f-1aed-4547-b73a-52b9f7c48298",
    "placementPolicyName": "Gold",
    "settings": {
        "dataConnectionType": "string",
        "description": "new description",
        "excludedDiskKeys": [
            0
        ],
        "initialSyncTime": 0,
        "quiesced": true,
        "retentionPolicy": {
            "rules": [
                {
                    "distance": 15,
                    "numberOfInstances": 3
                }
            ]
        },
        "rpo": 15,
        "targetDiskType": "string"
    },
    "sizingPolicy": "ecde053f-1aed-4547-b73a-52b9f7c48298",
    "sizingPolicyName": "SizingPolicy1",
    "slaProfile": {
        "displayName": "Gold",
        "id": "61c528c8-1a8c-4c4e-8886-f1b6eeba98a5"
    },
    "sourceState": {
        "stateAge": 0
    },
    "sourceVmEncrypted": false,
    "startupInfo": {
        "order": 0,
        "startAction": "powerOn",
        "startDelay": 0,
        "stopAction": "powerOff",
        "stopDelay": 0
    },
    "storageProfile": "ecde053f-1aed-4547-b73a-52b9f7c48298",
    "storageProfileName": "*",
    "vimLocation": {
        "datastore": "datastore",
        "datastoreMoref": "datastore-33",
        "datastoreName": "test datastore",
        "dsClusterMoref": "string",
        "dsClusterName": "string",
        "vimServer": "vim server",
        "vimServerInstanceUuid": "b260ac0-eec6-4437-9184-54ee34a1e28d"
    },
    "vmDescription": "description",
    "vmId": "d1d9739f-9e3b-4c24-9cbb-3a9fdddaf47c",
    "vmName": "my vm 1",
    "destination": {
        "org": "org2",
        "recoveredVappId": "null",
        "site": "site2",
        "vdcId": "5ee9224f-305d-46f6-865f-b605e70acef8",
        "vdcName": "Virtual DC 2"
    },
    "source": {
        "vappName": "vApp1"
    },
    "vappReplicationId": "C4VAPP-ccbe771e-b685-46c7-8c7a-4ed36915d963"
}

401

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

Returns ApiError of type(s) application/vnd.vmware.h4-v4.5+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): SiteNotFound

Returns ApiError of type(s) application/vnd.vmware.h4-v4.5+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.5+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.