openapi: 3.2.0 info: description: Use the Usage API to view your Oracle Cloud usage and costs. The API allows you to request data that meets the specified filter criteria, and to group that data by the chosen dimension. The Usage API is used by [Cost Analysis](/Content/Billing/Concepts/costanalysisoverview.htm), [Scheduled Reports](/Content/Billing/Concepts/scheduledreportoverview.htm), and [Carbon Emissions Analysis](/Content/General/Concepts/emissions-management.htm) in the Console. Also see [Using the Usage API](/Content/Billing/Concepts/costanalysisoverview.htm#cost_analysis_using_the_api) for more information. title: Usage Usageapi API version: '20200107' x-provenance: method: harvested first_party: true publisher: Oracle source: https://docs.oracle.com/en-us/iaas/api/specs/160805cf79c885be02270019926099ebcab17a40de36b74d9f2156bacbda769e.yaml harvested: '2026-08-04' note: Published by Oracle as the contract for the Usage API OCI service and stored verbatim; API Evangelist added only this provenance block. x-evidence: - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json what: Oracle's own index of every OCI service specification - url: https://docs.oracle.com/en-us/iaas/api/specs/160805cf79c885be02270019926099ebcab17a40de36b74d9f2156bacbda769e.yaml what: the harvested document for Usage API servers: - url: http://127.0.0.1/20200107 - url: https://127.0.0.1/20200107 tags: - name: usageapi paths: /averageCarbonEmissions/{skuPartNumber}: get: description: 'Returns the average carbon emissions summary by SKU. ' operationId: RequestAverageCarbonEmission parameters: - $ref: '#/components/parameters/SkuPathParam' - $ref: '#/components/parameters/OpcRequestIdHeaderParam' responses: 200: description: The average carbon emissions summary. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AverageCarbonEmission' 400: $ref: '#/components/responses/400BadRequest' 401: $ref: '#/components/responses/401Unauthorized' 404: $ref: '#/components/responses/404NotAuthorizedOrNotFound' 412: $ref: '#/components/responses/412PreconditionFailed' 429: $ref: '#/components/responses/429TooManyRequests' 500: $ref: '#/components/responses/500InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: Requests average carbon emissions by SKU. tags: - usageapi x-related-resource: '#/definitions/AverageCarbonEmission' /cleanEnergyUsages/{region}: get: description: 'Returns the clean energy usage summary by region. ' operationId: RequestCleanEnergyUsage parameters: - $ref: '#/components/parameters/RegionPathParam' - $ref: '#/components/parameters/AdQueryParam' - $ref: '#/components/parameters/OpcRequestIdHeaderParam' responses: 200: description: The clean energy usage summary. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/CleanEnergyUsage' 400: $ref: '#/components/responses/400BadRequest' 401: $ref: '#/components/responses/401Unauthorized' 404: $ref: '#/components/responses/404NotAuthorizedOrNotFound' 412: $ref: '#/components/responses/412PreconditionFailed' 429: $ref: '#/components/responses/429TooManyRequests' 500: $ref: '#/components/responses/500InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: Requests renewable/clean energy % used by region. tags: - usageapi x-related-resource: '#/definitions/CleanEnergyUsage' /configuration: get: description: 'Returns the configurations list for the UI drop-down list. ' operationId: RequestSummarizedConfigurations parameters: - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - description: tenant id in: query name: tenantId required: true schema: type: string maxLength: 255 minLength: 1 responses: 200: description: The configuration used for the drop-down list. The value is a list of available items. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ConfigurationAggregation' 400: $ref: '#/components/responses/400BadRequest' 401: $ref: '#/components/responses/401Unauthorized' 404: $ref: '#/components/responses/404NotAuthorizedOrNotFound' 412: $ref: '#/components/responses/412PreconditionFailed' 429: $ref: '#/components/responses/429TooManyRequests' 500: $ref: '#/components/responses/500InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: Returns configurations. tags: - usageapi x-related-resource: '#/definitions/Configuration' /customTables: get: description: 'Returns the saved custom table list. ' operationId: ListCustomTables parameters: - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/SavedReportIdQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' responses: 200: description: The saved custom table list. headers: opc-next-page: description: 'For pagination of a list of custom tables. If this header appears in the response, then this is a partial list of custom tables. Include this value as the `page` parameter in a subsequent GET request, to get the next batch of custom tables. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/CustomTableCollection' 400: $ref: '#/components/responses/400BadRequest' 401: $ref: '#/components/responses/401Unauthorized' 404: $ref: '#/components/responses/404NotAuthorizedOrNotFound' 412: $ref: '#/components/responses/412PreconditionFailed' 429: $ref: '#/components/responses/429TooManyRequests' 500: $ref: '#/components/responses/500InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: Returns saved custom tables. tags: - usageapi x-example: 'GET /20200107/customTables?compartmentId=<compartmentId>&savedReportId=<savedReportId> Host: usageapi.us-ashburn-1.oci.oraclecloud.com authorization: <authorization and other headers> ' x-related-resource: '#/definitions/CustomTable' post: description: 'Returns the created custom table. ' operationId: CreateCustomTable parameters: - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: Returns the created custom table ID/name. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/CustomTable' 400: $ref: '#/components/responses/400BadRequest' 401: $ref: '#/components/responses/401Unauthorized' 404: $ref: '#/components/responses/404NotAuthorizedOrNotFound' 409: $ref: '#/components/responses/409Conflict' 412: $ref: '#/components/responses/412PreconditionFailed' 429: $ref: '#/components/responses/429TooManyRequests' 500: $ref: '#/components/responses/500InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: Create a custom table. tags: - usageapi x-example: "POST /20200107/customTables\nHost: usageapi.us-ashburn-1.oci.oraclecloud.com\nauthorization: <authorization and other headers>\n{\n \"compartmentId\": \"ocid1.tenancy.oc1..testid\",\n \"savedReportId\": \"testReportId\",\n \"savedCustomTable\": {\n \"displayName\": \"customTable1\",\n \"rowGroupBy\": [\n \"string\"\n ],\n \"columnGroupBy\": [\n \"string\"\n ],\n \"groupByTag\": null,\n \"compartmentDepth\": 1,\n \"version\": 1\n }\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateCustomTableDetails' description: New custom table details. required: true /customTables/{customTableId}: delete: description: 'Delete a saved custom table by the OCID. ' operationId: DeleteCustomTable parameters: - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/CustomTableIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 204: description: The custom table was successfully deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400BadRequest' 401: $ref: '#/components/responses/401Unauthorized' 404: $ref: '#/components/responses/404NotAuthorizedOrNotFound' 409: $ref: '#/components/responses/409Conflict' 412: $ref: '#/components/responses/412PreconditionFailed' 429: $ref: '#/components/responses/429TooManyRequests' 500: $ref: '#/components/responses/500InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: Delete a custom table. tags: - usageapi x-example: 'DELETE /20200107/customTables/<customTableId> Host: usageapi.us-ashburn-1.oci.oraclecloud.com authorization: <authorization and other headers> ' x-related-resource: '#/definitions/CustomTable' get: description: 'Returns the saved custom table. ' operationId: GetCustomTable parameters: - $ref: '#/components/parameters/CustomTableIdPathParam' - $ref: '#/components/parameters/OpcRequestIdHeaderParam' responses: 200: description: The saved custom table. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/CustomTable' 400: $ref: '#/components/responses/400BadRequest' 401: $ref: '#/components/responses/401Unauthorized' 404: $ref: '#/components/responses/404NotAuthorizedOrNotFound' 412: $ref: '#/components/responses/412PreconditionFailed' 429: $ref: '#/components/responses/429TooManyRequests' 500: $ref: '#/components/responses/500InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: Returns saved custom table. tags: - usageapi x-example: 'GET /20200107/customTables/<customTableId> Host: usageapi.us-ashburn-1.oci.oraclecloud.com authorization: <authorization and other headers> ' x-related-resource: '#/definitions/CustomTable' put: description: 'Update a saved custom table by table ID. ' operationId: UpdateCustomTable parameters: - $ref: '#/components/parameters/CustomTableIdPathParam' - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: Returns the updated custom table. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/CustomTable' 400: $ref: '#/components/responses/400BadRequest' 401: $ref: '#/components/responses/401Unauthorized' 404: $ref: '#/components/responses/404NotAuthorizedOrNotFound' 409: $ref: '#/components/responses/409Conflict' 412: $ref: '#/components/responses/412PreconditionFailed' 429: $ref: '#/components/responses/429TooManyRequests' 500: $ref: '#/components/responses/500InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: Update a custom table. tags: - usageapi x-example: "PUT /20200107/customTables/<customTableId>\nHost: usageapi.us-ashburn-1.oci.oraclecloud.com\nauthorization: <authorization and other headers>\n{\n \"savedCustomTable\": {\n \"displayName\": \"name1\",\n \"rowGroupBy\": [\n \"string\"\n ],\n \"columnGroupBy\": [\n \"string\"\n ],\n \"groupByTag\": null,\n \"compartmentDepth\": 1,\n \"version\": 1\n }\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateCustomTableDetails' description: The information to be updated. required: true /queries: get: description: 'Returns the saved query list. ' operationId: ListQueries parameters: - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' responses: 200: description: The saved queries list. headers: opc-next-page: description: 'For pagination of a list of Queries. If this header appears in the response, then this is a partial list of Queries. Include this value as the `page` parameter in a subsequent GET request, to get the next batch of Queries. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/QueryCollection' 400: $ref: '#/components/responses/400BadRequest' 401: $ref: '#/components/responses/401Unauthorized' 404: $ref: '#/components/responses/404NotAuthorizedOrNotFound' 412: $ref: '#/components/responses/412PreconditionFailed' 429: $ref: '#/components/responses/429TooManyRequests' 500: $ref: '#/components/responses/500InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: Returns saved queries and UI properties. tags: - usageapi x-related-resource: '#/definitions/Query' post: description: 'Returns the created query. ' operationId: CreateQuery parameters: - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: Returns the query ID/name. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Query' 400: $ref: '#/components/responses/400BadRequest' 401: $ref: '#/components/responses/401Unauthorized' 404: $ref: '#/components/responses/404NotAuthorizedOrNotFound' 412: $ref: '#/components/responses/412PreconditionFailed' 429: $ref: '#/components/responses/429TooManyRequests' 500: $ref: '#/components/responses/500InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: Create a query. tags: - usageapi requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateQueryDetails' description: New query details. Up to ten saved queries. required: true /queries/{queryId}: delete: description: 'Delete a saved query by the OCID. ' operationId: DeleteQuery parameters: - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/QueryIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 204: description: The Query was successfully deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400BadRequest' 401: $ref: '#/components/responses/401Unauthorized' 404: $ref: '#/components/responses/404NotAuthorizedOrNotFound' 412: $ref: '#/components/responses/412PreconditionFailed' 429: $ref: '#/components/responses/429TooManyRequests' 500: $ref: '#/components/responses/500InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: Delete a query. tags: - usageapi x-related-resource: '#/definitions/Query' get: description: 'Returns the saved query. ' operationId: GetQuery parameters: - $ref: '#/components/parameters/QueryIdPathParam' - $ref: '#/components/parameters/OpcRequestIdHeaderParam' responses: 200: description: The saved query. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Query' 400: $ref: '#/components/responses/400BadRequest' 401: $ref: '#/components/responses/401Unauthorized' 404: $ref: '#/components/responses/404NotAuthorizedOrNotFound' 412: $ref: '#/components/responses/412PreconditionFailed' 429: $ref: '#/components/responses/429TooManyRequests' 500: $ref: '#/components/responses/500InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: Returns saved query. tags: - usageapi x-related-resource: '#/definitions/Query' put: description: 'Update a saved query by the OCID. ' operationId: UpdateQuery parameters: - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/QueryIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: Returns the updated query. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Query' 400: $ref: '#/components/responses/400BadRequest' 401: $ref: '#/components/responses/401Unauthorized' 404: $ref: '#/components/responses/404NotAuthorizedOrNotFound' 412: $ref: '#/components/responses/412PreconditionFailed' 429: $ref: '#/components/responses/429TooManyRequests' 500: $ref: '#/components/responses/500InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: Update a query. tags: - usageapi requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateQueryDetails' description: The information to be updated. required: true /scheduledRuns: get: description: 'Returns the schedule history list. ' operationId: ListScheduledRuns parameters: - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/ScheduleIdQueryParam' - $ref: '#/components/parameters/ScheduledRunSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' responses: 200: description: Returns the schedule past runs list. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ScheduledRunCollection' 400: $ref: '#/components/responses/400BadRequest' 401: $ref: '#/components/responses/401Unauthorized' 404: $ref: '#/components/responses/404NotAuthorizedOrNotFound' 412: $ref: '#/components/responses/412PreconditionFailed' 429: $ref: '#/components/responses/429TooManyRequests' 500: $ref: '#/components/responses/500InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: Returns schedule history list. tags: - usageapi x-related-resource: '#/definitions/ScheduledRun' /scheduledRuns/{scheduledRunId}: get: description: 'Returns the saved schedule run. ' operationId: GetScheduledRun parameters: - $ref: '#/components/parameters/ScheduledRunIdPathParam' - $ref: '#/components/parameters/OpcRequestIdHeaderParam' responses: 200: description: The saved scheduled run. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ScheduledRun' 400: $ref: '#/components/responses/400BadRequest' 401: $ref: '#/components/responses/401Unauthorized' 404: $ref: '#/components/responses/404NotAuthorizedOrNotFound' 429: $ref: '#/components/responses/429TooManyRequests' 500: $ref: '#/components/responses/500InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: Returns saved schedule run. tags: - usageapi x-related-resource: '#/definitions/ScheduledRun' /schedules: get: description: 'Returns the saved schedule list. ' operationId: ListSchedules parameters: - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/ScheduleSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/NameQueryParam' responses: 200: description: The saved schedule list. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ScheduleCollection' 400: $ref: '#/components/responses/400BadRequest' 401: $ref: '#/components/responses/401Unauthorized' 404: $ref: '#/components/responses/404NotAuthorizedOrNotFound' 412: $ref: '#/components/responses/412PreconditionFailed' 429: $ref: '#/components/responses/429TooManyRequests' 500: $ref: '#/components/responses/500InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: Returns the saved schedule list. tags: - usageapi x-related-resource: '#/definitions/Schedule' post: description: 'Returns the created schedule. ' operationId: CreateSchedule parameters: - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: Returns the created scheduled report. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Schedule' 400: $ref: '#/components/responses/400BadRequest' 401: $ref: '#/components/responses/401Unauthorized' 404: $ref: '#/components/responses/404NotAuthorizedOrNotFound' 409: $ref: '#/components/responses/409Conflict' 412: $ref: '#/components/responses/412PreconditionFailed' 429: $ref: '#/components/responses/429TooManyRequests' 500: $ref: '#/components/responses/500InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: Create a schedule. tags: - usageapi requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateScheduleDetails' description: New schedule details. required: true /schedules/{scheduleId}: delete: description: 'Delete a saved scheduled report by the OCID. ' operationId: DeleteSchedule parameters: - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/ScheduleIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 204: description: The schedule was successfully deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400BadRequest' 401: $ref: '#/components/responses/401Unauthorized' 404: $ref: '#/components/responses/404NotAuthorizedOrNotFound' 409: $ref: '#/components/responses/409Conflict' 412: $ref: '#/components/responses/412PreconditionFailed' 429: $ref: '#/components/responses/429TooManyRequests' 500: $ref: '#/components/responses/500InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: Delete a schedule. tags: - usageapi x-related-resource: '#/definitions/Schedule' get: description: 'Returns the saved schedule. ' operationId: GetSchedule parameters: - $ref: '#/components/parameters/ScheduleIdPathParam' - $ref: '#/components/parameters/OpcRequestIdHeaderParam' responses: 200: description: The saved schedule. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Schedule' 400: $ref: '#/components/responses/400BadRequest' 401: $ref: '#/components/responses/401Unauthorized' 404: $ref: '#/components/responses/404NotAuthorizedOrNotFound' 429: $ref: '#/components/responses/429TooManyRequests' 500: $ref: '#/components/responses/500InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: Returns saved schedule. tags: - usageapi x-related-resource: '#/definitions/Schedule' put: description: 'Update a saved schedule. ' operationId: UpdateSchedule parameters: - $ref: '#/components/parameters/ScheduleIdPathParam' - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: Returns the updated schedule. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Schedule' 400: $ref: '#/components/responses/400BadRequest' 401: $ref: '#/components/responses/401Unauthorized' 404: $ref: '#/components/responses/404NotAuthorizedOrNotFound' 409: $ref: '#/components/responses/409Conflict' 412: $ref: '#/components/responses/412PreconditionFailed' 429: $ref: '#/components/responses/429TooManyRequests' 500: $ref: '#/components/responses/500InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: Update schedule. tags: - usageapi requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateScheduleDetails' description: The information to be updated. Currently supports only tags. required: true /usage: post: description: 'Returns usage for the given account. ' operationId: RequestSummarizedUsages parameters: - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' responses: 200: description: A usage list with the given groupBy information. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/UsageAggregation' 400: $ref: '#/components/responses/400BadRequest' 401: $ref: '#/components/responses/401Unauthorized' 404: $ref: '#/components/responses/404NotAuthorizedOrNotFound' 412: $ref: '#/components/responses/412PreconditionFailed' 429: $ref: '#/components/responses/429TooManyRequests' 500: $ref: '#/components/responses/500InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: Returns usage for the given account. tags: - usageapi x-related-resource: '#/definitions/UsageSummary' requestBody: content: application/json: schema: $ref: '#/components/schemas/RequestSummarizedUsagesDetails' description: 'getUsageRequest contains query inforamtion. ' required: true /usageCarbonEmissions: post: description: 'Returns carbon emission usage for the given account. ' operationId: RequestUsageCarbonEmissions parameters: - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' responses: 200: description: A carbon emission usage list with the given groupBy information. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/UsageCarbonEmissionAggregation' 400: $ref: '#/components/responses/400BadRequest' 401: $ref: '#/components/responses/401Unauthorized' 404: $ref: '#/components/responses/404NotAuthorizedOrNotFound' 412: $ref: '#/components/responses/412PreconditionFailed' 429: $ref: '#/components/responses/429TooManyRequests' 500: $ref: '#/components/responses/500InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: Returns usage carbon emission for the given account. tags: - usageapi x-related-resource: '#/definitions/UsageCarbonEmissionSummary' requestBody: content: application/json: schema: $ref: '#/components/schemas/RequestUsageCarbonEmissionsDetails' description: 'getUsageCarbonEmissionRequest contains query inforamtion. ' required: true /usageCarbonEmissionsConfig: get: description: 'Returns the configuration list for the Console''s carbon emission user interface drop-down list. ' operationId: RequestUsageCarbonEmissionConfig parameters: - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - description: tenant id in: query name: tenantId required: true schema: type: string maxLength: 255 minLength: 1 responses: 200: description: The configuration used for the Console's carbon emission drop-down list. The value is a list of available items. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ConfigurationAggregation' 400: $ref: '#/components/responses/400BadRequest' 401: $ref: '#/components/responses/401Unauthorized' 404: $ref: '#/components/responses/404NotAuthorizedOrNotFound' 412: $ref: '#/components/responses/412PreconditionFailed' 429: $ref: '#/components/responses/429TooManyRequests' 500: $ref: '#/components/responses/500InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: Returns usage carbon emission configurations. tags: - usageapi x-related-resource: '#/definitions/Configuration' /usageCarbonEmissionsQueries: get: description: 'Returns the carbon emissions usage saved query list. ' operationId: ListUsageCarbonEmissionsQueries parameters: - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' responses: 200: description: The carbon emissions usage saved queries list. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/UsageCarbonEmissionsQueryCollection' 400: $ref: '#/components/responses/400BadRequest' 401: $ref: '#/components/responses/401Unauthorized' 404: $ref: '#/components/responses/404NotAuthorizedOrNotFound' 412: $ref: '#/components/responses/412PreconditionFailed' 429: $ref: '#/components/responses/429TooManyRequests' 500: $ref: '#/components/responses/500InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: Returns usage carbon emissions saved queries and UI properties. tags: - usageapi x-related-resource: '#/definitions/UsageCarbonEmissionsQuery' post: description: 'Returns the created carbon emissions usage query. ' operationId: CreateUsageCarbonEmissionsQuery parameters: - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: Returns the query ID or name. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/UsageCarbonEmissionsQuery' 400: $ref: '#/components/responses/400BadRequest' 401: $ref: '#/components/responses/401Unauthorized' 404: $ref: '#/components/responses/404NotAuthorizedOrNotFound' 409: $ref: '#/components/responses/409Conflict' 412: $ref: '#/components/responses/412PreconditionFailed' 429: $ref: '#/components/responses/429TooManyRequests' 500: $ref: '#/components/responses/500InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: Create usage carbon emissions query. tags: - usageapi requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateUsageCarbonEmissionsQueryDetails' description: New query details. Up to ten saved queries. required: true /usageCarbonEmissionsQueries/{usageCarbonEmissionsQueryId}: delete: description: 'Delete a carbon emissions usage saved query by the OCID. ' operationId: DeleteUsageCarbonEmissionsQuery parameters: - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/UsageCarbonEmissionsQueryIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 204: description: The query was successfully deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400BadRequest' 401: $ref: '#/components/responses/401Unauthorized' 404: $ref: '#/components/responses/404NotAuthorizedOrNotFound' 412: $ref: '#/components/responses/412PreconditionFailed' 429: $ref: '#/components/responses/429TooManyRequests' 500: $ref: '#/components/responses/500InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: Delete a usage carbon emissions saved query. tags: - usageapi x-related-resource: '#/definitions/UsageCarbonEmissionsQuery' get: description: 'Returns the carbon emissions usage saved query. ' operationId: GetUsageCarbonEmissionsQuery parameters: - $ref: '#/components/parameters/UsageCarbonEmissionsQueryIdPathParam' - $ref: '#/components/parameters/OpcRequestIdHeaderParam' responses: 200: description: The carbon emissions usage saved query. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/UsageCarbonEmissionsQuery' 400: $ref: '#/components/responses/400BadRequest' 401: $ref: '#/components/responses/401Unauthorized' 404: $ref: '#/components/responses/404NotAuthorizedOrNotFound' 412: $ref: '#/components/responses/412PreconditionFailed' 429: $ref: '#/components/responses/429TooManyRequests' 500: $ref: '#/components/responses/500InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: Returns usage carbon emissions saved query. tags: - usageapi x-related-resource: '#/definitions/UsageCarbonEmissionsQuery' put: description: 'Update a carbon emissions usage saved query by the OCID. ' operationId: UpdateUsageCarbonEmissionsQuery parameters: - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/UsageCarbonEmissionsQueryIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: Returns the updated carbon emissions usage saved query. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/UsageCarbonEmissionsQuery' 400: $ref: '#/components/responses/400BadRequest' 401: $ref: '#/components/responses/401Unauthorized' 404: $ref: '#/components/responses/404NotAuthorizedOrNotFound' 412: $ref: '#/components/responses/412PreconditionFailed' 429: $ref: '#/components/responses/429TooManyRequests' 500: $ref: '#/components/responses/500InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: Update usage carbon emissions saved query. tags: - usageapi requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateUsageCarbonEmissionsQueryDetails' description: The information to be updated. required: true /usageStatements/{subscriptionId}/emailRecipientsGroups: get: description: 'Returns the saved usage statement email recipients group. ' operationId: ListEmailRecipientsGroups parameters: - $ref: '#/components/parameters/SubscriptionIdPathParam' - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' responses: 200: description: The usage statement email recipients group list. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/EmailRecipientsGroupCollection' 400: $ref: '#/components/responses/400BadRequest' 401: $ref: '#/components/responses/401Unauthorized' 404: $ref: '#/components/responses/404NotAuthorizedOrNotFound' 409: $ref: '#/components/responses/409Conflict' 412: $ref: '#/components/responses/412PreconditionFailed' 429: $ref: '#/components/responses/429TooManyRequests' 500: $ref: '#/components/responses/500InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: Return the usage statement email recipients groups for this tenancy. tags: - usageapi x-related-resource: '#/definitions/EmailRecipientsGroup' post: description: 'Creates a list of email recipients that can receive usage statements for the subscription. ' operationId: CreateEmailRecipientsGroup parameters: - $ref: '#/components/parameters/SubscriptionIdPathParam' - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: 'Returns the created email recipients group. ' headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/EmailRecipientsGroup' 400: $ref: '#/components/responses/400BadRequest' 401: $ref: '#/components/responses/401Unauthorized' 404: $ref: '#/components/responses/404NotAuthorizedOrNotFound' 409: $ref: '#/components/responses/409Conflict' 412: $ref: '#/components/responses/412PreconditionFailed' 429: $ref: '#/components/responses/429TooManyRequests' 500: $ref: '#/components/responses/500InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: Create an email recipient group to receive usage statements for the subscription. tags: - usageapi x-related-resource: '#/definitions/EmailRecipientsGroup' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateEmailRecipientsGroupDetails' description: New email recipients group details. required: true /usageStatements/{subscriptionId}/emailRecipientsGroups/{emailRecipientsGroupId}: delete: description: 'Deletes the email recipients group for the usage statement subscription. ' operationId: DeleteEmailRecipientsGroup parameters: - $ref: '#/components/parameters/EmailRecipientsGroupIdPathParam' - $ref: '#/components/parameters/SubscriptionIdPathParam' - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/CompartmentIdQueryParam' responses: 204: description: 'The email recipients group was successfully deleted. ' headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400BadRequest' 401: $ref: '#/components/responses/401Unauthorized' 404: $ref: '#/components/responses/404NotAuthorizedOrNotFound' 409: $ref: '#/components/responses/409Conflict' 412: $ref: '#/components/responses/412PreconditionFailed' 429: $ref: '#/components/responses/429TooManyRequests' 500: $ref: '#/components/responses/500InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: delete the email recipients group for the usage statement subscription. tags: - usageapi x-related-resource: '#/definitions/EmailRecipientsGroup' get: description: 'Returns the saved usage statement email recipients group. ' operationId: GetEmailRecipientsGroup parameters: - $ref: '#/components/parameters/EmailRecipientsGroupIdPathParam' - $ref: '#/components/parameters/SubscriptionIdPathParam' - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' responses: 200: description: The saved email recipients group. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/EmailRecipientsGroup' 400: $ref: '#/components/responses/400BadRequest' 401: $ref: '#/components/responses/401Unauthorized' 404: $ref: '#/components/responses/404NotAuthorizedOrNotFound' 429: $ref: '#/components/responses/429TooManyRequests' 500: $ref: '#/components/responses/500InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: Return the saved usage statement email recipients group details. tags: - usageapi x-related-resource: '#/definitions/EmailRecipientsGroup' put: description: 'Updates a saved email recipients group. ' operationId: UpdateEmailRecipientsGroup parameters: - $ref: '#/components/parameters/EmailRecipientsGroupIdPathParam' - $ref: '#/components/parameters/SubscriptionIdPathParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: Returns the updated email recipients group. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/EmailRecipientsGroup' 400: $ref: '#/components/responses/400BadRequest' 401: $ref: '#/components/responses/401Unauthorized' 404: $ref: '#/components/responses/404NotAuthorizedOrNotFound' 409: $ref: '#/components/responses/409Conflict' 412: $ref: '#/components/responses/412PreconditionFailed' 429: $ref: '#/components/responses/429TooManyRequests' 500: $ref: '#/components/responses/500InternalServerError' default: $ref: '#/components/responses/DefaultError' summary: Update email recipients group. tags: - usageapi x-related-resource: '#/definitions/EmailRecipientsGroup' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateEmailRecipientsGroupDetails' description: The information to be updated. required: true components: schemas: ScheduleSummary: description: Schedule summary for the list schedule. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: The description of the schedule. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}` ' type: object id: description: The schedule OCID. type: string lifecycleState: description: The schedule summary lifecycle state. type: string x-obmcs-enumref: '#/definitions/Schedule/lifecycleState' name: description: The unique name of the user-created schedule. type: string scheduleRecurrences: description: 'Specifies the frequency according to when the schedule will be run, in the x-obmcs-recurring-time format described in [RFC 5545 section 3.3.10](https://datatracker.ietf.org/doc/html/rfc5545#section-3.3.10). Supported values are : ONETIME, DAILY, WEEKLY and MONTHLY. ' format: x-obmcs-recurring-time type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeNextRun: description: The date and time of the next job execution. format: date-time type: string timeScheduled: description: The date and time of the first time job execution. format: date-time type: string required: - id - name - scheduleRecurrences - timeScheduled - lifecycleState type: object Configuration: description: A configuration. properties: key: description: The configuration key. type: string values: description: The configuration value. items: type: string type: array required: - key Dimension: description: 'The dimension used for filtering. Availabe dimensions are: "service", "skuName", "skuPartNumber", "unit", "compartmentName", "compartmentPath", "compartmentId", "platform", "region", "logicalAd", "resourceId", "tenantId", and "tenantName". For example: `[{value: "COMPUTE", key: "service"}]` ' properties: key: description: The dimension key. type: string value: description: The dimension value. type: string required: - key - value type: object Error: description: Erorr details. properties: code: description: 'A short error code that defines the error, meant for programmatic parsing. See [API Errors](/Content/API/References/apierrors.htm). ' type: string message: description: A human-readable error string. type: string required: - code - message CustomTableCollection: description: A custom table list. properties: items: description: Custom tables list. items: $ref: '#/components/schemas/CustomTableSummary' type: array required: - items CleanEnergyUsage: description: Clean energy usage. properties: ad: description: The availability domain. type: string region: description: The region. type: string usage: description: The percentage of clean enery used. format: double type: number required: - region - usage UsageCarbonEmissionSummary: description: The carbon emission usage store result. properties: ad: description: The availability domain of the usage. type: string compartmentId: description: The compartment OCID. type: string compartmentName: description: The compartment name. type: string compartmentPath: description: The compartment path, starting from root. type: string computedCarbonEmission: description: The carbon emission usage in MTCO2 units. format: double type: number emissionCalculationMethod: description: Specifies the carbon emissions calculation method. Both SPEND_BASED (based on expenditure data) and POWER_BASED (based on power consumption) are supported. type: string emissionType: default: MARKET_BASED description: The emission type, whether MARKET_BASED or LOCATION_BASED. type: string x-obmcs-enumref: '#/definitions/RequestUsageCarbonEmissionsDetails/emissionType' platform: description: Platform for the cost. type: string region: description: The region of the usage. type: string resourceId: description: The resource OCID that is incurring the cost. type: string resourceName: description: The resource name that is incurring the cost. type: string service: description: The service name that is incurring the cost. type: string skuName: description: The SKU friendly name. type: string skuPartNumber: description: The SKU part number. type: string subscriptionId: description: The subscription ID. type: string tags: description: For grouping, a tag definition. For filtering, a definition and key. items: $ref: '#/components/schemas/Tag' maxItems: 1000 type: array tenantId: description: The tenancy OCID. type: string tenantName: description: The tenancy name. type: string timeUsageEnded: description: The usage end time. format: date-time type: string timeUsageStarted: description: The usage start time. format: date-time type: string required: - timeUsageStarted - timeUsageEnded - computedCarbonEmission - emissionCalculationMethod type: object ScheduledRunCollection: description: The schedule past run list. properties: items: description: The schedule past run list. items: $ref: '#/components/schemas/ScheduledRunSummary' type: array required: - items ResultLocation: description: 'The location where usage or cost CSVs will be uploaded defined by `locationType`, which corresponds with type-specific characteristics. ' discriminator: propertyName: locationType properties: locationType: description: 'Defines the type of location where the usage or cost CSVs will be stored. ' enum: - OBJECT_STORAGE type: string required: - locationType UsageCarbonEmissionsQuery: description: The carbon emissions usage saved query to filter and aggregate. properties: compartmentId: description: The compartment OCID. type: string id: description: The query OCID. type: string queryDefinition: $ref: '#/components/schemas/UsageCarbonEmissionsQueryDefinition' required: - id - compartmentId - queryDefinition UsageSummary: description: The usage store result. properties: ad: description: The availability domain of the usage. type: string attributedCost: description: The attributed cost with a maximum value of 9999999999.999999999999 and a minimum value of 0. pattern: ^\d{1,10}\.\d{0,12}$ type: string attributedUsage: description: The attributed usage with a maximum value of 9999999999.999999999999 and a minimum value of 0. pattern: ^\d{1,10}\.\d{0,12}$ type: string compartmentId: description: The compartment OCID. type: string compartmentName: description: The compartment name. type: string compartmentPath: description: The compartment path, starting from root. type: string computedAmount: description: The computed cost. type: number computedQuantity: description: The usage number. type: number currency: description: The price currency. type: string discount: description: The discretionary discount applied to the SKU. type: number isForecast: description: The forecasted data. type: boolean listRate: description: The SKU list rate (not discount). type: number overage: description: The overage usage. type: string overagesFlag: description: The SPM OverageFlag. type: string platform: description: Platform for the cost. type: string region: description: The region of the usage. type: string resourceId: description: The resource OCID that is incurring the cost. type: string resourceName: description: The resource name that is incurring the cost. type: string service: description: The service name that is incurring the cost. type: string shape: description: The resource shape. type: string skuName: description: The SKU friendly name. type: string skuPartNumber: description: The SKU part number. type: string subscriptionId: description: The subscription ID. type: string tags: description: For grouping, a tag definition. For filtering, a definition and key. items: $ref: '#/components/schemas/Tag' type: array tenantId: description: The tenancy OCID. type: string tenantName: description: The tenancy name. type: string timeUsageEnded: description: The usage end time. format: date-time type: string timeUsageStarted: description: The usage start time. format: date-time type: string unit: description: The usage unit. type: string unitPrice: description: The price per unit. type: number weight: description: The resource size being metered. type: number required: - timeUsageStarted - timeUsageEnded type: object DateRange: description: 'Static or dynamic date range `dateRangeType`, which corresponds with type-specific characteristics. ' discriminator: propertyName: dateRangeType properties: dateRangeType: description: Defines whether the schedule date range is STATIC or DYNAMIC. enum: - STATIC - DYNAMIC type: string required: - dateRangeType CustomTableSummary: description: Custom table in the list request. properties: id: description: The custom table OCID. maxLength: 250 minLength: 1 type: string savedCustomTable: $ref: '#/components/schemas/SavedCustomTable' required: - id - savedCustomTable Filter: description: The filter object for query usage. properties: dimensions: description: The dimensions to filter on. items: $ref: '#/components/schemas/Dimension' type: array filters: description: The nested filter object. items: $ref: '#/components/schemas/Filter' type: array operator: description: 'The filter operator. Example: ''AND'', ''OR'', ''NOT''.' enum: - AND - NOT - OR type: string tags: description: The tags to filter on. items: $ref: '#/components/schemas/Tag' type: array type: object UsageCarbonEmissionsReportQuery: description: The request of the generated carbon emissions usage report. properties: compartmentDepth: description: The compartment depth level. maximum: 7 minimum: 1 type: integer dateRangeName: description: The user interface date range, for example, LAST_THREE_MONTHS. Overrides the timeUsageStarted and timeUsageEnded properties. enum: - LAST_TWO_MONTHS - LAST_THREE_MONTHS - LAST_SIX_MONTHS - LAST_ONE_YEAR - CUSTOM type: string emissionCalculationMethod: default: SPEND_BASED description: Specifies the emission calculation method, whether POWER_BASED or SPEND_BASED. type: string x-obmcs-enumref: '#/definitions/RequestUsageCarbonEmissionsDetails/emissionCalculationMethod' emissionType: default: MARKET_BASED description: Specifies the emission type, whether MARKET_BASED or LOCATION_BASED. type: string x-obmcs-enumref: '#/definitions/RequestUsageCarbonEmissionsDetails/emissionType' filter: $ref: '#/components/schemas/Filter' granularity: default: MONTHLY description: The carbon emission granularity. DAILY - Daily data aggregation. MONTHLY - Monthly data aggregation. type: string x-obmcs-enumref: '#/definitions/RequestUsageCarbonEmissionsDetails/granularity' groupBy: description: "Specifies what to aggregate the result by.\nFor example:\n `[\"tagNamespace\", \"tagKey\", \"tagValue\", \"service\", \"skuName\", \"skuPartNumber\", \"unit\",\n \"compartmentName\", \"compartmentPath\", \"compartmentId\", \"platform\", \"region\", \"logicalAd\",\n \"resourceId\", \"tenantId\", \"tenantName\"]`\n" items: type: string maxItems: 4 type: array groupByTag: description: "GroupBy a specific tagKey. Provide the tagNamespace and tagKey in the tag object. Only supports one tag in the list.\nFor example:\n `[{\"namespace\":\"oracle\", \"key\":\"createdBy\"]`\n" items: $ref: '#/components/schemas/Tag' type: array isAggregateByTime: default: false description: Specifies whether aggregated by time. If isAggregateByTime is true, all usage or costs over the query time period are summed. type: boolean tenantId: description: Tenant ID. maxLength: 255 minLength: 1 type: string timeUsageEnded: description: The usage end time. format: date-time type: string timeUsageStarted: description: The usage start time. format: date-time type: string required: - tenantId RequestUsageCarbonEmissionsDetails: description: Details for the '/usageCarbonEmissions' query. properties: compartmentDepth: description: The compartment depth level. maximum: 7 minimum: 1 type: integer emissionCalculationMethod: default: SPEND_BASED description: Specifies the emission calculation method, whether POWER_BASED or SPEND_BASED. enum: - SPEND_BASED - POWER_BASED type: string emissionType: default: MARKET_BASED description: Specifies the emission type, whether MARKET_BASED or LOCATION_BASED. enum: - MARKET_BASED - LOCATION_BASED type: string filter: $ref: '#/components/schemas/Filter' granularity: default: MONTHLY description: The carbon emission granularity. DAILY - Daily data aggregation. MONTHLY - Monthly data aggregation. enum: - DAILY - MONTHLY type: string groupBy: description: "Aggregate the result by.\nFor example:\n `[\"tagNamespace\", \"tagKey\", \"tagValue\", \"service\", \"skuName\", \"skuPartNumber\", \"unit\",\n \"compartmentName\", \"compartmentPath\", \"compartmentId\", \"platform\", \"region\", \"logicalAd\",\n \"resourceId\", \"resourceName\", \"tenantId\", \"tenantName\", \"subscriptionId\"]`\n" items: type: string maxItems: 4 type: array groupByTag: description: "GroupBy a specific tagKey. Provide the tagNamespace and tagKey in the tag object. Only supports one tag in the list.\nFor example:\n `[{\"namespace\":\"oracle\", \"key\":\"createdBy\"]`\n" items: $ref: '#/components/schemas/Tag' type: array isAggregateByTime: default: false description: Specifies whether aggregated by time. If isAggregateByTime is true, all carbon emissions usage over the query time period are summed. type: boolean tenantId: description: Tenant ID. maxLength: 255 minLength: 1 type: string timeUsageEnded: description: The usage end time. format: date-time type: string timeUsageStarted: description: The usage start time. format: date-time type: string required: - tenantId - timeUsageStarted - timeUsageEnded QuerySummary: description: Query summery in the list request. properties: id: description: The query OCID. type: string queryDefinition: $ref: '#/components/schemas/QueryDefinition' required: - id - queryDefinition EmailRecipientsGroupCollection: description: The email recipients group collection. properties: items: description: The email recipients group list. items: $ref: '#/components/schemas/EmailRecipientsGroupSummary' type: array required: - items Schedule: description: The schedule. properties: compartmentId: description: The customer tenancy. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: The description of the schedule. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}` ' type: object id: description: The OCID representing a unique shedule. type: string lifecycleState: description: The schedule lifecycle state. enum: - ACTIVE - INACTIVE type: string name: description: The unique name of the schedule created by the user. format: x-obmcs-ascii-identifier maxLength: 255 minLength: 1 type: string outputFileFormat: default: CSV description: Specifies the supported output file format. enum: - CSV - PDF type: string queryProperties: $ref: '#/components/schemas/QueryProperties' resultLocation: $ref: '#/components/schemas/ResultLocation' savedReportId: description: The saved report ID which can also be used to generate a query. type: string scheduleRecurrences: description: 'Specifies the frequency according to when the schedule will be run, in the x-obmcs-recurring-time format described in [RFC 5545 section 3.3.10](https://datatracker.ietf.org/doc/html/rfc5545#section-3.3.10). Supported values are : ONETIME, DAILY, WEEKLY and MONTHLY. ' format: x-obmcs-recurring-time type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The date and time the schedule was created. format: date-time type: string timeNextRun: description: The date and time of the next job execution. format: date-time type: string timeScheduled: description: The date and time of the first time job execution. format: date-time type: string required: - id - name - compartmentId - resultLocation - scheduleRecurrences - timeScheduled - timeCreated - lifecycleState type: object UsageCarbonEmissionsQueryDefinition: description: The common fields for queries. properties: costAnalysisUI: $ref: '#/components/schemas/CostAnalysisUI' displayName: description: The query display name. Avoid entering confidential information. maxLength: 40 minLength: 1 type: string reportQuery: $ref: '#/components/schemas/UsageCarbonEmissionsReportQuery' version: description: The saved query version. maximum: 10000 minimum: 1 type: integer required: - displayName - reportQuery - costAnalysisUI - version Query: description: The query to filter and aggregate. properties: compartmentId: description: The compartment OCID. type: string id: description: The query OCID. type: string queryDefinition: $ref: '#/components/schemas/QueryDefinition' required: - id - compartmentId - queryDefinition EmailRecipientsGroup: description: The recipients group to receive usage statement emails. properties: compartmentId: description: The customer tenancy OCID. maxLength: 255 minLength: 1 type: string id: description: The usage statement email recipients group OCID. maxLength: 255 minLength: 1 type: string lifecycleState: description: The email recipients group lifecycle state. enum: - ACTIVE - INACTIVE type: string recipientsList: description: The list of recipients that will receive usage statement emails. items: $ref: '#/components/schemas/EmailRecipient' maxItems: 10 type: array required: - id - compartmentId - recipientsList - lifecycleState type: object ConfigurationAggregation: description: The available configurations. properties: items: description: The list of available configurations. items: $ref: '#/components/schemas/Configuration' type: array required: - items CreateQueryDetails: description: New query detail with savedRequestSummarizedUsagesDetails, savedCostAnalysisUI, and displayName. properties: compartmentId: description: The compartment OCID. type: string queryDefinition: $ref: '#/components/schemas/QueryDefinition' required: - compartmentId - queryDefinition Forecast: description: Forecast configuration of usage or cost. properties: forecastType: default: BASIC description: 'BASIC uses the exponential smoothing (ETS) model to project future usage or costs based on history data. The basis for projections is a periodic set of equivalent historical days for which the projection is being made. ' enum: - BASIC type: string timeForecastEnded: description: The forecast end time. format: date-time type: string timeForecastStarted: description: 'The forecast start time. Defaults to UTC-1 if not specified. ' format: date-time type: string required: - timeForecastEnded type: object ScheduledRunSummary: description: The saved history past run. properties: id: description: The OCID representing a unique shedule run. type: string lifecycleDetails: description: Additional details about the scheduled run. type: string lifecycleState: description: Specifies whether or not the schedule job was successfully run. type: string x-obmcs-enumref: '#/definitions/ScheduledRun/lifecycleState' scheduleId: description: The OCID representing a unique shedule. type: string timeCreated: description: The time the schedule started executing. format: date-time type: string timeFinished: description: The time the schedule finished executing. format: date-time type: string required: - id - scheduleId - timeCreated - timeFinished - lifecycleState - lifecycleDetails UpdateUsageCarbonEmissionsQueryDetails: description: Details for the query to update usageCarbonEmissionsQuery, costAnalysisUI, and displayName. properties: queryDefinition: $ref: '#/components/schemas/UsageCarbonEmissionsQueryDefinition' required: - queryDefinition ScheduledRun: description: The saved schedule run. properties: id: description: The OCID representing a unique shedule run. type: string lifecycleDetails: description: Additional details about the scheduled run. type: string lifecycleState: description: Specifies whether or not the schedule job was successfully run. enum: - FAILED - SUCCEEDED type: string scheduleId: description: The OCID representing a unique shedule. type: string timeCreated: description: The time the schedule started executing. format: date-time type: string timeFinished: description: The time the schedule finished executing. format: date-time type: string required: - id - scheduleId - timeCreated - timeFinished - lifecycleState - lifecycleDetails RequestSummarizedUsagesDetails: description: Details for the '/usage' query. properties: compartmentDepth: description: The compartment depth level. maximum: 7 minimum: 1 type: number filter: $ref: '#/components/schemas/Filter' forecast: $ref: '#/components/schemas/Forecast' granularity: description: 'The usage granularity. HOURLY - Hourly data aggregation. DAILY - Daily data aggregation. MONTHLY - Monthly data aggregation. TOTAL - Not yet supported. ' enum: - HOURLY - DAILY - MONTHLY - TOTAL type: string groupBy: description: "Aggregate the result by.\nFor example:\n `[\"tagNamespace\", \"tagKey\", \"tagValue\", \"service\", \"skuName\", \"skuPartNumber\", \"unit\",\n \"compartmentName\", \"compartmentPath\", \"compartmentId\", \"platform\", \"region\", \"logicalAd\",\n \"resourceId\", \"tenantId\", \"tenantName\"]`\n" items: type: string maxItems: 4 type: array groupByTag: description: "GroupBy a specific tagKey. Provide the tagNamespace and tagKey in the tag object. Only supports one tag in the list.\nFor example:\n `[{\"namespace\":\"oracle\", \"key\":\"createdBy\"]`\n" items: $ref: '#/components/schemas/Tag' type: array isAggregateByTime: default: false description: Specifies whether aggregated by time. If isAggregateByTime is true, all usage or cost over the query time period will be added up. type: boolean queryType: description: '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. Overage - Query the overage cost of a non-metered subscription. Usage_Only - Query the only usage data without cost or currency. ' enum: - USAGE - COST - CREDIT - EXPIREDCREDIT - ALLCREDIT - OVERAGE - USAGE_ONLY type: string tenantId: description: Tenant ID. maxLength: 255 minLength: 1 type: string timeUsageEnded: description: The usage end time. format: date-time type: string timeUsageStarted: description: The usage start time. format: date-time type: string required: - tenantId - timeUsageStarted - timeUsageEnded - granularity EmailRecipient: description: The email recipient to receive usage statements for the subscription. properties: emailId: description: The recipient email address. type: string firstName: description: The recipient first name. type: string lastName: description: The recipient last name. type: string lifecycleState: description: The email recipient lifecycle state. enum: - ACTIVE - INACTIVE type: string required: - emailId - lifecycleState UpdateCustomTableDetails: description: Details for updating the custom table. properties: savedCustomTable: $ref: '#/components/schemas/SavedCustomTable' required: - savedCustomTable CreateScheduleDetails: description: The saved schedule. properties: compartmentId: description: The customer tenancy. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: The description of the schedule. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}` ' type: object name: description: The unique name of the user-created schedule. format: x-obmcs-ascii-identifier maxLength: 255 minLength: 1 type: string outputFileFormat: default: CSV description: Specifies the supported output file format. enum: - CSV - PDF type: string queryProperties: $ref: '#/components/schemas/QueryProperties' resultLocation: $ref: '#/components/schemas/ResultLocation' savedReportId: description: The saved report ID which can also be used to generate a query. type: string scheduleRecurrences: description: 'Specifies the frequency according to when the schedule will be run, in the x-obmcs-recurring-time format described in [RFC 5545 section 3.3.10](https://datatracker.ietf.org/doc/html/rfc5545#section-3.3.10). Supported values are : ONETIME, DAILY, WEEKLY and MONTHLY. ' format: x-obmcs-recurring-time type: string timeScheduled: description: The date and time of the first time job execution. format: date-time type: string required: - name - compartmentId - resultLocation - scheduleRecurrences - timeScheduled UsageCarbonEmissionsQuerySummary: description: The carbon emissions usage query summary in the list request. properties: id: description: The query OCID. type: string queryDefinition: $ref: '#/components/schemas/UsageCarbonEmissionsQueryDefinition' required: - id - queryDefinition UpdateScheduleDetails: description: 'Details for updating the custom table. ' properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: The description of the schedule. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}` ' type: object outputFileFormat: default: CSV description: Specifies the supported output file format. enum: - CSV - PDF type: string resultLocation: $ref: '#/components/schemas/ResultLocation' QueryProperties: description: The query properties. properties: compartmentDepth: description: The depth level of the compartment. maximum: 7 minimum: 1 type: number dateRange: $ref: '#/components/schemas/DateRange' filter: $ref: '#/components/schemas/Filter' granularity: description: "The usage granularity. DAILY - Daily data aggregation. MONTHLY - Monthly data aggregation.\nAllowed values are:\n DAILY\n MONTHLY\n" enum: - DAILY - MONTHLY type: string groupBy: description: 'Aggregate the result by. For example: [ "tagNamespace", "tagKey", "tagValue", "service", "skuName", "skuPartNumber", "unit", "compartmentName", "compartmentPath", "compartmentId", "platform", "region", "logicalAd", "resourceId", "tenantId", "tenantName" ] ' items: type: string maxItems: 4 type: array groupByTag: description: '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" ] ' items: $ref: '#/components/schemas/Tag' type: array isAggregateByTime: default: false description: Specifies whether aggregated by time. If isAggregateByTime is true, all usage or cost over the query time period will be added up. type: boolean queryType: default: COST description: "The query usage type. COST by default if it is missing. Usage - Query the usage data. Cost - Query the cost/billing data.\nAllowed values are:\n USAGE\n COST\n USAGE_AND_COST\n" enum: - USAGE - COST - USAGE_AND_COST type: string required: - granularity - dateRange CustomTable: description: The saved custom table. properties: compartmentId: description: The custom table compartment OCID. maxLength: 250 minLength: 1 type: string id: description: The custom table OCID. maxLength: 250 minLength: 1 type: string savedCustomTable: $ref: '#/components/schemas/SavedCustomTable' savedReportId: description: The custom table associated saved report OCID. maxLength: 250 minLength: 1 type: string required: - id UpdateEmailRecipientsGroupDetails: description: 'The saved email recipient group to receive usage statement emails. ' properties: recipientsList: description: The list of recipients will receive usage statement emails. items: $ref: '#/components/schemas/EmailRecipient' maxItems: 10 type: array uniqueItems: true required: - recipientsList CreateEmailRecipientsGroupDetails: description: The saved email recipient group to receive usage statement emails. properties: compartmentId: description: The customer tenancy. maxLength: 255 minLength: 1 type: string recipientsList: description: The list of recipients that will receive usage statement emails. items: $ref: '#/components/schemas/EmailRecipient' maxItems: 10 type: array uniqueItems: true required: - compartmentId - recipientsList EmailRecipientsGroupSummary: description: The email recipients group summary for the recipients group list. properties: compartmentId: description: The customer tenancy. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}` ' type: object id: description: The usage statement email recipients group OCID. maxLength: 255 minLength: 1 type: string lifecycleState: description: The email recipients group lifecycle state. type: string x-obmcs-enumref: '#/definitions/EmailRecipientsGroup/lifecycleState' recipientsList: description: The list of recipients that will receive usage statement emails. items: $ref: '#/components/schemas/EmailRecipient' maxItems: 10 type: array systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object required: - id - compartmentId - recipientsList - lifecycleState QueryDefinition: description: The common fields for queries. properties: costAnalysisUI: $ref: '#/components/schemas/CostAnalysisUI' displayName: description: The query display name. Avoid entering confidential information. maxLength: 40 minLength: 1 type: string reportQuery: $ref: '#/components/schemas/ReportQuery' version: description: The saved query version. maximum: 10000 minimum: 1 type: number required: - displayName - reportQuery - costAnalysisUI - version UpdateQueryDetails: description: Details for the query to update reportQuery, costAnalysisUI, and displayName. properties: queryDefinition: $ref: '#/components/schemas/QueryDefinition' required: - queryDefinition AverageCarbonEmission: description: Average carbon emissions. properties: averageCarbonEmission: description: The average carbon emissions by SKU. format: double type: number skuPartNumber: description: The SKU part number. type: string required: - skuPartNumber - averageCarbonEmission UsageCarbonEmissionsQueryCollection: description: A carbon emissions usage query list. properties: items: description: Usage carbon emissions query list. items: $ref: '#/components/schemas/UsageCarbonEmissionsQuerySummary' type: array required: - items ReportQuery: description: The request of the generated Cost Analysis report. properties: compartmentDepth: description: The compartment depth level. maximum: 7 minimum: 1 type: number dateRangeName: description: The UI date range, for example, LAST_THREE_MONTHS. Conflicts with timeUsageStarted and timeUsageEnded. enum: - LAST_SEVEN_DAYS - LAST_TEN_DAYS - MTD - LAST_TWO_MONTHS - LAST_THREE_MONTHS - ALL - LAST_SIX_MONTHS - LAST_ONE_YEAR - YTD - CUSTOM type: string filter: $ref: '#/components/schemas/Filter' forecast: $ref: '#/components/schemas/Forecast' granularity: description: 'The usage granularity. HOURLY - Hourly data aggregation. DAILY - Daily data aggregation. MONTHLY - Monthly data aggregation. TOTAL - Not yet supported. ' enum: - HOURLY - DAILY - MONTHLY - TOTAL type: string groupBy: description: "Specifies what to aggregate the result by.\nFor example:\n `[\"tagNamespace\", \"tagKey\", \"tagValue\", \"service\", \"skuName\", \"skuPartNumber\", \"unit\",\n \"compartmentName\", \"compartmentPath\", \"compartmentId\", \"platform\", \"region\", \"logicalAd\",\n \"resourceId\", \"tenantId\", \"tenantName\"]`\n" items: type: string maxItems: 4 type: array groupByTag: description: "GroupBy a specific tagKey. Provide the tagNamespace and tagKey in the tag object. Only supports one tag in the list.\nFor example:\n `[{\"namespace\":\"oracle\", \"key\":\"createdBy\"]`\n" items: $ref: '#/components/schemas/Tag' type: array isAggregateByTime: default: false description: Specifies whether aggregated by time. If isAggregateByTime is true, all usage or cost over the query time period will be added up. type: boolean queryType: description: '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. ' enum: - USAGE - COST - CREDIT - EXPIREDCREDIT - ALLCREDIT type: string tenantId: description: Tenant ID. maxLength: 255 minLength: 1 type: string timeUsageEnded: description: The usage end time. format: date-time type: string timeUsageStarted: description: The usage start time. format: date-time type: string required: - tenantId - granularity CostAnalysisUI: description: The common fields for Cost Analysis UI rendering. properties: graph: description: The graph type. enum: - BARS - LINES - STACKED_LINES type: string isCumulativeGraph: description: A cumulative graph. type: boolean SavedCustomTable: description: The custom table for Cost Analysis UI rendering. properties: columnGroupBy: description: "The column groupBy key list.\nFor example:\n `[\"tagNamespace\", \"tagKey\", \"tagValue\", \"service\", \"skuName\", \"skuPartNumber\", \"unit\",\n \"compartmentName\", \"compartmentPath\", \"compartmentId\", \"platform\", \"region\", \"logicalAd\",\n \"resourceId\", \"tenantId\", \"tenantName\"]`\n" items: type: string maxItems: 4 type: array compartmentDepth: default: 1 description: The compartment depth level. maximum: 7 minimum: 1 type: number displayName: description: The name of the custom table. maxLength: 40 minLength: 1 type: string groupByTag: description: "GroupBy a specific tagKey. Provide the tagNamespace and tagKey in the tag object. Only one tag in the list is supported.\nFor example:\n `[{\"namespace\":\"oracle\", \"key\":\"createdBy\"]`\n" items: $ref: '#/components/schemas/Tag' type: array rowGroupBy: description: "The row groupBy key list.\nFor example:\n `[\"tagNamespace\", \"tagKey\", \"tagValue\", \"service\", \"skuName\", \"skuPartNumber\", \"unit\",\n \"compartmentName\", \"compartmentPath\", \"compartmentId\", \"platform\", \"region\", \"logicalAd\",\n \"resourceId\", \"tenantId\", \"tenantName\"]`\n" items: type: string maxItems: 4 type: array version: default: 1 description: The version of the custom table. maximum: 10000 minimum: 1 type: number required: - displayName UsageCarbonEmissionAggregation: description: The account (tenant) carbon emissions usage. properties: groupBy: description: Specifies what to aggregate the result by. items: type: string maxItems: 4 type: array items: description: A list of carbon emission usage items. items: $ref: '#/components/schemas/UsageCarbonEmissionSummary' maxItems: 500 type: array required: - items type: object CreateCustomTableDetails: description: New custom table detail. properties: compartmentId: description: The compartment OCID. maxLength: 250 minLength: 1 type: string savedCustomTable: $ref: '#/components/schemas/SavedCustomTable' savedReportId: description: The associated saved report OCID. maxLength: 250 minLength: 1 type: string required: - compartmentId - savedReportId - savedCustomTable Tag: description: The tag used for filtering. properties: key: description: The tag key. type: string namespace: description: The tag namespace. type: string value: description: The tag value. type: string type: object CreateUsageCarbonEmissionsQueryDetails: description: New query detail with savedRequestUsageCarbonEmissionsDetails, savedCostAnalysisUI, and displayName. properties: compartmentId: description: The compartment OCID. type: string queryDefinition: $ref: '#/components/schemas/UsageCarbonEmissionsQueryDefinition' required: - compartmentId - queryDefinition UsageAggregation: description: The account (tenant) usage. properties: groupBy: description: Aggregate the result by. items: type: string type: array items: description: A list of usage items. items: $ref: '#/components/schemas/UsageSummary' type: array required: - items type: object ScheduleCollection: description: A schedule collection. properties: items: description: Schedule summary list. items: $ref: '#/components/schemas/ScheduleSummary' type: array required: - items QueryCollection: description: A query list. properties: items: description: Query list. items: $ref: '#/components/schemas/QuerySummary' type: array required: - items responses: 429TooManyRequests: description: Too many requests. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 409Conflict: description: Conflict. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 404NotAuthorizedOrNotFound: description: Not authorized or not found. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' DefaultError: description: Unexpected error. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 400BadRequest: description: A bad request was made. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 500InternalServerError: description: Internal server error. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 401Unauthorized: description: Unauthorized. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 412PreconditionFailed: description: Precondition failed. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' parameters: NameQueryParam: description: 'The query parameter for filtering by name. ' in: query name: name schema: type: string RegionPathParam: description: The region. in: path name: region required: true x-default-description: '' schema: type: string CustomTableIdPathParam: description: The custom table unique OCID. in: path name: customTableId required: true x-default-description: '' schema: type: string maxLength: 250 minLength: 1 IfMatchHeader: description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted, only if the etag you provide matches the resource''s current etag value. ' in: header name: if-match required: false schema: type: string AdQueryParam: description: The availability domain. in: query name: ad required: false x-default-description: '' schema: type: string SortOrderQueryParam: description: The sort order to use, whether 'asc' or 'desc'. in: query name: sortOrder schema: type: string enum: - ASC - DESC default: ASC SavedReportIdQueryParam: description: The saved report ID in which to list resources. in: query name: savedReportId required: true schema: type: string SortByQueryParam: description: 'The field to sort by. If not specified, the default is displayName. ' in: query name: sortBy schema: type: string enum: - displayName default: displayName ScheduledRunIdPathParam: description: The scheduled run unique OCID. in: path name: scheduledRunId required: true x-default-description: '' schema: type: string ScheduleSortByQueryParam: description: 'The field to sort by. If not specified, the default is timeCreated. ' in: query name: sortBy schema: type: string enum: - name - timeCreated default: timeCreated ScheduleIdQueryParam: description: The schedule unique ID. in: query name: scheduleId required: true schema: type: string ScheduledRunSortByQueryParam: description: 'The field to sort by. If not specified, the default is timeCreated. ' in: query name: sortBy schema: type: string enum: - timeCreated default: timeCreated EmailRecipientsGroupIdPathParam: description: The email recipients group OCID. in: path name: emailRecipientsGroupId required: true x-default-description: '' schema: type: string PaginationTokenQueryParam: description: 'The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. ' in: query name: page x-default-description: '' schema: type: string maxLength: 512 minLength: 1 SubscriptionIdPathParam: description: The usage statement subscription unique OCID. in: path name: subscriptionId required: true x-default-description: '' schema: type: string SkuPathParam: description: The SKU part number. in: path name: skuPartNumber required: true x-default-description: '' schema: type: string UsageCarbonEmissionsQueryIdPathParam: description: The query unique OCID. in: path name: usageCarbonEmissionsQueryId required: true x-default-description: '' schema: type: string ScheduleIdPathParam: description: The schedule unique OCID. in: path name: scheduleId required: true x-default-description: '' schema: type: string RetryTokenHeader: description: 'A token that uniquely identifies a request so it can be retried in case of a timeout or server error, without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. ' in: header name: opc-retry-token required: false schema: type: string maxLength: 64 minLength: 1 QueryIdPathParam: description: The query unique OCID. in: path name: queryId required: true x-default-description: '' schema: type: string CompartmentIdQueryParam: description: The compartment ID in which to list resources. in: query name: compartmentId required: true schema: type: string PaginationLimitQueryParam: description: The maximum number of items to return. in: query name: limit schema: type: integer default: 25 maximum: 1000 minimum: 1 OpcRequestIdHeaderParam: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' in: header name: opc-request-id required: false schema: type: string x-anchors: x-headers: etag: description: For optimistic concurrency control. See `if-match`. type: string opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' type: string x-properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}` ' type: object systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object x-oracle-package: com.oracle.pic.metering.usagestore