{ "opencollection": "1.0.0", "info": { "name": "Usage Proxy Computed Usage API", "version": "20190111" }, "items": [ { "info": { "name": "computedUsage", "type": "folder" }, "items": [ { "info": { "name": "Returns a list of Aggregated Usages", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20190111/aggregatedComputedUsages", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the root compartment." }, { "name": "subscriptionId", "value": "", "type": "query", "description": "Subscription ID is an identifier associated with the service, used for filtering the computed usage in SPM.\n" }, { "name": "timeFrom", "value": "", "type": "query", "description": "Initial date to filter computed usage data in SPM. For non-aggregated data, the time period between fromDate and toDate, expressed in RFC 3339 timestamp format.\n" }, { "name": "timeTo", "value": "", "type": "query", "description": "Final date to filter computed usage data in SPM, expressed in RFC 3339 timestamp format.\n" }, { "name": "parentProduct", "value": "", "type": "query", "description": "Product part number for the subscribed service line, referred to as the parent product.\n" }, { "name": "grouping", "value": "", "type": "query", "description": "Grouping criteria to use for aggregating the computed usage, whether hourly (`HOURLY`), daily (`DAILY`), monthly (`MONTHLY`), or none (`NONE`), so as not to follow a grouping criteria by date.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of aggregatedComputedUsages items to return within the Subscription \"List\" call, this \ncounts the overall count across all items.\nExample: `500`\n" }, { "name": "page", "value": "", "type": "query", "description": "The value of the 'opc-next-page' response header from the previous \"List\" call.\n" } ] }, "docs": "Collection API that returns a list of aggregated computed usage details (there can be multiple parent products under a given SubID, each of which is represented under the subscription service line # in SPM).\n" }, { "info": { "name": "Returns a list of Computed Usages and its associated cost", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20190111/computedUsages", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the root compartment." }, { "name": "subscriptionId", "value": "", "type": "query", "description": "Subscription ID is an identifier associated with the service, used for filtering the computed usage in SPM.\n" }, { "name": "timeFrom", "value": "", "type": "query", "description": "Initial date to filter computed usage data in SPM. For non-aggregated data, the time period between fromDate and toDate, expressed in RFC 3339 timestamp format.\n" }, { "name": "timeTo", "value": "", "type": "query", "description": "Final date to filter computed usage data in SPM, expressed in RFC 3339 timestamp format.\n" }, { "name": "parentProduct", "value": "", "type": "query", "description": "Product part number for the subscribed service line, called the parent product.\n" }, { "name": "computedProduct", "value": "", "type": "query", "description": "Product part number for the computed usage.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated \"List\" call. Default: (`50`)\n\nExample: '500'\n" }, { "name": "page", "value": "", "type": "query", "description": "The value of the 'opc-next-page' response header from the previous \"List\" call.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending ('ASC') or descending ('DESC').\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`).\n" } ] }, "docs": "Collection API that returns a list of computed usages for the given filters.\n" }, { "info": { "name": "Returns Computed Usage Details corresponding to the Compute Usage id passed", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20190111/computedUsages/:computedUsageId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "computedUsageId", "value": "", "type": "path", "description": "The computed usage ID." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the root compartment." }, { "name": "fields", "value": "", "type": "query", "description": "Partial response refers to an optimization technique offered\nby the RESTful web APIs, to return only the information \n(fields) required by the client. This parameter controls which fields to\nreturn.\n" } ] }, "docs": "Returns computed usage corresponding to the passed ID.\n" } ] } ], "bundled": true }