Traffic Samples Vm Replication

This request returns the historical replication traffic statistics for the specified VM replication.

Request

URI

GET

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

COPY

Path Parameters

string

replicationId

Required

Cloud VM-level replication identifier

replicationId example

C4-ec991bd5-af9d-446a-8599-5b693842c4a3

Query Parameters

Interval

interval

Optional

The desired interval in seconds between the samples. Defaults to HOUR.

interval example

HOUR

integer

start

Optional

Timestamp in msec of the moment from which samples are retrieved. The default is 24 hours ago.

start example

1479249799770

integer

end

Optional

Timestamp in msec of the moment until samples are retrieved. The default is 'now'.

end example

1580897313933

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 DataPoints of type(s) application/vnd.vmware.h4-v4.6+json;charset=UTF-8

{
    "end": 1580897313933,
    "interval": "string",
    "label": "C4-09b2917c-bbe9-4693-ae3f-95b43a94b244",
    "samples": [
        {
            "bytes": "52236.0",
            "timestamp": 1563458400000
        }
    ],
    "start": 1479249799770
}

integer As int64 As int64

end

Optional

Timestamp in msec of the moment until samples are retrieved. Might differ from the timestamp requested by the user. The default is 'now'.

Interval

interval

Optional

interval

string

label

Optional

The object for which historic data is collected.

array of DataPoint

samples

Optional

The data points.

integer As int64 As int64

start

Optional

Timestamp in msec of the moment from which samples are retrieved. Might differ from the timestamp requested by the user. The default is 24 hours ago.

401

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

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