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
replicationId
Required

Cloud VM-level replication identifier

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

ID of the rotated instance

instanceId example
2bfb7696-3aa1-49d3-bb40-d9e97df1baba
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 C4ReplicationInstanceDetails of type(s) application/vnd.vmware.h4-v4.7+json;charset=UTF-8
This response body class contains all of the following: ReplicationInstance
{
    "isPinned": true,
    "key": "replica-52f3e775-a8fa-13e3-e9be-39264ed2dfe2",
    "quiescedType": "string",
    "sequenceNumber": 11,
    "timestamp": 1469701818743,
    "transferBytes": 512000,
    "transferSeconds": 4,
    "disksInfo": [
        {
            "diskKey": 2000
        }
    ]
}
disksInfo
Optional

An array of disks included in the instance.


401

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

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.


404

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

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.