``summarize-awr-database-top-wait-events`` ========================================== .. contents:: :local: :depth: 1 Description ------------ Summarizes the AWR top wait events. Usage ----- .. code-block:: none oci opsi awr-hubs summarize-awr-database-top-wait-events [OPTIONS] Required Parameters -------------------- .. option:: --awr-hub-id [text] Unique Awr Hub identifier .. option:: --awr-source-database-identifier [text] The internal ID of the database. The internal ID of the database is not the `OCID `__. It can be retrieved from the following endpoint: /awrHubs/{awrHubId}/awrDatabases Optional Parameters -------------------- .. option:: --begin-snapshot-identifier-greater-than-or-equal-to [integer] The optional greater than or equal to filter on the snapshot ID. .. option:: --end-snapshot-identifier-less-than-or-equal-to [integer] The optional less than or equal to query parameter to filter the snapshot Identifier. .. option:: --from-json [text] Provide input to this command as a JSON document from a file using the file://path-to/file syntax. The :option:`--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 .. option:: --instance-number [text] The optional single value query parameter to filter by database instance number. .. option:: --session-type [text] The optional query parameter to filter ASH activities by FOREGROUND or BACKGROUND. Accepted values are: .. code-block:: py ALL, BACKGROUND, FOREGROUND .. option:: --sort-by [text] The option to sort the AWR top event summary data. Accepted values are: .. code-block:: py AVG_WAIT_TIME_PERSEC, WAITS_PERSEC .. option:: --sort-order [text] The sort order to use, either ascending (`ASC`) or descending (`DESC`). Accepted values are: .. code-block:: py ASC, DESC .. option:: --time-greater-than-or-equal-to [datetime] The optional greater than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z The following datetime formats are supported: UTC with microseconds *********************** .. code:: Format: YYYY-MM-DDTHH:mm:ss.ssssssTZD Example: 2017-09-15T20:30:00.123456Z UTC with milliseconds *********************** .. code:: Format: YYYY-MM-DDTHH:mm:ss.sssTZD Example: 2017-09-15T20:30:00.123Z UTC without milliseconds ************************** .. code:: Format: YYYY-MM-DDTHH:mm:ssTZD Example: 2017-09-15T20:30:00Z UTC with minute precision ************************** .. code:: Format: YYYY-MM-DDTHH:mmTZD Example: 2017-09-15T20:30Z Timezone with microseconds *************************** .. code:: Format: YYYY-MM-DDTHH:mm:ssTZD Example: 2017-09-15T12:30:00.456789-08:00, 2017-09-15T12:30:00.456789-0800 Timezone with milliseconds *************************** .. code:: Format: YYYY-MM-DDTHH:mm:ssTZD Example: 2017-09-15T12:30:00.456-08:00, 2017-09-15T12:30:00.456-0800 Timezone without milliseconds ******************************* .. code:: Format: YYYY-MM-DDTHH:mm:ssTZD Example: 2017-09-15T12:30:00-08:00, 2017-09-15T12:30:00-0800 Timezone with minute precision ******************************* .. code:: Format: YYYY-MM-DDTHH:mmTZD Example: 2017-09-15T12:30-08:00, 2017-09-15T12:30-0800 Short date and time ******************** The timezone for this date and time will be taken as UTC (Needs to be surrounded by single or double quotes) .. code:: Format: 'YYYY-MM-DD HH:mm' or "YYYY-MM-DD HH:mm" Example: '2017-09-15 17:25' Date Only ********** This date will be taken as midnight UTC of that day .. code:: Format: YYYY-MM-DD Example: 2017-09-15 Epoch seconds ************** .. code:: Example: 1412195400 .. option:: --time-less-than-or-equal-to [datetime] The optional less than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z The following datetime formats are supported: UTC with microseconds *********************** .. code:: Format: YYYY-MM-DDTHH:mm:ss.ssssssTZD Example: 2017-09-15T20:30:00.123456Z UTC with milliseconds *********************** .. code:: Format: YYYY-MM-DDTHH:mm:ss.sssTZD Example: 2017-09-15T20:30:00.123Z UTC without milliseconds ************************** .. code:: Format: YYYY-MM-DDTHH:mm:ssTZD Example: 2017-09-15T20:30:00Z UTC with minute precision ************************** .. code:: Format: YYYY-MM-DDTHH:mmTZD Example: 2017-09-15T20:30Z Timezone with microseconds *************************** .. code:: Format: YYYY-MM-DDTHH:mm:ssTZD Example: 2017-09-15T12:30:00.456789-08:00, 2017-09-15T12:30:00.456789-0800 Timezone with milliseconds *************************** .. code:: Format: YYYY-MM-DDTHH:mm:ssTZD Example: 2017-09-15T12:30:00.456-08:00, 2017-09-15T12:30:00.456-0800 Timezone without milliseconds ******************************* .. code:: Format: YYYY-MM-DDTHH:mm:ssTZD Example: 2017-09-15T12:30:00-08:00, 2017-09-15T12:30:00-0800 Timezone with minute precision ******************************* .. code:: Format: YYYY-MM-DDTHH:mmTZD Example: 2017-09-15T12:30-08:00, 2017-09-15T12:30-0800 Short date and time ******************** The timezone for this date and time will be taken as UTC (Needs to be surrounded by single or double quotes) .. code:: Format: 'YYYY-MM-DD HH:mm' or "YYYY-MM-DD HH:mm" Example: '2017-09-15 17:25' Date Only ********** This date will be taken as midnight UTC of that day .. code:: Format: YYYY-MM-DD Example: 2017-09-15 Epoch seconds ************** .. code:: Example: 1412195400 .. option:: --top-n [integer] The optional query parameter to filter the number of top categories to be returned. Global Parameters ------------------ Use ``oci --help`` for help on global parameters. :option:`--auth-purpose`, :option:`--auth`, :option:`--cert-bundle`, :option:`--cli-auto-prompt`, :option:`--cli-rc-file`, :option:`--config-file`, :option:`--connection-timeout`, :option:`--debug`, :option:`--defaults-file`, :option:`--endpoint`, :option:`--generate-full-command-json-input`, :option:`--generate-param-json-input`, :option:`--help`, :option:`--latest-version`, :option:`--max-retries`, :option:`--no-retry`, :option:`--opc-client-request-id`, :option:`--opc-request-id`, :option:`--output`, :option:`--profile`, :option:`--proxy`, :option:`--query`, :option:`--raw-output`, :option:`--read-timeout`, :option:`--realm-specific-endpoint`, :option:`--region`, :option:`--release-info`, :option:`--request-id`, :option:`--version`, :option:`-?`, :option:`-d`, :option:`-h`, :option:`-i`, :option:`-v` Example using required parameter ------------------ 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. .. code-block:: none :class: copy-code-block export awr_hub_id= # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/opsi/awr-hubs/summarize-awr-database-top-wait-events.html#cmdoption-awr-hub-id export awr_source_database_identifier= # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/opsi/awr-hubs/summarize-awr-database-top-wait-events.html#cmdoption-awr-source-database-identifier oci opsi awr-hubs summarize-awr-database-top-wait-events --awr-hub-id $awr_hub_id --awr-source-database-identifier $awr_source_database_identifier