DATABASE-MANAGEMENT_FLEET-HEALTH-METRICS(1)

NAME
database-management_fleet-health-metrics -

DESCRIPTION

The details of the fleet health metrics.

AVAILABLE COMMANDS

•   get

  get

•   Description

•   Usage

•   Required Parameters

•   Optional Parameters

•   Global Parameters

•   Examples

  Description

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.

  Usage

oci database-management fleet-health-metrics get [OPTIONS]

  Required Parameters

--compare-baseline-time [text]

    The baseline time for metrics comparison.

--compare-target-time [text]

    The target time for metrics comparison.

  Optional Parameters

--compare-type [text]

    The time window used for metrics comparison.

    Accepted values are:

    DAY, HOUR

--compartment-id, -c [text]

    The OCID <https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm> of the compartment.

--filter-by-database-sub-type [text]

    The filter used to filter the databases in the fleet by a specific Oracle Database subtype.

--filter-by-database-type [text]

    The filter used to filter the databases in the fleet by a specific Oracle Database type.

--filter-by-metric-names [text]

    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.

--from-json [text]

    Provide input to this command as a JSON document from a file using the file://path-to/file syntax.

    The --generate-full-command-json-input option can be used to generate a sample json file to be used with this command option. The key names are pre-populated and match the command option names (converted to camelCase format, e.g. compartment-id –> compartmentId), while the values of the keys need to be populated by the user before using the sample file as an input to this command. For any command option that accepts multiple values, the value of the key can be a JSON array.

    Options can still be provided on the command line. If an option exists in both the JSON document and the command line then the command line specified value will be used.

    For examples on usage of this option, please see our “using CLI with advanced JSON options” link: https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/cliusing.htm#AdvancedJSONOptions

--managed-database-group-id [text]

    The OCID <https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm> of the Managed Database Group.

  Global Parameters

Use oci --help for help on global parameters.

--auth-purpose, --auth, --cert-bundle, --cli-rc-file, --config-file, --debug, --defaults-file, --endpoint, --generate-full-command-json-input, --generate-param-json-input, --help, --latest-version, --max-retries, --no-retry, --opc-client-request-id, --opc-request-id, --output, --profile, --query, --raw-output, --region, --release-info, --request-id, --version, -?, -d, -h, -v

  Examples

Copy the following CLI commands into a file named example.sh. Run the command by typing “bash example.sh” and replacing the example parameters with your own.

Please note this sample will only work in the POSIX-compliant bash-like shell. You need to set up the OCI configuration <https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/cliinstall.htm#configfile> and appropriate security policies <https://docs.oracle.com/en-us/iaas/Content/Identity/Concepts/policygetstarted.htm> before trying the examples.

    export compare_baseline_time=<substitute-value-of-compare_baseline_time> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/database-management/fleet-health-metrics/get.html#cmdoption-compare-baseline-time
    export compare_target_time=<substitute-value-of-compare_target_time> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/database-management/fleet-health-metrics/get.html#cmdoption-compare-target-time
    oci database-management fleet-health-metrics get --compare-baseline-time $compare_baseline_time --compare-target-time $compare_target_time

AUTHOR
Oracle

COPYRIGHT
2016, 2021, Oracle