Gets the health metrics for a fleet of MySQL databases.
GET {{baseUrl}}/mysqlFleetMetrics?compartmentId=<string>&filterByMetricNames=<string>&startTime=<string>&endTime=<string>&filterByMySqlDeploymentTypeParam=ONPREMISE&filterByMdsDeploymentType=STANDALONE&filterByMySqlStatus=DOWN&filterByMySqlDatabaseVersion=<string>&isHeatWaveEnabled=<boolean>
Gets the health metrics for a fleet of MySQL Databases 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'". | |||
filterByMySqlDeploymentTypeParam | string | The parameter to filter by MySQL deployment type. | |
filterByMdsDeploymentType | string | The parameter to filter by MySQL Database System type. | |
filterByMySqlStatus | string | The parameter to filter by MySQL Database status. | |
filterByMySqlDatabaseVersion | string | The parameter to filter by MySQL database version. | |
isHeatWaveEnabled | string | The parameter to filter based on whether HeatWave is enabled for the database. |
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","fleetDatabases":[{"compartmentId":"\u003cstring\u003e","databaseName":"\u003cstring\u003e","databaseType":"\u003cstring\u003e","mdsDeploymentType":"\u003cstring\u003e","mdslifecycleState":"\u003cstring\u003e","databaseStatus":"UNKNOWN","databaseVersion":"\u003cstring\u003e","dbId":"\u003cstring\u003e","metrics":[{"metricValue":"\u003cinteger\u003e","dimensions":[{"dimensionName":"\u003cstring\u003e","dimensionValue":"\u003cstring\u003e"},{"dimensionName":"\u003cstring\u003e","dimensionValue":"\u003cstring\u003e"}],"metricName":"\u003cstring\u003e","timestamp":"\u003cdateTime\u003e","unit":"\u003cstring\u003e","metricValueDouble":"\u003cdouble\u003e"},{"metricValue":"\u003cinteger\u003e","dimensions":[{"dimensionName":"\u003cstring\u003e","dimensionValue":"\u003cstring\u003e"},{"dimensionName":"\u003cstring\u003e","dimensionValue":"\u003cstring\u003e"}],"metricName":"\u003cstring\u003e","timestamp":"\u003cdateTime\u003e","unit":"\u003cstring\u003e","metricValueDouble":"\u003cdouble\u003e"}],"heatWaveClusterDisplayName":"\u003cstring\u003e","heatWaveNodeCount":"\u003cinteger\u003e","isHeatWaveEnabled":"\u003cboolean\u003e"},{"compartmentId":"\u003cstring\u003e","databaseName":"\u003cstring\u003e","databaseType":"\u003cstring\u003e","mdsDeploymentType":"\u003cstring\u003e","mdslifecycleState":"\u003cstring\u003e","databaseStatus":"DOWN","databaseVersion":"\u003cstring\u003e","dbId":"\u003cstring\u003e","metrics":[{"metricValue":"\u003cinteger\u003e","dimensions":[{"dimensionName":"\u003cstring\u003e","dimensionValue":"\u003cstring\u003e"},{"dimensionName":"\u003cstring\u003e","dimensionValue":"\u003cstring\u003e"}],"metricName":"\u003cstring\u003e","timestamp":"\u003cdateTime\u003e","unit":"\u003cstring\u003e","metricValueDouble":"\u003cdouble\u003e"},{"metricValue":"\u003cinteger\u003e","dimensions":[{"dimensionName":"\u003cstring\u003e","dimensionValue":"\u003cstring\u003e"},{"dimensionName":"\u003cstring\u003e","dimensionValue":"\u003cstring\u003e"}],"metricName":"\u003cstring\u003e","timestamp":"\u003cdateTime\u003e","unit":"\u003cstring\u003e","metricValueDouble":"\u003cdouble\u003e"}],"heatWaveClusterDisplayName":"\u003cstring\u003e","heatWaveNodeCount":"\u003cinteger\u003e","isHeatWaveEnabled":"\u003cboolean\u003e"}],"fleetSummary":[{"aggregatedMetrics":[{"metricValue":"\u003cnumber\u003e","dimensions":[{"dimensionName":"\u003cstring\u003e","dimensionValue":"\u003cstring\u003e"},{"dimensionName":"\u003cstring\u003e","dimensionValue":"\u003cstring\u003e"}],"metricName":"\u003cstring\u003e","unit":"\u003cstring\u003e"},{"metricValue":"\u003cnumber\u003e","dimensions":[{"dimensionName":"\u003cstring\u003e","dimensionValue":"\u003cstring\u003e"},{"dimensionName":"\u003cstring\u003e","dimensionValue":"\u003cstring\u003e"}],"metricName":"\u003cstring\u003e","unit":"\u003cstring\u003e"}],"inventory":[{"databaseType":"\u003cstring\u003e","mdsDeploymentType":"\u003cstring\u003e","inventoryCount":"\u003cinteger\u003e"},{"databaseType":"\u003cstring\u003e","mdsDeploymentType":"\u003cstring\u003e","inventoryCount":"\u003cinteger\u003e"}]},{"aggregatedMetrics":[{"metricValue":"\u003cnumber\u003e","dimensions":[{"dimensionName":"\u003cstring\u003e","dimensionValue":"\u003cstring\u003e"},{"dimensionName":"\u003cstring\u003e","dimensionValue":"\u003cstring\u003e"}],"metricName":"\u003cstring\u003e","unit":"\u003cstring\u003e"},{"metricValue":"\u003cnumber\u003e","dimensions":[{"dimensionName":"\u003cstring\u003e","dimensionValue":"\u003cstring\u003e"},{"dimensionName":"\u003cstring\u003e","dimensionValue":"\u003cstring\u003e"}],"metricName":"\u003cstring\u003e","unit":"\u003cstring\u003e"}],"inventory":[{"databaseType":"\u003cstring\u003e","mdsDeploymentType":"\u003cstring\u003e","inventoryCount":"\u003cinteger\u003e"},{"databaseType":"\u003cstring\u003e","mdsDeploymentType":"\u003cstring\u003e","inventoryCount":"\u003cinteger\u003e"}]}]}