Gets the health metrics for a fleet of databases.
GET {{baseUrl}}/fleetMetrics?managedDatabaseGroupId=<string>&compartmentId=<string>&compareBaselineTime=<string>&compareTargetTime=<string>&compareType=DAY&filterByMetricNames=<string>&filterByDatabaseType=<string>&filterByDatabaseSubType=<string>&page=<string>&limit=10&sortBy=TIMECREATED&sortOrder=ASC&filterByDatabaseDeploymentType=<string>&filterByDatabaseVersion=<string>&definedTagEquals=<string>&definedTagEquals=<string>&freeformTagEquals=<string>&freeformTagEquals=<string>&definedTagExists=<string>&definedTagExists=<string>&freeformTagExists=<string>&freeformTagExists=<string>
Gets the health metrics for a fleet of databases in a compartment or in a Managed Database Group. Either the CompartmentId or the ManagedDatabaseGroupId query parameters must be provided to retrieve the health metrics.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
managedDatabaseGroupId | string | The OCID of the Managed Database Group. | |
compartmentId | string | The OCID of the compartment. | |
compareBaselineTime | string | (Required) The baseline time for metrics comparison. | |
compareTargetTime | string | (Required) The target time for metrics comparison. | |
compareType | string | The time window used for metrics comparison. | |
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. | |
filterByDatabaseType | string | The filter used to filter the databases in the fleet by a specific Oracle Database type. | |
filterByDatabaseSubType | string | The filter used to filter the databases in the fleet by a specific Oracle Database subtype. | |
page | string | The page token representing the page from where the next set of paginated results | |
| are retrieved. This is usually retrieved from a previous list call. | |||
limit | number | The maximum number of records returned in the paginated response. | |
sortBy | string | The field to sort information by. Only one sortOrder can be used. The default sort order | |
| for ‘TIMECREATED’ is descending and the default sort order for ‘NAME’ is ascending. | |||
| The ‘NAME’ sort order is case-sensitive. | |||
sortOrder | string | The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. | |
filterByDatabaseDeploymentType | string | The filter used to filter the databases in the fleet by a specific Oracle Database deployment type. | |
filterByDatabaseVersion | string | The filter used to filter the databases in the fleet by a specific Oracle Database version. | |
definedTagEquals | string | A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. | |
| Each item in the list has the format "{namespace}.{tagName}.{value}". All inputs are case-insensitive. | |||
| Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". | |||
| Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND". | |||
definedTagEquals | string | A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. | |
| Each item in the list has the format "{namespace}.{tagName}.{value}". All inputs are case-insensitive. | |||
| Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". | |||
| Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND". | |||
freeformTagEquals | string | A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. | |
| The key for each tag is "{tagName}.{value}". All inputs are case-insensitive. | |||
| Multiple values for the same tag name are interpreted as "OR". Values for different tag names are interpreted as "AND". | |||
freeformTagEquals | string | A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. | |
| The key for each tag is "{tagName}.{value}". All inputs are case-insensitive. | |||
| Multiple values for the same tag name are interpreted as "OR". Values for different tag names are interpreted as "AND". | |||
definedTagExists | string | A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. | |
| Each item in the list has the format "{namespace}.{tagName}.true" (for checking existence of a defined tag) | |||
| or "{namespace}.true". All inputs are case-insensitive. | |||
| Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. | |||
| Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". | |||
| Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND". | |||
definedTagExists | string | A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. | |
| Each item in the list has the format "{namespace}.{tagName}.true" (for checking existence of a defined tag) | |||
| or "{namespace}.true". All inputs are case-insensitive. | |||
| Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. | |||
| Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". | |||
| Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND". | |||
freeformTagExists | string | A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. | |
| The key for each tag is "{tagName}.true". All inputs are case-insensitive. | |||
| Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. | |||
| Multiple values for different tag names are interpreted as "AND". | |||
freeformTagExists | string | A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. | |
| The key for each tag is "{tagName}.true". All inputs are case-insensitive. | |||
| Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. | |||
| Multiple values for different tag names are interpreted as "AND". | |||
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
opc-request-id | string | The client request ID for tracing. | |
Accept | string |
RESPONSES
status: OK
{"compareBaselineTime":"\u003cstring\u003e","compareTargetTime":"\u003cstring\u003e","fleetDatabases":[{"compartmentId":"\u003cstring\u003e","databaseContainerId":"\u003cstring\u003e","databaseName":"\u003cstring\u003e","databaseSubType":"ADB","databaseType":"CLOUD_RAC","databaseVersion":"\u003cstring\u003e","dbId":"\u003cstring\u003e","deploymentType":"AUTONOMOUS","metrics":[{"baselineValue":"\u003cdouble\u003e","dimensions":[{"dimensionName":"\u003cstring\u003e","dimensionValue":"\u003cstring\u003e"},{"dimensionName":"\u003cstring\u003e","dimensionValue":"\u003cstring\u003e"}],"metricName":"\u003cstring\u003e","percentageChange":"\u003cdouble\u003e","targetValue":"\u003cdouble\u003e","timestamp":"\u003cdateTime\u003e","unit":"\u003cstring\u003e"},{"baselineValue":"\u003cdouble\u003e","dimensions":[{"dimensionName":"\u003cstring\u003e","dimensionValue":"\u003cstring\u003e"},{"dimensionName":"\u003cstring\u003e","dimensionValue":"\u003cstring\u003e"}],"metricName":"\u003cstring\u003e","percentageChange":"\u003cdouble\u003e","targetValue":"\u003cdouble\u003e","timestamp":"\u003cdateTime\u003e","unit":"\u003cstring\u003e"}],"workloadType":"APEX"},{"compartmentId":"\u003cstring\u003e","databaseContainerId":"\u003cstring\u003e","databaseName":"\u003cstring\u003e","databaseSubType":"NON_CDB","databaseType":"CLOUD_RAC","databaseVersion":"\u003cstring\u003e","dbId":"\u003cstring\u003e","deploymentType":"EXADATA_CC","metrics":[{"baselineValue":"\u003cdouble\u003e","dimensions":[{"dimensionName":"\u003cstring\u003e","dimensionValue":"\u003cstring\u003e"},{"dimensionName":"\u003cstring\u003e","dimensionValue":"\u003cstring\u003e"}],"metricName":"\u003cstring\u003e","percentageChange":"\u003cdouble\u003e","targetValue":"\u003cdouble\u003e","timestamp":"\u003cdateTime\u003e","unit":"\u003cstring\u003e"},{"baselineValue":"\u003cdouble\u003e","dimensions":[{"dimensionName":"\u003cstring\u003e","dimensionValue":"\u003cstring\u003e"},{"dimensionName":"\u003cstring\u003e","dimensionValue":"\u003cstring\u003e"}],"metricName":"\u003cstring\u003e","percentageChange":"\u003cdouble\u003e","targetValue":"\u003cdouble\u003e","timestamp":"\u003cdateTime\u003e","unit":"\u003cstring\u003e"}],"workloadType":"APEX"}],"compareType":"DAY","fleetSummary":{"aggregatedMetrics":[{"baselineValue":"\u003cdouble\u003e","dimensions":[{"dimensionName":"\u003cstring\u003e","dimensionValue":"\u003cstring\u003e"},{"dimensionName":"\u003cstring\u003e","dimensionValue":"\u003cstring\u003e"}],"metricName":"\u003cstring\u003e","percentageChange":"\u003cdouble\u003e","targetValue":"\u003cdouble\u003e","unit":"\u003cstring\u003e"},{"baselineValue":"\u003cdouble\u003e","dimensions":[{"dimensionName":"\u003cstring\u003e","dimensionValue":"\u003cstring\u003e"},{"dimensionName":"\u003cstring\u003e","dimensionValue":"\u003cstring\u003e"}],"metricName":"\u003cstring\u003e","percentageChange":"\u003cdouble\u003e","targetValue":"\u003cdouble\u003e","unit":"\u003cstring\u003e"}],"inventory":[{"databaseSubType":"PDB","databaseType":"CLOUD_SIDB","deploymentType":"EXADATA_CC","inventoryCount":"\u003cinteger\u003e"},{"databaseSubType":"ACD","databaseType":"SHARED","deploymentType":"EXADATA_CC","inventoryCount":"\u003cinteger\u003e"}]}}