Replication Pause

Replication Pause

This request pauses the specified replication for the replicated VM.

The result of this API call is a task which must be polled by using the respective APIs for task polling. If the task succeeds, then the result can be obtained from the result field. If the task fails, there is no result. The failure reason is in the error field.

Request
URI
POST
https://{api_host}/replications/{replicationId}/pause
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
Header Parameters
string
operationID
Optional

Operation ID for correlating logs across multiple services

Authentication
This operation uses the following authentication methods.
Responses
202

Accepted

Returns H4ApiTask_of_ReplicationInfo of type(s) application/json;charset=UTF-8 
{
    "endTime": 1499929558827,
    "error": {
        "args": [],
        "code": "Forbidden",
        "msg": "Permission denied.",
        "stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
    },
    "id": "f61d60d2-698a-46dc-a266-88df27644956",
    "lastUpdated": 1499929558827,
    "progress": 100,
    "result": {
        "id": "H4-2bfb7696-3aa1-49d3-bb40-d9e97df1baba",
        "vmName": "My-protected-vm",
        "settings": {
            "vcId": "52ce9bc4-2563-448d-b8af-9047a03ce5c2",
            "vmId": "vm-15",
            "description": "replication description",
            "externalKey": null,
            "excludedDiskKeys": [],
            "rpo": 15,
            "dataConnectionType": "ENCRYPTED",
            "quiesced": true,
            "sourceLocation": {
                "site": "site1",
                "replicatorId": "9664de13-6150-4315-9f59-2d85eb4c302f"
            },
            "destinationLocation": {
                "site": "site2",
                "replicatorId": "107102e0-e03b-404e-8e17-0688c657a74b"
            },
            "replicationPlacement": {
                "datastoreId": "ds:uu:id",
                "datastoreFolder": "fol/der",
                "vcId": "vc:uu:id",
                "disks": [
                    {
                        "diskKey": 2000,
                        "datastoreId": "ds:uu:id",
                        "diskPath": "disk/path",
                        "isSeed": false,
                        "storageProfileId": "86dae29f-d727-4a1c-9571-a03bdf74b923",
                        "contentId": "95d35bba-ca6e-451b-ad52-5d83c75ef5a7"
                    }
                ],
                "validateSeedUuids": true,
                "storageProfileId": "86dae29f-d727-4a1c-9571-a03bdf74b923"
            },
            "retentionPolicy": {
                "rules": [
                    {
                        "numberOfInstances": 3,
                        "distance": 60
                    }
                ]
            },
            "autopinInstances": false,
            "targetDiskType": "THIN",
            "archiveSettings": null,
            "startPaused": false,
            "initialSyncTime": 0,
            "isMigration": false,
            "isReversed": false
        },
        "owner": "owner-1",
        "destinationState": {
            "currentRpoViolation": 25,
            "latestInstance": {
                "key": "replica-52f3e775-a8fa-13e3-e9be-39264ed2dfe2",
                "sequenceNumber": 11,
                "timestamp": 1469701818743,
                "transferBytes": 512000,
                "transferSeconds": 4,
                "quiescedType": "fileSystemQuiesced",
                "isPinned": false
            },
            "state": "opened",
            "recoveryInfo": {
                "recoveryState": "NOT_STARTED",
                "vcId": "5352b37c-ebf2-4d20-8733-1ccc54ff58d3",
                "vmId": "vm-1",
                "vmName": "myvm",
                "optimizeUntil": 1
            },
            "lastError": {
                "code": "Forbidden",
                "msg": "Permission denied.",
                "args": [],
                "stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
            },
            "stateAge": 0,
            "replicatedDisks": [],
            "spaceRequirement": 0,
            "isMovingReplica": false
        },
        "sourceState": {
            "state": "syncing",
            "progress": {
                "progress": 40,
                "bytesTransferred": 400,
                "bytesToTransfer": 1000,
                "checksumTotalBytes": 1000,
                "checksumComparedBytes": 1000
            },
            "stateAge": 0
        },
        "isPaused": false,
        "lastUpdated": 618094800000,
        "dataConnectionState": "SYNCING",
        "overallHealth": "GREEN",
        "sourceVmEncrypted": false
    },
    "resultType": "string",
    "site": "site2",
    "startTime": 1499929548951,
    "state": "string",
    "user": "root",
    "warnings": [],
    "workflowInfo": {}
}
integer As int64 As int64
endTime
Optional

Timestamp in msec of the completion time of the task. -1 indicates that the task did not complete yet.

ApiError
error
Optional

error

string As uuid As uuid
id
Optional

The unique identifier of the long-running task. It is unique and can be used for monitoring.

integer As int64 As int64
lastUpdated
Optional

Timestamp in msec of the last task status update.

integer As int32 As int32
progress
Optional

Percentage-based progress of the task.

ReplicationInfo
result
Optional

result

string
resultType
Optional

Indicates the type of the task result. Populates only when the execution succeeds.

string
site
Optional

Site on which the task runs.

integer As int64 As int64
startTime
Optional

Timestamp in msec of the creation time of the task.

Task_State
state
Optional

state

string
user
Optional

The user who started the task.

array of ResultWarning
warnings
Optional

Warnings, which occurred during the task execution.

ApiWorkflowInfo
workflowInfo
Optional

workflowInfo


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