start
The earliest time to query for time-series data. The date and time in must be in the format
yyyy-mm-dd+hh:mm
. If you specify an
end
but do not specify a
start
, the value used for
start
is the time of the oldest instance of the metric that is within the configured age-out
time.
end
The most recent time to query for time-series data. The date and time in must be in the format
yyyy-mm-dd+hh:mm
. If you specify a
start
but do not specify an
end
, the value used for
end
is the time you enter the command.
interval
The interval each returned data point is to represent. This parameter is required if you specify
the
start
or the
end
parameter. The interval you specify must be equal to or greater than
the interval at which the metric’s time-series data is persisted. Choose one of the following
values: 1, 5, 15, 30, 60,
day
, and
all
, where the numeric values represent the number of
minutes,
day
represents a 24-hour period, and
all
represents the summarized values over
the lifetime of the metric data collection.
If you do not specify parameters, only the last persisted time-series value for the metric is returned.
Specifying an interval summarizes the data, and enables you to quickly look for anomalous data.
For example, instead of viewing 1440 discrete minute-by-minute values for a specific metric over
the course of a day, you can request that each returned value represent 60 minutes so that the
number of returned values is more manageable and can be more easily inspected.
Summarizing the returned data for a period typically results in larger values for the metrics
themselves and larger values for the milliseconds spanned. The computation of the values
returned over longer intervals depends upon the type of metric. For example, gauge values are
averaged over the data points encompassed in the summary, but counter values are summed
over the summary interval.
Command example
curl --noproxy 10.1.1.9 -X GET \
--header "X-Auth-Token:3d61f0d3e61349359e6dbd82ec02c113" --fail -ksSfL \
--url
"https://10.1.1.9:8443/sdn/v2.0/metrics/431b746e-e62e-4874-a801-b1438eaac635?start=2014-09-23+18:00&interval=5"
Command output
{
"metric_values":{
"uid":"431b746e-e62e-4874-a801-b1438eaac635",
"type":"GAUGE",
"datapoint_count":6,
"datapoints":[
{
"update_time":"Tue Sep 23 18:03:55 PDT 2014",
"milliseconds_span":300000,
"last":3.274097568E8
},
{
"update_time":"Tue Sep 23 18:08:55 PDT 2014",
"milliseconds_span":300000,
"last":3.133927072E8
},
{
"update_time":"Tue Sep 23 18:13:55 PDT 2014",
"milliseconds_span":300000,
"last":2.154562624E8
},
148
Metrics