oracle.oci.oci_usage_query – Manage a Query resource in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 4.11.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install oracle.oci.

To use it in a playbook, specify: oracle.oci.oci_usage_query.

New in version 2.9.0: of oracle.oci

Synopsis

  • This module allows the user to create, update and delete a Query resource in Oracle Cloud Infrastructure

  • For state=present, returns the created query.

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter Choices/Defaults Comments
api_user
string
The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_ID environment variable, if any, is used. This option is required if the user is not specified through a configuration file (See config_file_location). To get the user's OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_fingerprint
string
Fingerprint for the key pair being used. If not set, then the value of the OCI_USER_FINGERPRINT environment variable, if any, is used. This option is required if the key fingerprint is not specified through a configuration file (See config_file_location). To get the key pair's fingerprint value please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_key_file
string
Full path and filename of the private key (in PEM format). If not set, then the value of the OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is not specified through a configuration file (See config_file_location). If the key is encrypted with a pass-phrase, the api_user_key_pass_phrase option must also be provided.
api_user_key_pass_phrase
string
Passphrase used by the key referenced in api_user_key_file, if it is encrypted. If not set, then the value of the OCI_USER_KEY_PASS_PHRASE variable, if any, is used. This option is required if the key passphrase is not specified through a configuration file (See config_file_location).
auth_purpose
string
    Choices:
  • service_principal
The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None.
auth_type
string
    Choices:
  • api_key ←
  • instance_principal
  • instance_obo_user
  • resource_principal
The type of authentication to use for making API requests. By default auth_type="api_key" based authentication is performed and the API key (see api_user_key_file) in your config file will be used. If this 'auth_type' module option is not specified, the value of the OCI_ANSIBLE_AUTH_TYPE, if any, is used. Use auth_type="instance_principal" to use instance principal based authentication when running ansible playbooks within an OCI compute instance.
cert_bundle
string
The full path to a CA certificate bundle to be used for SSL verification. This will override the default CA certificate bundle. If not set, then the value of the OCI_ANSIBLE_CERT_BUNDLE variable, if any, is used.
compartment_id
string
The compartment OCID.
Required for create using state=present.
config_file_location
string
Path to configuration file. If not set then the value of the OCI_CONFIG_FILE environment variable, if any, is used. Otherwise, defaults to ~/.oci/config.
config_profile_name
string
The profile to load from the config file referenced by config_file_location. If not set, then the value of the OCI_CONFIG_PROFILE environment variable, if any, is used. Otherwise, defaults to the "DEFAULT" profile in config_file_location.
force_create
boolean
    Choices:
  • no ←
  • yes
Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation, and doesn't create the resource if it already exists. Setting this option to true, forcefully creates a copy of the resource, even if it already exists.This option is mutually exclusive with key_by.
key_by
list / elements=string
The list of attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource are used to uniquely identify a resource.
query_definition
dictionary
Required for create using state=present, update using state=present with query_id present.
cost_analysis_ui
dictionary / required
graph
string
    Choices:
  • BARS
  • LINES
  • STACKED_LINES
The graph type.
is_cumulative_graph
boolean
    Choices:
  • no
  • yes
A cumulative graph.
display_name
string / required
The query display name. Avoid entering confidential information.

aliases: name
report_query
dictionary / required
compartment_depth
float
The compartment depth level.
date_range_name
string
    Choices:
  • LAST_SEVEN_DAYS
  • LAST_TEN_DAYS
  • MTD
  • LAST_TWO_MONTHS
  • LAST_THREE_MONTHS
  • ALL
  • LAST_SIX_MONTHS
  • LAST_ONE_YEAR
  • YTD
  • CUSTOM
The UI date range, for example, LAST_THREE_MONTHS. Conflicts with timeUsageStarted and timeUsageEnded.
filter
dictionary
dimensions
list / elements=dictionary
The dimensions to filter on.
key
string / required
The dimension key.
value
string / required
The dimension value.
filters
list / elements=dictionary
The nested filter object.
dimensions
list / elements=dictionary
The dimensions to filter on.
filters
list / elements=dictionary
The nested filter object.
operator
string
    Choices:
  • AND
  • NOT
  • OR
The filter operator. Example: 'AND', 'OR', 'NOT'.
tags
list / elements=dictionary
The tags to filter on.
operator
string
    Choices:
  • AND
  • NOT
  • OR
The filter operator. Example: 'AND', 'OR', 'NOT'.
tags
list / elements=dictionary
The tags to filter on.
key
string
The tag key.
namespace
string
The tag namespace.
value
string
The tag value.
forecast
dictionary
forecast_type
string
    Choices:
  • BASIC
BASIC uses the exponential smoothing (ETS) model to project future usage/costs based on history data. The basis for projections is a periodic set of equivalent historical days for which the projection is being made.
time_forecast_ended
string / required
The forecast end time.
time_forecast_started
string
The forecast start time. Defaults to UTC-1 if not specified.
granularity
string / required
    Choices:
  • HOURLY
  • DAILY
  • MONTHLY
  • TOTAL
The usage granularity. HOURLY - Hourly data aggregation. DAILY - Daily data aggregation. MONTHLY - Monthly data aggregation. TOTAL - Not yet supported.
group_by
list / elements=string
Aggregate the result by. example: `["tagNamespace", "tagKey", "tagValue", "service", "skuName", "skuPartNumber", "unit", "compartmentName", "compartmentPath", "compartmentId", "platform", "region", "logicalAd", "resourceId", "tenantId", "tenantName"]`
group_by_tag
list / elements=dictionary
GroupBy a specific tagKey. Provide the tagNamespace and tagKey in the tag object. Only supports one tag in the list. For example: `[{"namespace":"oracle", "key":"createdBy"]`
key
string
The tag key.
namespace
string
The tag namespace.
value
string
The tag value.
is_aggregate_by_time
boolean
    Choices:
  • no
  • yes
Whether aggregated by time. If isAggregateByTime is true, all usage/cost over the query time period will be added up.
query_type
string
    Choices:
  • USAGE
  • COST
  • CREDIT
  • EXPIREDCREDIT
  • ALLCREDIT
The query usage type. COST by default if it is missing. Usage - Query the usage data. Cost - Query the cost/billing data. Credit - Query the credit adjustments data. ExpiredCredit - Query the expired credits data AllCredit - Query the credit adjustments and expired credit
tenant_id
string / required
Tenant ID.
time_usage_ended
string
The usage end time.
time_usage_started
string
The usage start time.
version
float / required
The saved query version.
query_id
string
The query unique OCID.
Required for update using state=present.
Required for delete using state=absent.

aliases: id
region
string
The Oracle Cloud Infrastructure region to use for all OCI API requests. If not set, then the value of the OCI_REGION variable, if any, is used. This option is required if the region is not specified through a configuration file (See config_file_location). Please refer to https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm for more information on OCI regions.
state
string
    Choices:
  • present ←
  • absent
The state of the Query.
Use state=present to create or update a Query.
Use state=absent to delete a Query.
tenancy
string
OCID of your tenancy. If not set, then the value of the OCI_TENANCY variable, if any, is used. This option is required if the tenancy OCID is not specified through a configuration file (See config_file_location). To get the tenancy OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm

Examples

- name: Create query
  oci_usage_query:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    query_definition:
      # required
      display_name: display_name_example
      report_query:
        # required
        tenant_id: "ocid1.tenant.oc1..xxxxxxEXAMPLExxxxxx"
        granularity: HOURLY

        # optional
        time_usage_started: time_usage_started_example
        time_usage_ended: time_usage_ended_example
        is_aggregate_by_time: true
        forecast:
          # required
          time_forecast_ended: time_forecast_ended_example

          # optional
          forecast_type: BASIC
          time_forecast_started: time_forecast_started_example
        query_type: USAGE
        group_by: [ "group_by_example" ]
        group_by_tag:
        - # optional
          namespace: namespace_example
          key: key_example
          value: value_example
        compartment_depth: 3.4
        filter:
          # optional
          operator: AND
          dimensions:
          - # required
            key: key_example
            value: value_example
          tags:
          - # optional
            namespace: namespace_example
            key: key_example
            value: value_example
          filters:
          - # optional
            operator: AND
            dimensions: [ "dimensions_example" ]
            tags: [ "tags_example" ]
            filters: [ "filters_example" ]
        date_range_name: LAST_SEVEN_DAYS
      cost_analysis_ui:
        # optional
        graph: BARS
        is_cumulative_graph: true
      version: 3.4

- name: Update query
  oci_usage_query:
    # required
    query_definition:
      # required
      display_name: display_name_example
      report_query:
        # required
        tenant_id: "ocid1.tenant.oc1..xxxxxxEXAMPLExxxxxx"
        granularity: HOURLY

        # optional
        time_usage_started: time_usage_started_example
        time_usage_ended: time_usage_ended_example
        is_aggregate_by_time: true
        forecast:
          # required
          time_forecast_ended: time_forecast_ended_example

          # optional
          forecast_type: BASIC
          time_forecast_started: time_forecast_started_example
        query_type: USAGE
        group_by: [ "group_by_example" ]
        group_by_tag:
        - # optional
          namespace: namespace_example
          key: key_example
          value: value_example
        compartment_depth: 3.4
        filter:
          # optional
          operator: AND
          dimensions:
          - # required
            key: key_example
            value: value_example
          tags:
          - # optional
            namespace: namespace_example
            key: key_example
            value: value_example
          filters:
          - # optional
            operator: AND
            dimensions: [ "dimensions_example" ]
            tags: [ "tags_example" ]
            filters: [ "filters_example" ]
        date_range_name: LAST_SEVEN_DAYS
      cost_analysis_ui:
        # optional
        graph: BARS
        is_cumulative_graph: true
      version: 3.4
    query_id: "ocid1.query.oc1..xxxxxxEXAMPLExxxxxx"

- name: Delete query
  oci_usage_query:
    # required
    query_id: "ocid1.query.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
query
complex
on success
Details of the Query resource acted upon by the current operation

Sample:
{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'query_definition': {'cost_analysis_ui': {'graph': 'BARS', 'is_cumulative_graph': True}, 'display_name': 'display_name_example', 'report_query': {'compartment_depth': 10, 'date_range_name': 'LAST_SEVEN_DAYS', 'filter': {'dimensions': [{'key': 'key_example', 'value': 'value_example'}], 'filters': [{'dimensions': [], 'filters': [], 'operator': 'AND', 'tags': []}], 'operator': 'AND', 'tags': [{'key': 'key_example', 'namespace': 'namespace_example', 'value': 'value_example'}]}, 'forecast': {'forecast_type': 'BASIC', 'time_forecast_ended': '2013-10-20T19:20:30+01:00', 'time_forecast_started': '2013-10-20T19:20:30+01:00'}, 'granularity': 'HOURLY', 'group_by': [], 'group_by_tag': [{'key': 'key_example', 'namespace': 'namespace_example', 'value': 'value_example'}], 'is_aggregate_by_time': True, 'query_type': 'USAGE', 'tenant_id': 'ocid1.tenant.oc1..xxxxxxEXAMPLExxxxxx', 'time_usage_ended': '2013-10-20T19:20:30+01:00', 'time_usage_started': '2013-10-20T19:20:30+01:00'}, 'version': 10}}
 
compartment_id
string
on success
The compartment OCID.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
id
string
on success
The query OCID.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
query_definition
complex
on success

   
cost_analysis_ui
complex
on success

     
graph
string
on success
The graph type.

Sample:
BARS
     
is_cumulative_graph
boolean
on success
A cumulative graph.

Sample:
True
   
display_name
string
on success
The query display name. Avoid entering confidential information.

Sample:
display_name_example
   
report_query
complex
on success

     
compartment_depth
float
on success
The compartment depth level.

Sample:
10
     
date_range_name
string
on success
The UI date range, for example, LAST_THREE_MONTHS. Conflicts with timeUsageStarted and timeUsageEnded.

Sample:
LAST_SEVEN_DAYS
     
filter
complex
on success

       
dimensions
complex
on success
The dimensions to filter on.

         
key
string
on success
The dimension key.

Sample:
key_example
         
value
string
on success
The dimension value.

Sample:
value_example
       
filters
complex
on success
The nested filter object.

         
dimensions
list / elements=string
on success
The dimensions to filter on.

         
filters
list / elements=string
on success
The nested filter object.

         
operator
string
on success
The filter operator. Example: 'AND', 'OR', 'NOT'.

Sample:
AND
         
tags
list / elements=string
on success
The tags to filter on.

       
operator
string
on success
The filter operator. Example: 'AND', 'OR', 'NOT'.

Sample:
AND
       
tags
complex
on success
The tags to filter on.

         
key
string
on success
The tag key.

Sample:
key_example
         
namespace
string
on success
The tag namespace.

Sample:
namespace_example
         
value
string
on success
The tag value.

Sample:
value_example
     
forecast
complex
on success

       
forecast_type
string
on success
BASIC uses the exponential smoothing (ETS) model to project future usage/costs based on history data. The basis for projections is a periodic set of equivalent historical days for which the projection is being made.

Sample:
BASIC
       
time_forecast_ended
string
on success
The forecast end time.

Sample:
2013-10-20T19:20:30+01:00
       
time_forecast_started
string
on success
The forecast start time. Defaults to UTC-1 if not specified.

Sample:
2013-10-20T19:20:30+01:00
     
granularity
string
on success
The usage granularity. HOURLY - Hourly data aggregation. DAILY - Daily data aggregation. MONTHLY - Monthly data aggregation. TOTAL - Not yet supported.

Sample:
HOURLY
     
group_by
list / elements=string
on success
Aggregate the result by. example: `["tagNamespace", "tagKey", "tagValue", "service", "skuName", "skuPartNumber", "unit", "compartmentName", "compartmentPath", "compartmentId", "platform", "region", "logicalAd", "resourceId", "tenantId", "tenantName"]`

     
group_by_tag
complex
on success
GroupBy a specific tagKey. Provide the tagNamespace and tagKey in the tag object. Only supports one tag in the list. For example: `[{"namespace":"oracle", "key":"createdBy"]`

       
key
string
on success
The tag key.

Sample:
key_example
       
namespace
string
on success
The tag namespace.

Sample:
namespace_example
       
value
string
on success
The tag value.

Sample:
value_example
     
is_aggregate_by_time
boolean
on success
Whether aggregated by time. If isAggregateByTime is true, all usage/cost over the query time period will be added up.

Sample:
True
     
query_type
string
on success
The query usage type. COST by default if it is missing. Usage - Query the usage data. Cost - Query the cost/billing data. Credit - Query the credit adjustments data. ExpiredCredit - Query the expired credits data AllCredit - Query the credit adjustments and expired credit

Sample:
USAGE
     
tenant_id
string
on success
Tenant ID.

Sample:
ocid1.tenant.oc1..xxxxxxEXAMPLExxxxxx
     
time_usage_ended
string
on success
The usage end time.

Sample:
2013-10-20T19:20:30+01:00
     
time_usage_started
string
on success
The usage start time.

Sample:
2013-10-20T19:20:30+01:00
   
version
float
on success
The saved query version.

Sample:
10


Authors

  • Oracle (@oracle)