{ "opencollection": "1.0.0", "info": { "name": "Usage Usageapi API", "version": "20200107" }, "items": [ { "info": { "name": "usageapi", "type": "folder" }, "items": [ { "info": { "name": "Requests average carbon emissions by SKU.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200107/averageCarbonEmissions/:skuPartNumber", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "skuPartNumber", "value": "", "type": "path", "description": "The SKU part number." } ] }, "docs": "Returns the average carbon emissions summary by SKU.\n" }, { "info": { "name": "Requests renewable/clean energy % used by region.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200107/cleanEnergyUsages/:region", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "region", "value": "", "type": "path", "description": "The region." }, { "name": "ad", "value": "", "type": "query", "description": "The availability domain." } ] }, "docs": "Returns the clean energy usage summary by region.\n" }, { "info": { "name": "Returns configurations.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200107/configuration", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "tenantId", "value": "", "type": "query", "description": "tenant id" } ] }, "docs": "Returns the configurations list for the UI drop-down list.\n" }, { "info": { "name": "Returns saved custom tables.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200107/customTables", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results.\nThis is usually retrieved from a previous list call.\n" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The compartment ID in which to list resources." }, { "name": "savedReportId", "value": "", "type": "query", "description": "The saved report ID in which to list resources." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. If not specified, the default is displayName.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, whether 'asc' or 'desc'." } ] }, "docs": "Returns the saved custom table list.\n" }, { "info": { "name": "Create a custom table.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200107/customTables", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Returns the created custom table.\n" }, { "info": { "name": "Returns saved custom table.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200107/customTables/:customTableId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "customTableId", "value": "", "type": "path", "description": "The custom table unique OCID." } ] }, "docs": "Returns the saved custom table.\n" }, { "info": { "name": "Update a custom table.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20200107/customTables/:customTableId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "customTableId", "value": "", "type": "path", "description": "The custom table unique OCID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a saved custom table by table ID.\n" }, { "info": { "name": "Delete a custom table.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20200107/customTables/:customTableId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "customTableId", "value": "", "type": "path", "description": "The custom table unique OCID." } ] }, "docs": "Delete a saved custom table by the OCID.\n" }, { "info": { "name": "Returns saved queries and UI properties.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200107/queries", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results.\nThis is usually retrieved from a previous list call.\n" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The compartment ID in which to list resources." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. If not specified, the default is displayName.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, whether 'asc' or 'desc'." } ] }, "docs": "Returns the saved query list.\n" }, { "info": { "name": "Create a query.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200107/queries", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Returns the created query.\n" }, { "info": { "name": "Returns saved query.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200107/queries/:queryId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "queryId", "value": "", "type": "path", "description": "The query unique OCID." } ] }, "docs": "Returns the saved query.\n" }, { "info": { "name": "Update a query.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20200107/queries/:queryId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "queryId", "value": "", "type": "path", "description": "The query unique OCID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a saved query by the OCID.\n" }, { "info": { "name": "Delete a query.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20200107/queries/:queryId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "queryId", "value": "", "type": "path", "description": "The query unique OCID." } ] }, "docs": "Delete a saved query by the OCID.\n" }, { "info": { "name": "Returns schedule history list.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200107/scheduledRuns", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results.\nThis is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "scheduleId", "value": "", "type": "query", "description": "The schedule unique ID." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. If not specified, the default is timeCreated.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, whether 'asc' or 'desc'." } ] }, "docs": "Returns the schedule history list.\n" }, { "info": { "name": "Returns saved schedule run.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200107/scheduledRuns/:scheduledRunId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "scheduledRunId", "value": "", "type": "path", "description": "The scheduled run unique OCID." } ] }, "docs": "Returns the saved schedule run.\n" }, { "info": { "name": "Returns the saved schedule list.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200107/schedules", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The compartment ID in which to list resources." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results.\nThis is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. If not specified, the default is timeCreated.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, whether 'asc' or 'desc'." }, { "name": "name", "value": "", "type": "query", "description": "The query parameter for filtering by name.\n" } ] }, "docs": "Returns the saved schedule list.\n" }, { "info": { "name": "Create a schedule.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200107/schedules", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Returns the created schedule.\n" }, { "info": { "name": "Returns saved schedule.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200107/schedules/:scheduleId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "scheduleId", "value": "", "type": "path", "description": "The schedule unique OCID." } ] }, "docs": "Returns the saved schedule.\n" }, { "info": { "name": "Update schedule.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20200107/schedules/:scheduleId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "scheduleId", "value": "", "type": "path", "description": "The schedule unique OCID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a saved schedule.\n" }, { "info": { "name": "Delete a schedule.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20200107/schedules/:scheduleId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "scheduleId", "value": "", "type": "path", "description": "The schedule unique OCID." } ] }, "docs": "Delete a saved scheduled report by the OCID.\n" }, { "info": { "name": "Returns usage for the given account.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200107/usage", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results.\nThis is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Returns usage for the given account.\n" }, { "info": { "name": "Returns usage carbon emission for the given account.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200107/usageCarbonEmissions", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results.\nThis is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Returns carbon emission usage for the given account.\n" }, { "info": { "name": "Returns usage carbon emission configurations.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200107/usageCarbonEmissionsConfig", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "tenantId", "value": "", "type": "query", "description": "tenant id" } ] }, "docs": "Returns the configuration list for the Console's carbon emission user interface drop-down list.\n" }, { "info": { "name": "Returns usage carbon emissions saved queries and UI properties.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200107/usageCarbonEmissionsQueries", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results.\nThis is usually retrieved from a previous list call.\n" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The compartment ID in which to list resources." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. If not specified, the default is displayName.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, whether 'asc' or 'desc'." } ] }, "docs": "Returns the carbon emissions usage saved query list.\n" }, { "info": { "name": "Create usage carbon emissions query.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200107/usageCarbonEmissionsQueries", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Returns the created carbon emissions usage query.\n" }, { "info": { "name": "Returns usage carbon emissions saved query.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200107/usageCarbonEmissionsQueries/:usageCarbonEmissionsQueryId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "usageCarbonEmissionsQueryId", "value": "", "type": "path", "description": "The query unique OCID." } ] }, "docs": "Returns the carbon emissions usage saved query.\n" }, { "info": { "name": "Update usage carbon emissions saved query.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20200107/usageCarbonEmissionsQueries/:usageCarbonEmissionsQueryId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "usageCarbonEmissionsQueryId", "value": "", "type": "path", "description": "The query unique OCID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a carbon emissions usage saved query by the OCID.\n" }, { "info": { "name": "Delete a usage carbon emissions saved query.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20200107/usageCarbonEmissionsQueries/:usageCarbonEmissionsQueryId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "usageCarbonEmissionsQueryId", "value": "", "type": "path", "description": "The query unique OCID." } ] }, "docs": "Delete a carbon emissions usage saved query by the OCID.\n" }, { "info": { "name": "Return the usage statement email recipients groups for this tenancy.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200107/usageStatements/:subscriptionId/emailRecipientsGroups", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "The usage statement subscription unique OCID." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results.\nThis is usually retrieved from a previous list call.\n" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The compartment ID in which to list resources." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. If not specified, the default is displayName.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, whether 'asc' or 'desc'." } ] }, "docs": "Returns the saved usage statement email recipients group.\n" }, { "info": { "name": "Create an email recipient group to receive usage statements for the subscription.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200107/usageStatements/:subscriptionId/emailRecipientsGroups", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "The usage statement subscription unique OCID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a list of email recipients that can receive usage statements for the subscription.\n" }, { "info": { "name": "Return the saved usage statement email recipients group details.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200107/usageStatements/:subscriptionId/emailRecipientsGroups/:emailRecipientsGroupId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "emailRecipientsGroupId", "value": "", "type": "path", "description": "The email recipients group OCID." }, { "name": "subscriptionId", "value": "", "type": "path", "description": "The usage statement subscription unique OCID." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The compartment ID in which to list resources." } ] }, "docs": "Returns the saved usage statement email recipients group.\n" }, { "info": { "name": "Update email recipients group.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20200107/usageStatements/:subscriptionId/emailRecipientsGroups/:emailRecipientsGroupId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "emailRecipientsGroupId", "value": "", "type": "path", "description": "The email recipients group OCID." }, { "name": "subscriptionId", "value": "", "type": "path", "description": "The usage statement subscription unique OCID." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The compartment ID in which to list resources." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a saved email recipients group.\n" }, { "info": { "name": "delete the email recipients group for the usage statement subscription.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20200107/usageStatements/:subscriptionId/emailRecipientsGroups/:emailRecipientsGroupId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "emailRecipientsGroupId", "value": "", "type": "path", "description": "The email recipients group OCID." }, { "name": "subscriptionId", "value": "", "type": "path", "description": "The usage statement subscription unique OCID." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The compartment ID in which to list resources." } ] }, "docs": "Deletes the email recipients group for the usage statement subscription.\n" } ] } ], "bundled": true }