Vstats. Data Query Data Points

Returns Vstats.Data.DataPointsResult matching the filter parameters.

"/stats/data/dp?types=VM&types=VCPU"

"/stats/data/dp?rsrcs=type.HOST=host-16&rsrcs=type.VM=vm-31"

Warning: this operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Request

URI

GET

https://{api_host}/stats/data/dp

COPY

Query Parameters

integer

start

Optional

Start of a time window (included), timestamp in seconds UTC.

Warning: this property is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

When missing or null the result will not be limited by start time.

integer

end

Optional

End of a time window (excluded), timestamp in seconds UTC.

When missing or null the result will not be limited by end time.

string

cid

Optional

Counter ID.

When missing or null the result will not be filtered by counter.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.vstats.model.Counter. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.vstats.model.Counter.

string

metric

Optional

Metric name.

When missing or null the result will not be filtered by metric name.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.vstats.model.Metric. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.vstats.model.Metric.

string of array

types

Optional

List of Resource types.

When missing or null the result will not be filtered by resource types.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: com.vmware.vstats.model.RsrcType. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: com.vmware.vstats.model.RsrcType.

string of array

rsrcs

Optional

Resources to include in the query. Each resource is specified through a composite string that follows the following format.

type.<resource type>[.<scheme>]=<resource id>

resource type specifies the type of resource for example VM, VCPU etc.

scheme is an optional element to disambiguate the resource as needed for example to differentiate managed object id from uuid.

resource id is the unique resource identifier value for example: vm-41

Example values include: type.VM=vm-41, type.VCPU=1, type.VM.moid=vm-41

When left missing or null the result will not be filtered for specific resources.

string

order

Optional

Directs the server to order the returned data. Passing a value of DEFAULT will apply default ordering of the results that makes them easier for consumption.

When this parameter is missing or null the server will not order the result, save computational time and therefore the API will operate faster.

string

page

Optional

Used to retrieve paged data for larger result sets. The value of this token is generated by server and returned as next property in the result of query_data_points operations.

When missing or null the first page of results will be returned.

Authentication

This operation uses the following authentication methods.

basic_auth

api_key_auth

Responses

200

Data points matching the filter.

Returns Vstats.Data.DataPointsResult of type(s) application/json

"Vstats.Data.DataPointsResult Object"

400

if any of the specified parameters are invalid.

Returns Vapi.Std.Errors.InvalidArgument of type(s) application/json

"Vapi.Std.Errors.InvalidArgument Object"

401

if the user can not be authenticated.

Returns Vapi.Std.Errors.Unauthenticated of type(s) application/json

"Vapi.Std.Errors.Unauthenticated Object"

403

if the user does not have sufficient privileges.

Returns Vapi.Std.Errors.Unauthorized of type(s) application/json

"Vapi.Std.Errors.Unauthorized Object"

500

if the system reports an error while responding to the request.

Returns Vapi.Std.Errors.Error of type(s) application/json

"Vapi.Std.Errors.Error Object"

Code Samples

COPY

                    curl -H 'Authorization: <value>' https://{api_host}/stats/data/dp

On This Page

Description

Request

Query Parameters

Authentication

Response

200 Response Body

Errors

Vstats.data Operations

GET

Vstats. Data Query Data Points