oracle.oci.oci_usage_query – Manage a Query resource in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.5.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.
python >= 3.6
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io
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
|
|
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
|
|
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
|
|
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
|
|
The graph type.
|
||||
|
is_cumulative_graph
boolean
|
|
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
|
|
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
|
|
The filter operator. Example: 'AND', 'OR', 'NOT'.
|
||||
|
tags
list
/ elements=dictionary
|
The tags to filter on.
|
|||||
|
operator
string
|
|
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
|
|
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
|
|
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
|
|
Whether aggregated by time. If isAggregateByTime is true, all usage/cost over the query time period will be added up.
|
||||
|
query_type
string
|
|
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 |
|||||
|
realm_specific_endpoint_template_enabled
boolean
|
|
Enable/Disable realm specific endpoint template for service client. By Default, realm specific endpoint template is disabled. If not set, then the value of the OCI_REALM_SPECIFIC_SERVICE_ENDPOINT_TEMPLATE_ENABLED variable, if any, is used.
|
||||
|
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
|
|
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 |
|||||
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
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:
Authors¶
Oracle (@oracle)