OSub Usage Functions

Package: DBMS_CLOUD_OCI_OSU_COMPUTED_USAGE

GET_COMPUTED_USAGE Function

This is an API which returns Computed Usage corresponding to the id passed

Syntax

FUNCTION get_computed_usage (
  computed_usage_id varchar2,
  compartment_id varchar2,
  fields dbms_cloud_oci_osub_usage_varchar2_tbl DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  x_one_origin_region varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_osu_computed_usage_get_computed_usage_response_t;

Parameters

Parameter	Description
`computed_usage_id`	(required) The Computed Usage Id
`compartment_id`	(required) The OCID of the root compartment.
`fields`	(optional) Partial response refers to an optimization technique offered by the RESTful web APIs to return only the information (fields) required by the client. This parameter is used to control what fields to return.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`x_one_origin_region`	(optional) The OCI home region name in case home region is not us-ashburn-1 (IAD), e.g. ap-mumbai-1, us-phoenix-1 etc.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://csaap-e.oracle.com.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_COMPUTED_USAGE_AGGREGATEDS Function

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).

Syntax

FUNCTION list_computed_usage_aggregateds (
  compartment_id varchar2,
  subscription_id varchar2,
  time_from timestamp with time zone,
  time_to timestamp with time zone,
  parent_product varchar2 DEFAULT NULL,
  grouping varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  x_one_origin_region varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_osu_computed_usage_list_computed_usage_aggregateds_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the root compartment.
`subscription_id`	(required) Subscription Id is an identifier associated to the service used for filter the Computed Usage in SPM.
`time_from`	(required) 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.
`time_to`	(required) Final date to filter Computed Usage data in SPM, expressed in RFC 3339 timestamp format.
`parent_product`	(optional) Product part number for subscribed service line, called parent product.
`grouping`	(optional) 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. Allowed values are: 'HOURLY', 'DAILY', 'MONTHLY', 'NONE'
`limit`	(optional) The maximum number aggregatedComputedUsages of items to return within the Subscription \"List\" call, this counts the overall count across all items Example: `500`
`page`	(optional) The value of the `opc-next-page` response header from the previous \"List\" call.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`x_one_origin_region`	(optional) The OCI home region name in case home region is not us-ashburn-1 (IAD), e.g. ap-mumbai-1, us-phoenix-1 etc.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://csaap-e.oracle.com.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_COMPUTED_USAGES Function

This is a collection API which returns a list of Computed Usages for given filters.

Syntax

FUNCTION list_computed_usages (
  compartment_id varchar2,
  subscription_id varchar2,
  time_from timestamp with time zone,
  time_to timestamp with time zone,
  parent_product varchar2 DEFAULT NULL,
  computed_product varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  x_one_origin_region varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_osu_computed_usage_list_computed_usages_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the root compartment.
`subscription_id`	(required) Subscription Id is an identifier associated to the service used for filter the Computed Usage in SPM.
`time_from`	(required) 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.
`time_to`	(required) Final date to filter Computed Usage data in SPM, expressed in RFC 3339 timestamp format.
`parent_product`	(optional) Product part number for subscribed service line, called parent product.
`computed_product`	(optional) Product part number for Computed Usage .
`limit`	(optional) The maximum number of items to return in a paginated \"List\" call. Example: `500`
`page`	(optional) The value of the `opc-next-page` response header from the previous \"List\" call.
`sort_order`	(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. You can provide one sort order (`sortOrder`). Allowed values are: 'timeCreated', 'timeOfArrival', 'timeMeteredOn'
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`x_one_origin_region`	(optional) The OCI home region name in case home region is not us-ashburn-1 (IAD), e.g. ap-mumbai-1, us-phoenix-1 etc.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://csaap-e.oracle.com.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

Oracle Cloud Infrastructure Documentation Try Free Tier

GET_COMPUTED_USAGE Function 🔗

LIST_COMPUTED_USAGE_AGGREGATEDS Function 🔗

LIST_COMPUTED_USAGES Function 🔗

Oracle Cloud Infrastructure Documentation
Try Free Tier

GET_COMPUTED_USAGE Function

LIST_COMPUTED_USAGE_AGGREGATEDS Function

LIST_COMPUTED_USAGES Function