usage-api
=============

Description
-----------
Use the Usage CLI to view your Oracle Cloud usage and costs. The CLI allows you to request data that meets the specified filter criteria, and to group that data by the chosen dimension. The Usage CLI is used by the Cost Analysis and Carbon Emissions Analysis tools in the Console. See `Cost Analysis Overview <https://docs.cloud.oracle.com/Content/Billing/Concepts/costanalysisoverview.htm>`__ and [Using the Usage CLI] for more information.

Available Commands
------------------
* :doc:`average-carbon-emission </cmdref/usage-api/average-carbon-emission>`

  * :doc:`request </cmdref/usage-api/average-carbon-emission/request>`

* :doc:`clean-energy-usage </cmdref/usage-api/clean-energy-usage>`

  * :doc:`request </cmdref/usage-api/clean-energy-usage/request>`

* :doc:`configuration </cmdref/usage-api/configuration>`

  * :doc:`request-summarized </cmdref/usage-api/configuration/request-summarized>`
  * :doc:`request-usage-carbon-emission-config </cmdref/usage-api/configuration/request-usage-carbon-emission-config>`

* :doc:`custom-table </cmdref/usage-api/custom-table>`

  * :doc:`create </cmdref/usage-api/custom-table/create>`
  * :doc:`delete </cmdref/usage-api/custom-table/delete>`
  * :doc:`get </cmdref/usage-api/custom-table/get>`
  * :doc:`list </cmdref/usage-api/custom-table/list>`
  * :doc:`update </cmdref/usage-api/custom-table/update>`

* :doc:`email-recipients-group </cmdref/usage-api/email-recipients-group>`

  * :doc:`create </cmdref/usage-api/email-recipients-group/create>`
  * :doc:`delete </cmdref/usage-api/email-recipients-group/delete>`
  * :doc:`get </cmdref/usage-api/email-recipients-group/get>`
  * :doc:`list </cmdref/usage-api/email-recipients-group/list>`
  * :doc:`update </cmdref/usage-api/email-recipients-group/update>`

* :doc:`query </cmdref/usage-api/query>`

  * :doc:`create </cmdref/usage-api/query/create>`
  * :doc:`delete </cmdref/usage-api/query/delete>`
  * :doc:`get </cmdref/usage-api/query/get>`
  * :doc:`list </cmdref/usage-api/query/list>`
  * :doc:`update </cmdref/usage-api/query/update>`

* :doc:`schedule </cmdref/usage-api/schedule>`

  * :doc:`create </cmdref/usage-api/schedule/create>`
  * :doc:`delete </cmdref/usage-api/schedule/delete>`
  * :doc:`get </cmdref/usage-api/schedule/get>`
  * :doc:`list </cmdref/usage-api/schedule/list>`
  * :doc:`update </cmdref/usage-api/schedule/update>`

* :doc:`scheduled-run </cmdref/usage-api/scheduled-run>`

  * :doc:`get </cmdref/usage-api/scheduled-run/get>`
  * :doc:`list </cmdref/usage-api/scheduled-run/list>`

* :doc:`usage-carbon-emission-summary </cmdref/usage-api/usage-carbon-emission-summary>`

  * :doc:`request-usage-carbon-emissions </cmdref/usage-api/usage-carbon-emission-summary/request-usage-carbon-emissions>`

* :doc:`usage-carbon-emissions-query </cmdref/usage-api/usage-carbon-emissions-query>`

  * :doc:`create </cmdref/usage-api/usage-carbon-emissions-query/create>`
  * :doc:`delete </cmdref/usage-api/usage-carbon-emissions-query/delete>`
  * :doc:`get </cmdref/usage-api/usage-carbon-emissions-query/get>`
  * :doc:`list </cmdref/usage-api/usage-carbon-emissions-query/list>`
  * :doc:`update </cmdref/usage-api/usage-carbon-emissions-query/update>`

* :doc:`usage-summary </cmdref/usage-api/usage-summary>`

  * :doc:`request-summarized-usages </cmdref/usage-api/usage-summary/request-summarized-usages>`


.. toctree::
    :hidden:

    /cmdref/usage-api/average-carbon-emission
    /cmdref/usage-api/clean-energy-usage
    /cmdref/usage-api/configuration
    /cmdref/usage-api/custom-table
    /cmdref/usage-api/email-recipients-group
    /cmdref/usage-api/query
    /cmdref/usage-api/schedule
    /cmdref/usage-api/scheduled-run
    /cmdref/usage-api/usage-carbon-emission-summary
    /cmdref/usage-api/usage-carbon-emissions-query
    /cmdref/usage-api/usage-summary