"get"
*****

* Description

* Usage

* Required Parameters

* Optional Parameters

* Global Parameters

* Examples


Description
===========

Gets a summary of the resource usage metrics such as CPU, User I/O,
and Storage for each PDB within a specific CDB. If comparmentId is
specified, then the metrics for each PDB (within the CDB) in the
specified compartment are retrieved. If compartmentId is not
specified, then the metrics for all the PDBs within the CDB are
retrieved.


Usage
=====

   oci database-management pdb-metrics get [OPTIONS]


Required Parameters
===================

--end-time [text]

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’”.

--managed-database-id [text]

The OCID of the Managed Database.

--start-time [text]

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’”.


Optional Parameters
===================

--compare-type [text]

The time window used for metrics comparison.

Accepted values are:

   DAY, HOUR

--compartment-id, -c [text]

The OCID of the compartment.

--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/Conte
nt/API/SDKDocs/cliusing.htm#AdvancedJSONOptions


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 and appropriate
security policies before trying the examples.

       export end_time=<substitute-value-of-end_time> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/database-management/pdb-metrics/get.html#cmdoption-end-time
       export managed_database_id=<substitute-value-of-managed_database_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/database-management/pdb-metrics/get.html#cmdoption-managed-database-id
       export start_time=<substitute-value-of-start_time> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/database-management/pdb-metrics/get.html#cmdoption-start-time

       oci database-management pdb-metrics get --end-time $end_time --managed-database-id $managed_database_id --start-time $start_time
