POST /metrics_service/metrics
Use this method to collect missing metrics data that was collected during a specific range of time.
Note
This API requires Lenovo XClarity Administrator v3.0.0 or later.
Authentication
Authentication with username and password is required.
Request URL
POST https://{management_server_IP}/metrics_service/metrics
Query parameters
None
Request body
| Parameter | Required / Optional | Type | Description | ||
|---|---|---|---|---|---|
| deviceIDType | Required | String | Type of ID to identify the device. This can be one of the following values.
| ||
| deviceIDValue | Required | String | Device identifier, based on the specified deviceIDType
| ||
| interval | Required | Integer | Interval, in minutes | ||
| measurementName | Required | String | Metric name For servers, this can be one of the following values.
For storage devices, this can be the following value.
| ||
| startTimeStamp | Required | String | Timestamp when you want the metrics data to start This timestamp is specified using ISO-8601 format (for example, 2019-05-02T19:28:14.000Z). For information about ISO-8601 format, see the W3C Date and Time Formats webpage. | ||
The following example pushes processor-temperature data that was collected every hour starting at 5AM on July 1, 2020 for the specified ThinkSystem server.
{
"deviceIDType": "uuid",
"deviceIDValue": "21441745444D45C6BB648548EEFCFCD0",
"interval": 60,
"measurementName": "CPUTemp",
"startTimeStamp": "2020-07-01T05:00:00Z"
}
The following example pushes disk-usage data that was collected every two hours starting at 5AM on July 1, 2020 for the specified ThinkSystem storage device.
{
"deviceIDType": "serialNumber",
"deviceIDValue": "LSSN5679",
"interval": 120,
"measurementName": "DiskUtilization",
"startTimeStamp": "2020-07-01T05:00:00Z"
}
Response codes
| Code | Description | Comments |
|---|---|---|
| 200 | OK | The request completed successfully. |
| 404 | Not found | A specified resource cannot be found. A descriptive error message is returned in the response body. |
| 500 | Internal Server Error | An internal error occurred. A descriptive error message is returned in the response body. |
Response body
| Parameters | Type | Description | ||
|---|---|---|---|---|
| measurementName | String | Metric name | ||
| columns | Array of arrays of strings | Column headings | ||
| values | Array of arrays of strings | Column values | ||
The following example is returned if the request is successful.
{
"measurementName": "CPUTemp",
"columns": [
"time",
"ID",
"managerUUID",
"slot",
"uuid",
"value"
],
"values": [[
"2020-07-29T05:00:00Z",
"3881",
"85375E48DCD944D7948824935892CA4E",
"1",
"21441745444D45C6BB648548EEFCFCD0",
-1
],
...,
[
"2020-07-29T05:09:00Z",
"3885",
"85375E48DCD944D7948824935892CA4E",
"1",
"21441745444D45C6BB648548EEFCFCD0",
-1
]]
}
Give documentation feedback