Query Data Points Data
Returns Data.DataPointsResult matching the filter parameters. /vstats/data/dp?types=VM&types=VCPU
/vstats/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
URLURL
https://{api_host}/api/stats/data/dp
Query Parameters
Query Parameters
string
cid
Optional
Counter ID. Warning: This attribute 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 unset the result will not be filtered by counter. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.vstats.model.Counter. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.vstats.model.Counter.
integer
end
Optional
End of a time window (excluded), timestamp in seconds UTC. Warning: This attribute 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 unset the result will not be limited by end time.
string
metric
Optional
Metric name. Warning: This attribute 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 unset the result will not be filtered by metric name. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.vstats.model.Metric. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.vstats.model.Metric.
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. Warning: This attribute 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 this parameter is unset 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 field in the result of Data.query-data-points operations. Warning: This attribute 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 unset the first page of results will be returned.
array of
string
resources
Optional
Resources to include in the query. Each resource is specified through a composite string that follows the following format.
type.
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 . Warning: This attribute 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 left unset the result will not be filtered for specific resources.
integer
start
Optional
Start of a time window (included), timestamp in seconds UTC. Warning: This attribute 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 unset the result will not be limited by start time.
array of
string
types
Optional
List of Resource types. Warning: This attribute 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 unset the result will not be filtered by resource types. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: com.vmware.vstats.model.RsrcType. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: com.vmware.vstats.model.RsrcType.
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
DataDataPointsResult
of type application/json
Data points matching the filter.
{
"data_points": [
{
"cid": "string",
"mid": "string",
"rid": "string",
"ts": 0,
"val": 0
}
],
"next": "string"
}
array of
DataDataPoint
data_points
Required
List of DataPoints received. Warning: This attribute 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.
string
next
Optional
The Data.DataPointsResult.next field is a token used to retrieve paged data for larger result sets. This is opaque token generated by the server. It is to be sent in the Data.FilterSpec.page field to issue a subsequent call to the query operation for retrieving results that did not fit the current page. Warning: This attribute 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. set when there are more results to retrieve.
Errors
400
com.vmware.vapi.std.errors.invalid_argument : if any of the specified parameters are invalid.
403
com.vmware.vapi.std.errors.unauthorized : if the user does not have sufficient privileges.
500
com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
Invoke-GetStatsData -Start 789 -End 789 -Cid "MyCid" -Metric "MyMetric" -Types "MyTypes" -Resources "MyResources" -Order "MyOrder" -Page "MyPage"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/stats/data/dp
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: query_data_points
