Disk Samples Vm Replication

Disk Samples Vm Replication

This request returns the historical replication disk usage statistics for the specified VM replication.

Request
URI
GET
https://{api_host}//vm-replications/{replicationId}/disk-usage
COPY
Path Parameters
string
replicationId
Required

The VM Replication unique identifier

replicationId example 
C4-09b2917c-bbe9-4693-ae3f-95b43a94b244
Query Parameters
string
end
Optional

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

end example 
1580897313933
string
interval
Optional

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

interval example 
HOUR
string
site
Optional

site

string
start
Optional

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

start example 
1479249799770
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 DataPoints of type(s) application/json;charset=UTF-8 
{
    "end": 1580897313933,
    "interval": "DAY",
    "label": "C4-09b2917c-bbe9-4693-ae3f-95b43a94b244",
    "samples": [
        {
            "bytes": 52236,
            "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'.

string
interval
Optional

The desired interval between the data points. Defaults to HOUR.

Possible values are : FIVE_MINUTES, HOUR, DAY,
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/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/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
Vm Replications Operations
POST
Apply Storage Profile Vm Replication
PATCH
Chown Vm Replication
DELETE
Cleanup Failover Test Vm Replication
GET
Disk Samples Vm Replication
POST
Failover Test Vm Replication
POST
Failover Vm Replication
GET
Get Network Settings Vm Replication
GET
Get Virtual Hardware
GET
Get Vm Replication
GET
Instance Vm Replication
GET
Instances Vm Replication
POST
Migrate Vm Replication
POST
Pause Vm Replication
PATCH
Reconfigure Disks Vm Replication
PATCH
Reconfigure Vm Replication
PUT
Replace Network Settings Vm Replication
POST
Resume Vm Replication
POST
Reverse Vm Replication
POST
Start Vm Replication
DELETE
Stop Vm Replication
POST
Sync Vm Replication
GET
Traffic Samples Vm Replication
PATCH
Update Network Settings Vm Replication
GET
Vm Replications