Endpoint
/api/v2/metric/search
Query Parameters
tenantstring
ID of the client with which a metric is associated with.
rtypestring
resourcestring
ID of the resource on which a metric is assigned.
metricNamestring
(Optional) Name of the metric to report the metric details.
startTimestring
Search for the metric behavior within a specific time stamp with the start time (use the Unix Epoch Time Stamp format). Example: 1536643494
endTimestring
The end time used for the search (use the Unix Epoch Time Stamp format). Example: 1536643564
timeseries_typestring
(Optional) Metric behavior at a specific time series pattern. Supported values are: - "RealTime": Provides details of metric behavior at current time stamp. - "CHANGE_DETECTION": Provides details of significant changes on a metric. - "FORECAST": Provides forecast details of a metric
metricGroupstring
(Optional) ID of a metric group to which a metric belongs.
resourceGroupstring
(Optional) ID of resource group the metric is applied. Use Get Minimal Details of Device Groups API to get list of resource groups.
componentstring
(Optional) Device component name that the metric is assigned.
Responses
OK
[
{
"component": "system.cpu.utilization",
"consolFunc": "AVERAGE",
"data": {
"1536643511": -88,
"1536643571": -84,
"1536643631": -63,
"1536643691": -14,
"1536643751": -88,
"1536643811": -59,
"1536643871": -90,
"1536643931": -97,
"1536643991": -6,
"1536644051": -90,
"1536644111": -15,
"1536644171": -11,
"1536644231": -94,
"1536644291": -66,
"1536644351": -96,
"1536644411": -15,
"1536644471": -12,
"1536644531": -63,
"1536644591": -41,
"1536644651": -23,
"1536644711": -66,
"1536644771": -24,
"1536644831": -31,
"1536644891": -71,
"1536644951": -17,
"1536645011": -36,
"1536645071": -28,
"1536645131": -33,
"1536645191": -72,
"1536645251": -35
},
"description": "The percentage of elapsed time that the processor spends to execute a non-Idle thread",
"factor": 1,
"metric": "system.cpu.utilization",
"metricType": "Guage",
"resource": 12327,
"timeSeriesType": "CHANGE_DETECTION",
"unit": "%",
"unitLabel": "Percentage (%)"
},
{
"component": "resource.availability",
"consolFunc": "AVERAGE",
"description": "The percentage of elapsed time that the processor spends to execute a non-Idle thread",
"factor": 1,
"metric": "system.cpu.utilization",
"metricType": "Guage",
"resource": 12327,
"timeSeriesType": "CHANGE_DETECTION",
"unit": "%",
"unitLabel": "Percentage (%)"
}
]
[
{
"component": "system.cpu.utilization",
"consolFunc": "AVERAGE",
"data": {
"1536643511": 25,
"1536643571": 65,
"1536643631": 63,
"1536643691": 72,
"1536643751": 91,
"1536643811": 21,
"1536643871": 77,
"1536643931": 54,
"1536643991": 50,
"1536644051": 42,
"1536644111": 77,
"1536644171": 53,
"1536644231": 47,
"1536644291": 26,
"1536644351": 58,
"1536644411": 84,
"1536644471": 26,
"1536644531": 97,
"1536644591": 66,
"1536644651": 88,
"1536644711": 68,
"1536644771": 67
},
"description": "The percentage of elapsed time that the processor spends to execute a non-Idle thread",
"factor": 1,
"metric": "system.cpu.utilization",
"metricType": "Guage",
"resource": 12327,
"timeSeriesType": "RealTime",
"unit": "%",
"unitLabel": "Percentage (%)"
}
]
[
{
"component": "system.cpu.utilization",
"consolFunc": "AVERAGE",
"data": {
"1536643511": 174,
"1536643571": 251,
"1536643631": 268,
"1536643691": 261,
"1536643751": 265,
"1536643811": 172,
"1536643871": 187,
"1536643931": 159,
"1536643991": 286,
"1536644051": 139,
"1536644111": 177,
"1536644171": 174,
"1536644231": 245,
"1536644291": 274,
"1536644351": 181,
"1536644411": 196,
"1536644471": 233,
"1536644531": 251,
"1536644591": 295,
"1536644651": 171,
"1536644711": 124,
"1536644771": 172,
"1536644831": 184,
"1536644891": 282,
"1536644951": 153,
"1536645011": 261,
"1536645071": 221
},
"description": "The percentage of elapsed time that the processor spends to execute a non-Idle thread",
"factor": 1,
"metric": "system.cpu.utilization",
"metricType": "Guage",
"resource": 12327,
"timeSeriesType": "FORECAST",
"unit": "%",
"unitLabel": "Percentage (%)"
},
{
"component": "resource.availability",
"consolFunc": "AVERAGE",
"description": "The percentage of elapsed time that the processor spends to execute a non-Idle thread",
"factor": 1,
"metric": "system.cpu.utilization",
"metricType": "Guage",
"resource": 12327,
"timeSeriesType": "FORECAST",
"unit": "%",
"unitLabel": "Percentage (%)"
}
]
[
{
"component": "system.cpu.utilization",
"consolFunc": "AVERAGE",
"data": {
"1536643511": 25,
"1536643571": 65,
"1536643631": 63,
"1536643691": 72,
"1536643751": 91,
"1536643811": 21,
"1536643871": 77,
"1536643931": 54,
"1536643991": 50,
"1536644051": 42
},
"description": "The percentage of elapsed time that the processor spends to execute a non-Idle thread",
"factor": 1,
"metric": "system.cpu.utilization",
"metricType": "Guage",
"resource": 12327,
"timeSeriesType": "RealTime",
"unit": "%",
"unitLabel": "Percentage (%)"
},
{
"component": "system.cpu.utilization",
"consolFunc": "AVERAGE",
"data": {
"1536643511": -88,
"1536643571": -84,
"1536643631": -63,
"1536643691": -14,
"1536643751": -88,
"1536643811": -59,
"1536643871": -90,
"1536643931": -97,
"1536643991": -6,
"1536644051": -90
},
"description": "The percentage of elapsed time that the processor spends to execute a non-Idle thread",
"factor": 1,
"metric": "system.cpu.utilization",
"metricType": "Guage",
"resource": 12327,
"timeSeriesType": "CHANGE_DETECTION",
"unit": "%",
"unitLabel": "Percentage (%)"
},
{
"component": "resource.availability",
"consolFunc": "AVERAGE",
"description": "The percentage of elapsed time that the processor spends to execute a non-Idle thread",
"factor": 1,
"metric": "system.cpu.utilization",
"metricType": "Guage",
"resource": 12327,
"timeSeriesType": "CHANGE_DETECTION",
"unit": "%",
"unitLabel": "Percentage (%)"
},
{
"component": "system.cpu.utilization",
"consolFunc": "AVERAGE",
"data": {
"1536643511": 174,
"1536643571": 251,
"1536643631": 268,
"1536643691": 261,
"1536643751": 265,
"1536643811": 172,
"1536643871": 187,
"1536643931": 159,
"1536643991": 286,
"1536644051": 139
},
"description": "The percentage of elapsed time that the processor spends to execute a non-Idle thread",
"factor": 1,
"metric": "system.cpu.utilization",
"metricType": "Guage",
"resource": 12327,
"timeSeriesType": "FORECAST",
"unit": "%",
"unitLabel": "Percentage (%)"
},
{
"component": "resource.availability",
"consolFunc": "AVERAGE",
"description": "The percentage of elapsed time that the processor spends to execute a non-Idle thread",
"factor": 1,
"metric": "system.cpu.utilization",
"metricType": "Guage",
"resource": 12327,
"timeSeriesType": "FORECAST",
"unit": "%",
"unitLabel": "Percentage (%)"
}
]
[
{
"component": "c",
"consolFunc": "AVERAGE",
"data": {
"1464332400": 93299147000,
"1464336000": 93299496333.33333,
"1464339600": 93296001000,
"1464343200": 93291894333.33333,
"1464346800": 93301768000,
"1464350400": 93296875083.33333,
"1464354000": 93301855333.33333,
"1464357600": 93307797583.33333,
"1464361200": 93306749000,
"1464364800": 93177424750,
"1464368400": 93089518833.33333,
"1464372000": 93087771500
},
"description": "Used space on the selected logical disk drive",
"factor": 1073741824,
"lastVals": {
"1464332400": 93299147000,
"1464336000": 93300195000,
"1464339600": 93291807000,
"1464343200": 93292855000,
"1464346800": 93296001000,
"1464350400": 93298098000,
"1464354000": 93305438000,
"1464357600": 93303341000,
"1464361200": 93308584000,
"1464364800": 93079994000,
"1464368400": 93112500000,
"1464372000": 93086286000
},
"maxVals": {
"1464332400": 93299147000,
"1464336000": 93300195000,
"1464339600": 93300195000,
"1464343200": 93292855000,
"1464346800": 93303341000,
"1464350400": 93298098000,
"1464354000": 93305438000,
"1464357600": 93311730000,
"1464361200": 93308584000,
"1464364800": 93314875000,
"1464368400": 93113549000,
"1464372000": 93091529000
},
"metric": "system.disk.used",
"metricType": "Guage",
"minVals": {
"1464332400": 93299147000,
"1464336000": 93299147000,
"1464339600": 93291807000,
"1464343200": 93291807000,
"1464346800": 93296001000,
"1464350400": 93296001000,
"1464354000": 93298098000,
"1464357600": 93303341000,
"1464361200": 93304390000,
"1464364800": 93078946000,
"1464368400": 93081043000,
"1464372000": 93084189000
},
"resource": 4455803,
"timeSeriesType": "CHANGE_DETECTION",
"unit": "GB",
"unitLabel": "Utilization"
},
{
"component": "e",
"consolFunc": "AVERAGE",
"data": {
"1464332400": 145243679333.33334,
"1464336000": 145233543000,
"1464339600": 145239922083.33334,
"1464343200": 145253204166.66666,
"1464346800": 145243067750,
"1464350400": 145254427083.33334,
"1464354000": 145250145750,
"1464357600": 145259932416.66666,
"1464361200": 145264475916.66666,
"1464364800": 145274699750,
"1464368400": 145357449916.66666,
"1464372000": 145342245666.66666
},
"description": "Used space on the selected logical disk drive",
"factor": 1073741824,
"lastVals": {
"1464332400": 145244553000,
"1464336000": 145231970000,
"1464339600": 145240359000,
"1464343200": 145256088000,
"1464346800": 145250845000,
"1464350400": 145256088000,
"1464354000": 145256088000,
"1464357600": 145239310000,
"1464361200": 145268670000,
"1464364800": 145344168000,
"1464368400": 145356751000,
"1464372000": 145341022000
},
"maxVals": {
"1464332400": 145245602000,
"1464336000": 145257136000,
"1464339600": 145240359000,
"1464343200": 145257136000,
"1464346800": 145251893000,
"1464350400": 145256088000,
"1464354000": 145257136000,
"1464357600": 145270768000,
"1464361200": 145269719000,
"1464364800": 145344168000,
"1464368400": 145363042000,
"1464372000": 145359897000
},
"metric": "system.disk.used",
"metricType": "Guage",
"minVals": {
"1464332400": 145242456000,
"1464336000": 145229873000,
"1464339600": 145236165000,
"1464343200": 145229873000,
"1464346800": 145234067000,
"1464350400": 145253990000,
"1464354000": 145241407000,
"1464357600": 145237213000,
"1464361200": 145257136000,
"1464364800": 145244553000,
"1464368400": 145346265000,
"1464372000": 145336828000
},
"resource": 4455803,
"timeSeriesType": "FORECAST",
"unit": "GB",
"unitLabel": "Utilization"
},
{
"component": "c",
"consolFunc": "AVERAGE",
"data": {
"1464332400": 93299147000,
"1464336000": 93299496333.33333,
"1464339600": 93296001000,
"1464343200": 93291894333.33333,
"1464346800": 93301768000,
"1464350400": 93296875083.33333,
"1464354000": 93301855333.33333,
"1464357600": 93307797583.33333,
"1464361200": 93306749000,
"1464364800": 93177424750,
"1464368400": 93089518833.33333,
"1464372000": 93087771500
},
"description": "Used space on the selected logical disk drive",
"factor": 1073741824,
"lastVals": {
"1464332400": 93299147000,
"1464336000": 93300195000,
"1464339600": 93291807000,
"1464343200": 93292855000,
"1464346800": 93296001000,
"1464350400": 93298098000,
"1464354000": 93305438000,
"1464357600": 93303341000,
"1464361200": 93308584000,
"1464364800": 93079994000,
"1464368400": 93112500000,
"1464372000": 93086286000
},
"maxVals": {
"1464332400": 93299147000,
"1464336000": 93300195000,
"1464339600": 93300195000,
"1464343200": 93292855000,
"1464346800": 93303341000,
"1464350400": 93298098000,
"1464354000": 93305438000,
"1464357600": 93311730000,
"1464361200": 93308584000,
"1464364800": 93314875000,
"1464368400": 93113549000,
"1464372000": 93091529000
},
"metric": "system.disk.used",
"metricType": "Guage",
"minVals": {
"1464332400": 93299147000,
"1464336000": 93299147000,
"1464339600": 93291807000,
"1464343200": 93291807000,
"1464346800": 93296001000,
"1464350400": 93296001000,
"1464354000": 93298098000,
"1464357600": 93303341000,
"1464361200": 93304390000,
"1464364800": 93078946000,
"1464368400": 93081043000,
"1464372000": 93084189000
},
"resource": 4455803,
"timeSeriesType": "RealTime",
"unit": "GB",
"unitLabel": "Utilization"
}
]