oracle.oci.oci_opsi_sql_statistics_time_series_facts – Fetches details about a SqlStatisticsTimeSeries resource in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 4.13.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_opsi_sql_statistics_time_series_facts.
New in version 2.9.0: of oracle.oci
Synopsis¶
Fetches details about a SqlStatisticsTimeSeries resource in Oracle Cloud Infrastructure
Query SQL Warehouse to get the performance statistics time series for a given SQL across given databases for a given time period in a compartment and in all sub-compartments if specified.
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 |
|---|---|---|
|
analysis_time_interval
string
|
Specify time period in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M).
|
|
|
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. |
|
cdb_name
list
/ elements=string
|
Filter by one or more cdb name.
|
|
|
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
/ required
|
The OCID of the compartment.
|
|
|
compartment_id_in_subtree
boolean
|
|
A flag to search all resources within a given compartment and all sub-compartments.
|
|
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. |
|
|
database_id
list
/ elements=string
|
Optional list of database OCIDs of the associated DBaaS entity.
|
|
|
defined_tag_equals
list
/ elements=string
|
A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format "{namespace}.{tagName}.{value}". All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
|
|
|
defined_tag_exists
list
/ elements=string
|
A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format "{namespace}.{tagName}.true" (for checking existence of a defined tag) or "{namespace}.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
|
|
|
exadata_insight_id
list
/ elements=string
|
Optional list of exadata insight resource OCIDs.
|
|
|
freeform_tag_equals
list
/ elements=string
|
A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is "{tagName}.{value}". All inputs are case-insensitive. Multiple values for the same tag name are interpreted as "OR". Values for different tag names are interpreted as "AND".
|
|
|
freeform_tag_exists
list
/ elements=string
|
A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is "{tagName}.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for different tag names are interpreted as "AND".
|
|
|
host_name
list
/ elements=string
|
Filter by one or more hostname.
|
|
|
id
list
/ elements=string
|
Optional list of database OCIDs of the database insight resource.
|
|
|
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. |
|
|
sql_identifier
string
/ required
|
Unique SQL_ID for a SQL Statement. Example: `6rgjh9bjmy2s7`
|
|
|
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 |
|
|
time_interval_end
string
|
Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd.
|
|
|
time_interval_start
string
|
Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored.
|
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: List sql_statistics_time_series
oci_opsi_sql_statistics_time_series_facts:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
sql_identifier: sql_identifier_example
# optional
database_id: [ "ocid1.database.oc1..xxxxxxEXAMPLExxxxxx" ]
id: [ "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx" ]
exadata_insight_id: [ "ocid1.exadatainsight.oc1..xxxxxxEXAMPLExxxxxx" ]
cdb_name: [ "cdb_name_example" ]
host_name: [ "host_name_example" ]
analysis_time_interval: analysis_time_interval_example
time_interval_start: 2013-10-20T19:20:30+01:00
time_interval_end: 2013-10-20T19:20:30+01:00
defined_tag_equals: [ "defined_tag_equals_example" ]
freeform_tag_equals: [ "freeform_tag_equals_example" ]
defined_tag_exists: [ "defined_tag_exists_example" ]
freeform_tag_exists: [ "freeform_tag_exists_example" ]
compartment_id_in_subtree: true
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description | ||||
|---|---|---|---|---|---|---|
|
sql_statistics_time_series
complex
|
on success |
SqlStatisticsTimeSeries resource
Sample:
{'end_timestamps': [], 'item_duration_in_ms': 56, 'items': [{'database_details': {'cdb_name': 'cdb_name_example', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'database_display_name': 'database_display_name_example', 'database_id': 'ocid1.database.oc1..xxxxxxEXAMPLExxxxxx', 'database_name': 'database_name_example', 'database_type': 'database_type_example', 'database_version': 'database_version_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'instances': [{'host_name': 'host_name_example', 'instance_name': 'instance_name_example'}]}, 'statistics': [{'name': 'name_example', 'values': []}]}], 'sql_identifier': 'sql_identifier_example', 'time_interval_end': '2013-10-20T19:20:30+01:00', 'time_interval_start': '2013-10-20T19:20:30+01:00'}
|
||||
|
end_timestamps
list
/ elements=string
|
on success |
Array comprising of all the sampling period end timestamps in RFC 3339 format.
|
||||
|
item_duration_in_ms
integer
|
on success |
Time duration in milliseconds between data points (one hour or one day).
Sample:
56
|
||||
|
items
complex
|
on success |
Array of SQL performance statistics across databases.
|
||||
|
database_details
complex
|
on success |
|
||||
|
cdb_name
string
|
on success |
Name of the CDB.Only applies to PDB.
Sample:
cdb_name_example
|
||||
|
compartment_id
string
|
on success |
The OCID of the compartment.
Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
|
||||
|
database_display_name
string
|
on success |
The user-friendly name for the database. The name does not have to be unique.
Sample:
database_display_name_example
|
||||
|
database_id
string
|
on success |
The OCID of the database.
Sample:
ocid1.database.oc1..xxxxxxEXAMPLExxxxxx
|
||||
|
database_name
string
|
on success |
The database name. The database name is unique within the tenancy.
Sample:
database_name_example
|
||||
|
database_type
string
|
on success |
Operations Insights internal representation of the database type.
Sample:
database_type_example
|
||||
|
database_version
string
|
on success |
The version of the database.
Sample:
database_version_example
|
||||
|
id
string
|
on success |
The OCID of the database insight resource.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
||||
|
instances
complex
|
on success |
Array of hostname and instance name.
|
||||
|
host_name
string
|
on success |
The hostname of the database insight resource.
Sample:
host_name_example
|
||||
|
instance_name
string
|
on success |
The instance name of the database insight resource.
Sample:
instance_name_example
|
||||
|
statistics
complex
|
on success |
SQL performance statistics for a given database
|
||||
|
name
string
|
on success |
SQL performance statistic name
Sample:
name_example
|
||||
|
values
list
/ elements=string
|
on success |
SQL performance statistic value
|
||||
|
sql_identifier
string
|
on success |
Unique SQL_ID for a SQL Statement.
Sample:
sql_identifier_example
|
||||
|
time_interval_end
string
|
on success |
The end timestamp that was passed into the request.
Sample:
2013-10-20T19:20:30+01:00
|
||||
|
time_interval_start
string
|
on success |
The start timestamp that was passed into the request.
Sample:
2013-10-20T19:20:30+01:00
|
||||
Authors¶
Oracle (@oracle)