/clusters/{clusterName}/services/{serviceName}/activities/{activityId}/metrics
Mount Point: /api/v16/clusters/{clusterName}/services/{serviceName}/activities/{activityId}/metrics
GET
Fetch metric readings for a particular activity.
By default, this call will look up all metrics available for the activity. If only specific metrics are desired, use the metrics parameter.
By default, the returned results correspond to a 5 minute window based on the provided end time (which defaults to the current server time). The from and to parameters can be used to control the window being queried. A maximum window of 3 hours is enforced.
When requesting a "full" view, aside from the extended properties of the returned metric data, the collection will also contain information about all metrics available for the activity, even if no readings are available in the requested window.
Parameters
name | description | type | default |
---|---|---|---|
clusterName | The name of the cluster. | path | |
serviceName | The name of the service. | path | |
activityId | The name of the activity. | path | |
from | Start of the period to query. | query | |
to | End of the period to query. | query | now |
metrics | Filter for which metrics to query. | query | |
view | The view of the data to materialize, either "summary" or "full". | query | summary |
serviceName | (no documentation provided) | path | |
clusterName | (no documentation provided) | path |
Response Body
element: | metricList |
List of readings from the monitors.