Oracle Usageapi API is one of 378 APIs that Oracle publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include usageapi. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.
This API exposes
33 operations
across 18 paths,
and defines 53 schemas.
It is described by OpenAPI 3.2.0, at version 20200107.
Requests are made against 2 base URLs: http://127.0.0.1/20200107, https://127.0.0.1/20200107.
The identity and technical contract details declared by the specification.
Configuration
object
A configuration.
2 properties
1 required
ResultLocation
object
The location where usage or cost CSVs will be uploaded defined by locationType, which corresponds with type-specific characteristics.
1 property
1 required
UsageAggregation
object
The account (tenant) usage.
2 properties
1 required
DateRange
object
Static or dynamic date range dateRangeType, which corresponds with type-specific characteristics.
1 property
1 required
EmailRecipientsGroupSummary
object
The email recipients group summary for the recipients group list.
7 properties
4 required
QueryProperties
object
The query properties.
8 properties
2 required
UsageCarbonEmissionsReportQuery
object
The request of the generated carbon emissions usage report.
12 properties
1 required
CreateEmailRecipientsGroupDetails
object
The saved email recipient group to receive usage statement emails.
2 properties
2 required
CustomTableCollection
object
A custom table list.
1 property
1 required
UsageCarbonEmissionsQuerySummary
object
The carbon emissions usage query summary in the list request.
2 properties
2 required
EmailRecipient
object
The email recipient to receive usage statements for the subscription.
4 properties
2 required
CustomTableSummary
object
Custom table in the list request.
2 properties
2 required
UsageSummary
object
The usage store result.
31 properties
2 required
Tag
object
The tag used for filtering.
3 properties
AverageCarbonEmission
object
Average carbon emissions.
2 properties
2 required
EmailRecipientsGroup
object
The recipients group to receive usage statement emails.
4 properties
4 required
UsageCarbonEmissionAggregation
object
The account (tenant) carbon emissions usage.
2 properties
1 required
QuerySummary
object
Query summery in the list request.
2 properties
2 required
UpdateUsageCarbonEmissionsQueryDetails
object
Details for the query to update usageCarbonEmissionsQuery, costAnalysisUI, and displayName.
1 property
1 required
CleanEnergyUsage
object
Clean energy usage.
3 properties
2 required
Dimension
object
The dimension used for filtering. Availabe dimensions are: "service", "skuName", "skuPartNumber", "unit", "compartmentName", "compartmentPath", "compartmentId"…
2 properties
2 required
ScheduledRunCollection
object
The schedule past run list.
1 property
1 required
Filter
object
The filter object for query usage.
4 properties
EmailRecipientsGroupCollection
object
The email recipients group collection.
1 property
1 required
QueryCollection
object
A query list.
1 property
1 required
ScheduleCollection
object
A schedule collection.
1 property
1 required
UpdateCustomTableDetails
object
Details for updating the custom table.
1 property
1 required
ScheduledRunSummary
object
The saved history past run.
6 properties
6 required
Forecast
object
Forecast configuration of usage or cost.
3 properties
1 required
CustomTable
object
The saved custom table.
4 properties
1 required
Query
object
The query to filter and aggregate.
3 properties
3 required
CreateScheduleDetails
object
The saved schedule.
11 properties
5 required
UsageCarbonEmissionsQueryDefinition
object
The common fields for queries.
4 properties
4 required
CreateCustomTableDetails
object
New custom table detail.
3 properties
3 required
UsageCarbonEmissionSummary
object
The carbon emission usage store result.
20 properties
4 required
CreateUsageCarbonEmissionsQueryDetails
object
New query detail with savedRequestUsageCarbonEmissionsDetails, savedCostAnalysisUI, and displayName.
2 properties
2 required
ScheduleSummary
object
Schedule summary for the list schedule.
10 properties
5 required
UsageCarbonEmissionsQueryCollection
object
A carbon emissions usage query list.
1 property
1 required
UsageCarbonEmissionsQuery
object
The carbon emissions usage saved query to filter and aggregate.
3 properties
3 required
RequestSummarizedUsagesDetails
object
Details for the '/usage' query.
11 properties
4 required
Schedule
object
The schedule.
16 properties
8 required
QueryDefinition
object
The common fields for queries.
4 properties
4 required
ConfigurationAggregation
object
The available configurations.
1 property
1 required
ReportQuery
object
The request of the generated Cost Analysis report.
12 properties
2 required
CreateQueryDetails
object
New query detail with savedRequestSummarizedUsagesDetails, savedCostAnalysisUI, and displayName.
2 properties
2 required
CostAnalysisUI
object
The common fields for Cost Analysis UI rendering.
2 properties
UpdateScheduleDetails
object
Details for updating the custom table.
5 properties
Error
object
Erorr details.
2 properties
2 required
RequestUsageCarbonEmissionsDetails
object
Details for the '/usageCarbonEmissions' query.
11 properties
3 required
UpdateEmailRecipientsGroupDetails
object
The saved email recipient group to receive usage statement emails.
1 property
1 required
UpdateQueryDetails
object
Details for the query to update reportQuery, costAnalysisUI, and displayName.
1 property
1 required
ScheduledRun
object
The saved schedule run.
6 properties
6 required
SavedCustomTable
object
The custom table for Cost Analysis UI rendering.
6 properties
1 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Oracle publishes across the network.
