Developer Documentation
Get Stats Time Series
Released in v7.0.0.0Gather statistical values for a cluster, namespace, or pod.
Request
URLURL
https://{api_host}/api/vcenter/namespace-management/stats/time-series
Query Parameters
Query Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
TimeSeriesSpec | Specification of the statistical values that should be returned. |
Response
Response
Response BodyResponse Body
200 OK returns
array of
TimeSeriesTimeSeries
of type application/json
A list of TimeSeries values for each counter specified in the request.
{
"counter": "string",
"time_stamps": [
0
],
"values": [
0
]
}| Property Name | Type | Description |
|---|---|---|
| counter | string |
Counter identifier. |
| time_stamps | array of integer |
Sequence of UNIX timestamp values at which statistical values were sampled. https://en.wikipedia.org/wiki/Unix_time |
| values | array of integer |
Sequence of sampled values corresponding to the timestamps in tss. |
Errors
| Code | Returns | Description |
|---|---|---|
| 401 | Error | com.vmware.vapi.std.errors.unauthenticated : if the user can not be authenticated. | com.vmware.vapi.std.errors.unauthorized : if the user does not have System.Read privilege. |
| 404 | Error | com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request. | com.vmware.vapi.std.errors.not_found : if the specified cluster in TimeSeries.Spec.cluster or the namespace in TimeSeries.Spec.namespace or TimeSeries.Spec.pod does not exist. |
| 405 | Error | com.vmware.vapi.std.errors.unsupported : if the specified cluster in TimeSeries.Spec.cluster is not enabled for Namespaces. |
| default | Error | Not available |
| 400 | Error | com.vmware.vapi.std.errors.invalid_argument : if the start time in TimeSeries.Spec.start is invalid, or the end time in TimeSeries.Spec.end is invalid. |
