``list-aggregated-computed-usages`` =================================== .. contents:: :local: :depth: 1 Description ------------ This is a collection API which returns a list of aggregated computed usage details (there can be multiple Parent Products under a given SubID each of which is represented under Subscription Service Line # in SPM). Usage ----- .. code-block:: none oci onesubscription computed-usage aggregated-computed-usage-summary list-aggregated-computed-usages [OPTIONS] Required Parameters -------------------- .. option:: --compartment-id, -c [text] The OCID of the root compartment. .. option:: --subscription-id [text] Subscription Id is an identifier associated to the service used for filter the Computed Usage in SPM. .. option:: --time-from [datetime] Initial date to filter Computed Usage data in SPM. In the case of non aggregated data the time period between of fromDate and toDate , expressed in RFC 3339 timestamp format. 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-to [datetime] Final date to filter Computed Usage data in SPM, expressed in RFC 3339 timestamp format. 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 Optional Parameters -------------------- .. option:: --all Fetches all pages of results. If you provide this option, then you cannot provide the ``--limit`` option. .. 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:: --grouping [text] Grouping criteria to use for aggregate the computed Usage, either hourly (`HOURLY`), daily (`DAILY`), monthly(`MONTHLY`) or none (`NONE`) to not follow a grouping criteria by date. Accepted values are: .. code-block:: py DAILY, HOURLY, MONTHLY, NONE .. option:: --limit [integer] The maximum number aggregatedComputedUsages of items to return within the Subscription "List" call, this counts the overall count across all items Example: `500` .. option:: --page [text] The value of the 'opc-next-page' response header from the previous "List" call. .. option:: --page-size [integer] When fetching results, the number of results to fetch per call. Only valid when used with ``--all`` or ``--limit``, and ignored otherwise. .. option:: --parent-product [text] Product part number for subscribed service line, called parent product. 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 compartment_id= # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/onesubscription/computed-usage/aggregated-computed-usage-summary/list-aggregated-computed-usages.html#cmdoption-compartment-id export subscription_id= # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/onesubscription/computed-usage/aggregated-computed-usage-summary/list-aggregated-computed-usages.html#cmdoption-subscription-id export time_from= # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/onesubscription/computed-usage/aggregated-computed-usage-summary/list-aggregated-computed-usages.html#cmdoption-time-from export time_to= # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/onesubscription/computed-usage/aggregated-computed-usage-summary/list-aggregated-computed-usages.html#cmdoption-time-to oci onesubscription computed-usage aggregated-computed-usage-summary list-aggregated-computed-usages --compartment-id $compartment_id --subscription-id $subscription_id --time-from $time_from --time-to $time_to