Get Stats Time Series
Gather statistical values for a cluster, namespace, or pod.
Request
URLURL
https://{api_host}/api/vcenter/namespace-management/stats/time-series
Query Parameters
Query Parameters
string
cluster
Optional
Cluster identifier for queries for a cluster. This field is optional and it is only relevant when the value of TimeSeries.Spec.obj-type is CLUSTER. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: ClusterComputeResource. When operations return a value of this structure as a result, the field will be an identifier for the resource type: ClusterComputeResource.
integer
end
Required
UNIX timestamp value indicating when the requested series of statistical samples should end. https://en.wikipedia.org/wiki/Unix_time
string
namespace
Optional
Namespace name for queries for a namespace. This field is optional and it is only relevant when the value of TimeSeries.Spec.obj-type is NAMESPACE. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.vcenter.namespaces.Instance. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.vcenter.namespaces.Instance.
obj_type
Required
Type of statistics object that the request is operating on.
pod
Optional
Pod Identifier for queries on an individual pod. This field is optional and it is only relevant when the value of TimeSeries.Spec.obj-type is POD.
integer
start
Required
UNIX timestamp value indicating when the requested series of statistical samples should begin. https://en.wikipedia.org/wiki/Unix_time
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
array of
NamespaceManagementStatsTimeSeriesTimeSeries of type application/json
A list of TimeSeries values for each counter specified in the request.
[
{
"counter": "string",
"time_stamps": [
0
],
"values": [
0
]
}
]
string
counter
Required
Counter identifier.
array of
integer
time_stamps
Required
Sequence of UNIX timestamp values at which statistical values were sampled. https://en.wikipedia.org/wiki/Unix_time
array of
integer
values
Required
Sequence of sampled values corresponding to the timestamps in tss.
Code Samples
PowerCLI Client SDK Example
$NamespaceManagementStatsTimeSeriesPodIdentifier = Initialize-NamespaceManagementStatsTimeSeriesPodIdentifier -Namespace "MyNamespace" -PodName "MyPodName"
Invoke-GetNamespaceManagementStatsTimeSeries -ObjType "CLUSTER" -Start 789 -End 789 -Pod $Pod -Namespace "MyNamespace" -Cluster "MyCluster"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/namespace-management/stats/time-series?end=10&obj_type=string&start=10
Errors
400
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. | com.vmware.vapi.std.errors.unsupported : if the specified cluster in TimeSeries.Spec.cluster is not enabled for Namespaces.
403
com.vmware.vapi.std.errors.unauthorized : if the user does not have System.Read privilege.
404
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.
500
com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request.
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: get
Availability
Added in 7.0.0.0
