vstats telemetry: get
Returns a view to metrics internal to the vStats service instance. 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:
HTTP request
GET https://{server}/api/stats/telemetry
?prefix={value}
&types={value-1}
&types={value-2}
?prefix={value}
&types={value-1}
&types={value-2}
Query Parameters:
| Name | Type | Description |
|---|---|---|
| bold = required | ||
| prefix | string | To query telemetry by name prefix. 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. Optional. When unset all telemetry data is returned. When set, returns the data where telemetry name starts with the prefix. |
| types | string[] | Specifies metric types to return. 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. Optional. When unset data for all telemetry metric types will be returned. |
Response:
HTTP Status Code: 200
Response Body Structure:
{
"timers" : [
{
"mean_rate" : 1.5,
"min15_rate" : 1.5,
"max" : 1.5,
"count" : 1,
"p95" : 1.5,
"p75" : 1.5,
"min5_rate" : 1.5,
"p99" : 1.5,
"min" : 1.5,
"median" : 1.5,
"mean" : 1.5,
"name" : "string",
"min1_rate" : 1.5,
"p999" : 1.5,
"stddev" : 1.5
},
{
"mean_rate" : 1.5,
"min15_rate" : 1.5,
"max" : 1.5,
"count" : 1,
"p95" : 1.5,
"p75" : 1.5,
"min5_rate" : 1.5,
"p99" : 1.5,
"min" : 1.5,
"median" : 1.5,
"mean" : 1.5,
"name" : "string",
"min1_rate" : 1.5,
"p999" : 1.5,
"stddev" : 1.5
}
],
"histograms" : [
{
"p99" : 1.5,
"min" : 1,
"median" : 1.5,
"max" : 1,
"mean" : 1.5,
"name" : "string",
"count" : 1,
"p999" : 1.5,
"stddev" : 1.5,
"p95" : 1.5,
"p75" : 1.5
},
{
"p99" : 1.5,
"min" : 1,
"median" : 1.5,
"max" : 1,
"mean" : 1.5,
"name" : "string",
"count" : 1,
"p999" : 1.5,
"stddev" : 1.5,
"p95" : 1.5,
"p75" : 1.5
}
],
"counters" : [
{
"name" : "string",
"count" : 1
},
{
"name" : "string",
"count" : 1
}
],
"gauges" : [
{
"name" : "string",
"value" : 1.5
},
{
"name" : "string",
"value" : 1.5
}
],
"meters" : [
{
"min5_rate" : 1.5,
"mean_rate" : 1.5,
"min15_rate" : 1.5,
"name" : "string",
"count" : 1,
"min1_rate" : 1.5
},
{
"min5_rate" : 1.5,
"mean_rate" : 1.5,
"min15_rate" : 1.5,
"name" : "string",
"count" : 1,
"min1_rate" : 1.5
}
]
}
"timers" : [
{
"mean_rate" : 1.5,
"min15_rate" : 1.5,
"max" : 1.5,
"count" : 1,
"p95" : 1.5,
"p75" : 1.5,
"min5_rate" : 1.5,
"p99" : 1.5,
"min" : 1.5,
"median" : 1.5,
"mean" : 1.5,
"name" : "string",
"min1_rate" : 1.5,
"p999" : 1.5,
"stddev" : 1.5
},
{
"mean_rate" : 1.5,
"min15_rate" : 1.5,
"max" : 1.5,
"count" : 1,
"p95" : 1.5,
"p75" : 1.5,
"min5_rate" : 1.5,
"p99" : 1.5,
"min" : 1.5,
"median" : 1.5,
"mean" : 1.5,
"name" : "string",
"min1_rate" : 1.5,
"p999" : 1.5,
"stddev" : 1.5
}
],
"histograms" : [
{
"p99" : 1.5,
"min" : 1,
"median" : 1.5,
"max" : 1,
"mean" : 1.5,
"name" : "string",
"count" : 1,
"p999" : 1.5,
"stddev" : 1.5,
"p95" : 1.5,
"p75" : 1.5
},
{
"p99" : 1.5,
"min" : 1,
"median" : 1.5,
"max" : 1,
"mean" : 1.5,
"name" : "string",
"count" : 1,
"p999" : 1.5,
"stddev" : 1.5,
"p95" : 1.5,
"p75" : 1.5
}
],
"counters" : [
{
"name" : "string",
"count" : 1
},
{
"name" : "string",
"count" : 1
}
],
"gauges" : [
{
"name" : "string",
"value" : 1.5
},
{
"name" : "string",
"value" : 1.5
}
],
"meters" : [
{
"min5_rate" : 1.5,
"mean_rate" : 1.5,
"min15_rate" : 1.5,
"name" : "string",
"count" : 1,
"min1_rate" : 1.5
},
{
"min5_rate" : 1.5,
"mean_rate" : 1.5,
"min15_rate" : 1.5,
"name" : "string",
"count" : 1,
"min1_rate" : 1.5
}
]
}
Headers:
NoneType:
| Name | Type | Description |
|---|---|---|
| bold = required | ||
| - | info | Telemetry data. |
| -.counters | telemetry_counter[] | List of TelemetryCounter. 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. |
| -.counters[].name | string | The name of this telemetry-counter. 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. |
| -.counters[].count | long | The current count of this telemetry-counter. 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. |
| -.timers | telemetry_timer[] | List of TelemetryTimer. 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. |
| -.timers[].name | string | The name of this telemetry-timer. 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. |
| -.timers[].count | long | Current count for this timer. 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. |
| -.timers[].min | double | Current mins value. 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. |
| -.timers[].max | double | Current max value. 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. |
| -.timers[].mean | double | Current mean value. 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. |
| -.timers[].stddev | double | Current standard deviation. 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. |
| -.timers[].median | double | Current median. 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. |
| -.timers[].p75 | double | Current 75th percentile. 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. |
| -.timers[].p95 | double | Current 95th percentile. 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. |
| -.timers[].p99 | double | Current 99th percentile. 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. |
| -.timers[].p999 | double | Current 99.9th percentile. 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. |
| -.timers[].min1_rate | double | 1-minute rate. 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. |
| -.timers[].min5_rate | double | 5-minute rate. 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. |
| -.timers[].min15_rate | double | 15-minute rate. 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. |
| -.timers[].mean_rate | double | Current mean rate. 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. |
| -.gauges | telemetry_gauge[] | List of TelemetryGauge. 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. |
| -.gauges[].name | string | The name of this telemetry-gauge. 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. |
| -.gauges[].value | double | The current value of this gauge. 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. |
| -.meters | telemetry_meter[] | List of TelemetryMeter. 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. |
| -.meters[].name | string | The name of this telemetry-meter. 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. |
| -.meters[].count | long | Current count for this meter. 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. |
| -.meters[].min1_rate | double | 1-minute rate. 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. |
| -.meters[].min5_rate | double | 5-minute rate. 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. |
| -.meters[].min15_rate | double | 15-minute rate. 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. |
| -.meters[].mean_rate | double | Current mean rate. 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. |
| -.histograms | telemetry_histogram[] | List of TelemetryHistogram. 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. |
| -.histograms[].name | string | The name of this telemetry-histogram. 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. |
| -.histograms[].count | long | Current count for this histogram. 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. |
| -.histograms[].min | long | Current min value. 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. |
| -.histograms[].max | long | Current max value. 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. |
| -.histograms[].mean | double | Current mean value. 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. |
| -.histograms[].stddev | double | Current standard deviation. 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. |
| -.histograms[].median | double | Median of all recorded samples. 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. |
| -.histograms[].p75 | double | 75th percentile of all recorded samples. 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. |
| -.histograms[].p95 | double | 95th percentile of all recorded samples. 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. |
| -.histograms[].p99 | double | 99th percentile of all recoeded samples. 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. |
| -.histograms[].p999 | double | 99.9th percentile of all recorded samples. 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. |
Errors:
| HTTP Status Code | Type | Description |
|---|---|---|
| 500 | error | if the system reports an error while responding to the request. |
| 404 | not_found | if prefix does not match any telemetry data. |
| 401 | unauthenticated | if the user can not be authenticated. |
| 403 | unauthorized | if the user does not have sufficient privileges. |