Gets the health metrics for a fleet of HeatWave clusters.
GET {{baseUrl}}/heatWaveFleetMetrics?compartmentId=<string>&filterByMetricNames=<string>&startTime=<string>&endTime=<string>&filterByHeatWaveStatus=DOWN&filterByHeatWaveShape=<string>&isHeatWaveLakehouseEnabled=<boolean>
Gets the health metrics for a fleet of HeatWave clusters in a compartment.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
compartmentId | string | (Required) The OCID of the compartment. | |
filterByMetricNames | string | The filter used to retrieve a specific set of metrics by passing the desired metric names with a comma separator. Note that, by default, the service returns all supported metrics. | |
startTime | string | (Required) The start time of the time range to retrieve the health metrics of a Managed Database | |
| in UTC in ISO-8601 format, which is "yyyy-MM-dd'T'hh:mm:ss.sss'Z'". | |||
endTime | string | (Required) The end time of the time range to retrieve the health metrics of a Managed Database | |
| in UTC in ISO-8601 format, which is "yyyy-MM-dd'T'hh:mm:ss.sss'Z'". | |||
filterByHeatWaveStatus | string | The parameter to filter by HeatWave cluster status. | |
filterByHeatWaveShape | string | The parameter to filter by HeatWave node shape. | |
isHeatWaveLakehouseEnabled | string | The parameter to filter based on whether HeatWave Lakehouse is enabled for the cluster. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
opc-request-id | string | The client request ID for tracing. | |
Accept | string |
RESPONSES
status: OK
{"startTime":"\u003cstring\u003e","endTime":"\u003cstring\u003e","fleetClusters":[{"status":"UP","dbSystemId":"\u003cstring\u003e","dbSystemName":"\u003cstring\u003e","heatWaveClusterDisplayName":"\u003cstring\u003e","nodeCount":"\u003cinteger\u003e","isLakehouseEnabled":"\u003cboolean\u003e","heatWaveNodeShape":"\u003cstring\u003e","memorySize":"\u003cinteger\u003e","metrics":[{"metricValue":"\u003cdouble\u003e","dimensions":[{"dimensionName":"\u003cstring\u003e","dimensionValue":"\u003cstring\u003e"},{"dimensionName":"\u003cstring\u003e","dimensionValue":"\u003cstring\u003e"}],"metricName":"\u003cstring\u003e","timestamp":"\u003cdateTime\u003e","unit":"\u003cstring\u003e"},{"metricValue":"\u003cdouble\u003e","dimensions":[{"dimensionName":"\u003cstring\u003e","dimensionValue":"\u003cstring\u003e"},{"dimensionName":"\u003cstring\u003e","dimensionValue":"\u003cstring\u003e"}],"metricName":"\u003cstring\u003e","timestamp":"\u003cdateTime\u003e","unit":"\u003cstring\u003e"}]},{"status":"UNKNOWN","dbSystemId":"\u003cstring\u003e","dbSystemName":"\u003cstring\u003e","heatWaveClusterDisplayName":"\u003cstring\u003e","nodeCount":"\u003cinteger\u003e","isLakehouseEnabled":"\u003cboolean\u003e","heatWaveNodeShape":"\u003cstring\u003e","memorySize":"\u003cinteger\u003e","metrics":[{"metricValue":"\u003cdouble\u003e","dimensions":[{"dimensionName":"\u003cstring\u003e","dimensionValue":"\u003cstring\u003e"},{"dimensionName":"\u003cstring\u003e","dimensionValue":"\u003cstring\u003e"}],"metricName":"\u003cstring\u003e","timestamp":"\u003cdateTime\u003e","unit":"\u003cstring\u003e"},{"metricValue":"\u003cdouble\u003e","dimensions":[{"dimensionName":"\u003cstring\u003e","dimensionValue":"\u003cstring\u003e"},{"dimensionName":"\u003cstring\u003e","dimensionValue":"\u003cstring\u003e"}],"metricName":"\u003cstring\u003e","timestamp":"\u003cdateTime\u003e","unit":"\u003cstring\u003e"}]}],"fleetSummary":[{"aggregatedMetrics":[{"metricValue":"\u003cdouble\u003e","dimensions":[{"dimensionName":"\u003cstring\u003e","dimensionValue":"\u003cstring\u003e"},{"dimensionName":"\u003cstring\u003e","dimensionValue":"\u003cstring\u003e"}],"metricName":"\u003cstring\u003e","unit":"\u003cstring\u003e"},{"metricValue":"\u003cdouble\u003e","dimensions":[{"dimensionName":"\u003cstring\u003e","dimensionValue":"\u003cstring\u003e"},{"dimensionName":"\u003cstring\u003e","dimensionValue":"\u003cstring\u003e"}],"metricName":"\u003cstring\u003e","unit":"\u003cstring\u003e"}],"inventory":[{"name":"\u003cstring\u003e","value":"\u003cstring\u003e","count":"\u003cinteger\u003e"},{"name":"\u003cstring\u003e","value":"\u003cstring\u003e","count":"\u003cinteger\u003e"}]},{"aggregatedMetrics":[{"metricValue":"\u003cdouble\u003e","dimensions":[{"dimensionName":"\u003cstring\u003e","dimensionValue":"\u003cstring\u003e"},{"dimensionName":"\u003cstring\u003e","dimensionValue":"\u003cstring\u003e"}],"metricName":"\u003cstring\u003e","unit":"\u003cstring\u003e"},{"metricValue":"\u003cdouble\u003e","dimensions":[{"dimensionName":"\u003cstring\u003e","dimensionValue":"\u003cstring\u003e"},{"dimensionName":"\u003cstring\u003e","dimensionValue":"\u003cstring\u003e"}],"metricName":"\u003cstring\u003e","unit":"\u003cstring\u003e"}],"inventory":[{"name":"\u003cstring\u003e","value":"\u003cstring\u003e","count":"\u003cinteger\u003e"},{"name":"\u003cstring\u003e","value":"\u003cstring\u003e","count":"\u003cinteger\u003e"}]}]}