{ "swagger":"2.0", "info":{ "version":"2023.07.31", "title":"Oracle Cloud Account Metering REST API", "description":"Metering REST APIs let consumer view information about their different metering components such as purchased credits, promotions, usage, usage costs and resource quotas.", "x-summary":"Metering REST APIs let consumer view information about their different metering components such as purchased credits, promotions, usage, usage costs and resource quotas." }, "basePath":"/metering", "schemes":[ "https", "http" ], "tags":[ { "name":"Cloud Account Details", "description":"Use this resource to retrieve details of the Cloud Account associated with your subscription. You can also create a new service entitlement, modify an existing entitlement, or view existing entitlements in an account." }, { "name":"Credit Promotions", "description":"Use this resource to view existing Oracle Cloud free credit promotions for an account. You can also search and filter the promotions based on subscription ID, promotion IDs, or entitlement IDs." }, { "name":"Resource Quotas", "description":"Use this resource to view the remaining balance of your purchased resource quotas associated with your Cloud Account or service entitlement." }, { "name":"Resource Usage", "description":"Use this resource to view the aggregated daily usage or consumption of a service resource in an account" }, { "name":"Resource Usage Cost", "description":"Use this resource to view the resource usage cost and billing information for a subscription within an account. You can search and filter the usage information based on parameters such as resource name, start date and time, time zone, or usage type. The usage type can be either a daily usage report (for the given start and end dates) or total usage (cumulative) for the specified period." }, { "name":"Resource Usage Limits", "description":"Use this resource to view the existing hard limits for a purchased resource, set new hard limits, or modify them. Note that you can only use the resources up to the hard limit you set here." }, { "name":"Service Resources", "description":"Use this resource to view details of all the different resources of a service including their metering parameters and resource quota limits, if any." } ], "definitions":{ "json_CloudBuckLimit":{ "type":"object", "title":"CloudBuckLimit", "properties":{ "createdOn":{ "description":"", "type":"object" }, "entitlementId":{ "description":"", "type":"string" }, "id":{ "description":"", "type":"string" }, "modifiedOn":{ "description":"", "type":"object" }, "resourceName":{ "description":"", "type":"string" }, "serviceName":{ "description":"", "type":"string" }, "limit":{ "description":"", "type":"number" }, "createdBy":{ "description":"", "type":"string" }, "modifiedBy":{ "description":"", "type":"string" }, "action":{ "description":"", "type":"string" }, "alertLevel":{ "description":"", "type":"number" }, "limitType":{ "description":"", "type":"string" }, "valueType":{ "description":"", "type":"string" }, "status":{ "description":"", "type":"string" }, "maxHardLimit":{ "description":"", "type":"string" }, "skuPartId":{ "description":"", "type":"string" } }, "description":"" }, "json_CloudBuckLimits":{ "type":"object", "title":"CloudBuckLimits", "properties":{ "canonicalLink":{ "description":"", "type":"string" }, "items":{ "description":"", "type":"array", "items":{ "type":"array", "items":{ "$ref":"#/definitions/json_CloudBuckLimit" } } } }, "description":"Encapsulates a collection of Hard and Soft Limits for a resource within a subscription." }, "json_AccountUsageCostRecord":{ "type":"object", "title":"AccountUsageCostRecord", "properties":{ "accountId":{ "description":"", "type":"string" }, "canonicalLink":{ "description":"", "type":"string" }, "items":{ "description":"", "type":"array", "items":{ "type":"array", "items":{ "$ref":"#/definitions/json_UsageCostRecord" } } } }, "description":"" }, "json_UsageCost":{ "type":"object", "title":"UsageCost", "properties":{ "computedAmount":{ "description":"Cost computed for usage.", "type":"number" }, "computedQuantity":{ "description":"Quantity used for computing cost.", "type":"number" }, "overagesFlag":{ "description":"If Y, then the cost is an overage.", "type":"string" }, "rateCardId":{ "description":"GSI rate card identifier.", "type":"string" }, "unitPrice":{ "description":"Price per unit of resource.", "type":"number" } }, "description":"" }, "json_UsageCostRecord":{ "type":"object", "title":"UsageCostRecord", "properties":{ "costs":{ "description":"", "type":"array", "items":{ "type":"array", "items":{ "$ref":"#/definitions/json_UsageCost" } } }, "currency":{ "description":"Currency.", "type":"string" }, "endTimeUtc":{ "description":"End time of the interval for which cost is returned.", "type":"object" }, "gsiProductId":{ "description":"GSI product id for the Sku.", "type":"string" }, "quantity":{ "description":"Quantity.", "type":"number" }, "resourceName":{ "description":"Resource Name.", "type":"string" }, "serviceName":{ "description":"Service Name.", "type":"string" }, "startTimeUtc":{ "description":"Start time of the interval for which cost is returned.", "type":"object" }, "subscriptionId":{ "description":"Purchase Entitlement Id.", "type":"string" }, "subscriptionType":{ "description":"Trial or production.", "type":"string" }, "lastComputationDate":{ "description":"Time at which cost was synced from billing system.", "type":"object" }, "dataCenterId":{ "description":"Datacenter Id", "type":"object" }, "tag":{ "description":"Tag applied on this usage.", "type":"string" } }, "description":"" }, "json_Promotion":{ "type":"object", "title":"Promotion", "properties":{ "canonicalLink":{ "description":"", "type":"string" }, "id":{ "description":"", "type":"number" }, "sourcePromotionId":{ "description":"", "type":"number" }, "amount":{ "description":"", "type":"number" }, "duration":{ "description":"", "type":"string" }, "currencyUnit":{ "description":"", "type":"string" }, "durationUnit":{ "description":"", "type":"string" }, "balanceUnit":{ "description":"", "type":"string" }, "description":{ "description":"", "type":"string" }, "balance":{ "description":"", "type":"number" }, "balanceModifiedOn":{ "description":"", "type":"object" }, "startDate":{ "description":"", "type":"object" }, "endDate":{ "description":"", "type":"object" }, "createdOn":{ "description":"", "type":"object" }, "modifiedOn":{ "description":"", "type":"object" }, "estimatedBalance":{ "description":"", "type":"number" }, "estimatedBalanceUpdatedOn":{ "description":"", "type":"object" }, "accountName":{ "description":"", "type":"string" }, "status":{ "description":"", "type":"string" }, "entitlementIds":{ "description":"", "type":"array", "items":{ "type":"array", "items":{ "type":"string" } } }, "subscriptionIds":{ "description":"", "type":"array", "items":{ "type":"array", "items":{ "type":"string" } } } }, "description":"" }, "json_Promotions":{ "type":"object", "title":"Promotions", "properties":{ "items":{ "description":"", "type":"array", "items":{ "type":"array", "items":{ "$ref":"#/definitions/json_Promotion" } } }, "canonicalLink":{ "description":"", "type":"string" } }, "description":"" }, "json_AccountUsageRecord":{ "type":"object", "title":"AccountUsageRecord", "properties":{ "accountId":{ "description":"", "type":"string" }, "canonicalLink":{ "description":"", "type":"string" }, "items":{ "description":"", "type":"array", "items":{ "type":"array", "items":{ "$ref":"#/definitions/json_UsageRecord" } } } }, "description":"" }, "json_EntityType":{ "type":"string", "title":"EntityType", "enum":[ "SERVICE_INSTANCE", "SERVICE_ENTITLEMENT" ], "description":"" }, "json_Usage":{ "type":"object", "title":"Usage", "properties":{ "quantity":{ "description":"", "type":"number" }, "resourceName":{ "description":"", "type":"string" }, "units":{ "description":"", "type":"string" }, "usageSource":{ "description":"", "type":"string" } }, "description":"" }, "json_UsageTag":{ "type":"object", "title":"UsageTag", "properties":{ "tag":{ "description":"Text representing a tag.", "type":"string" }, "tagType":{ "description":"Native or non-native. OCI tags are non-native.", "type":"string" }, "createdOn":{ "description":"", "type":"object" } }, "description":"" }, "json_AccountUsageTags":{ "type":"object", "title":"AccountUsageTags", "properties":{ "accountId":{ "description":"", "type":"string" }, "items":{ "description":"", "type":"array", "items":{ "type":"array", "items":{ "$ref":"#/definitions/json_UsageTag" } } }, "canonicalLink":{ "description":"", "type":"string" } }, "description":"" }, "json_UsageRecord":{ "type":"object", "title":"UsageRecord", "properties":{ "serviceName":{ "description":"", "type":"string" }, "dataCenter":{ "description":"", "type":"string" }, "startTimeUtc":{ "description":"", "type":"object" }, "endTimeUtc":{ "description":"", "type":"object" }, "reservationId":{ "description":"", "type":"string" }, "canonicalLink":{ "description":"", "type":"string" }, "usage":{ "description":"", "type":"array", "items":{ "type":"array", "items":{ "$ref":"#/definitions/json_Usage" } } }, "entityId":{ "description":"", "type":"string" }, "entityType":{ "description":"", "$ref":"#/definitions/json_EntityType" }, "componentId":{ "description":"", "type":"string" }, "componentType":{ "description":"", "type":"string" } }, "description":"" }, "json_CheckQuota":{ "type":"object", "title":"CheckQuota", "properties":{ "isAllowed":{ "description":"", "type":"boolean" }, "violationType":{ "description":"", "type":"string" }, "cloudCreditBalance":{ "description":"", "type":"array", "items":{ "type":"array", "items":{ "$ref":"#/definitions/json_CreditBalance" } } }, "resourceBalance":{ "description":"", "type":"array", "items":{ "type":"array", "items":{ "$ref":"#/definitions/json_ResourceQuotaBalance" } } } }, "description":"" }, "json_CreditBalance":{ "type":"object", "title":"CreditBalance", "properties":{ "CCType":{ "description":"", "type":"string" }, "purchaseAmount":{ "description":"", "type":"number" }, "balance":{ "description":"", "type":"number" }, "dependency":{ "description":"", "type":"boolean" } }, "description":"" }, "json_ResourceQuotaBalance":{ "type":"object", "title":"ResourceQuotaBalance", "properties":{ "name":{ "description":"", "type":"string" }, "service":{ "description":"", "type":"string" }, "isAllowed":{ "description":"", "type":"boolean" }, "limit":{ "description":"", "type":"number" }, "balance":{ "description":"", "type":"number" }, "dependency":{ "description":"", "type":"boolean" }, "affectedResource":{ "description":"", "type":"string" }, "inOverage":{ "description":"", "type":"boolean" }, "purchasedLimit":{ "description":"", "type":"number" } }, "description":"" }, "json_Balance":{ "type":"object", "title":"Balance", "properties":{ "createdOn":{ "description":"", "type":"object" }, "id":{ "description":"", "type":"string" }, "purchasedResources":{ "description":"", "type":"array", "items":{ "type":"array", "items":{ "$ref":"#/definitions/json_PurchasedResource" } } } }, "description":"" }, "json_CbProperties":{ "type":"object", "title":"CbProperties", "properties":{ "key":{ "description":"", "type":"string" }, "value":{ "description":"", "type":"string" } }, "description":"" }, "json_CloudBuck":{ "type":"object", "title":"CloudBuck", "properties":{ "subscriptionType":{ "description":"", "$ref":"#/definitions/json_SubscriptionType" }, "status":{ "description":"", "type":"string" }, "entitlementId":{ "description":"", "type":"string" }, "consumed":{ "description":"", "type":"number" }, "id":{ "description":"", "type":"string" }, "canonicalLink":{ "description":"", "type":"string" }, "hardLimitAll":{ "description":"", "type":"number" }, "hardLimitNew":{ "description":"", "type":"number" }, "overagesAllowed":{ "description":"", "type":"boolean" }, "softLimit":{ "description":"", "type":"number" }, "cloudBucksType":{ "description":"", "type":"string" }, "balance":{ "description":"", "type":"array", "items":{ "type":"array", "items":{ "$ref":"#/definitions/json_Balance" } } }, "purchase":{ "description":"", "type":"array", "items":{ "type":"array", "items":{ "$ref":"#/definitions/json_Purchase" } } }, "runningBalance":{ "description":"", "type":"array", "items":{ "type":"array", "items":{ "$ref":"#/definitions/json_Balance" } } }, "serviceEntitlements":{ "description":"", "type":"array", "items":{ "type":"array", "items":{ "$ref":"#/definitions/json_ServiceEntitlement" } } }, "serviceType":{ "description":"", "type":"string" }, "subscriptionCategory":{ "description":"", "type":"string" }, "cbProperties":{ "description":"", "type":"array", "items":{ "type":"array", "items":{ "$ref":"#/definitions/json_CbProperties" } } }, "billingType":{ "description":"", "type":"string" } }, "description":"" }, "json_CloudBucks":{ "type":"object", "title":"CloudBucks", "properties":{ "items":{ "description":"", "type":"array", "items":{ "type":"array", "items":{ "$ref":"#/definitions/json_CloudBuck" } } }, "canonicalLink":{ "description":"", "type":"string" } }, "description":"" }, "json_Property":{ "type":"object", "title":"Property", "properties":{ "key":{ "description":"", "type":"string" }, "value":{ "description":"", "type":"string" } }, "description":"" }, "json_Purchase":{ "type":"object", "title":"Purchase", "properties":{ "hardLimitAll":{ "description":"", "type":"number" }, "hardLimitNew":{ "description":"", "type":"number" }, "overagesAllowed":{ "description":"", "type":"boolean" }, "softLimit":{ "description":"", "type":"number" }, "id":{ "description":"", "type":"string" }, "createdOn":{ "description":"", "type":"object" }, "purchasedResources":{ "description":"", "type":"array", "items":{ "type":"array", "items":{ "$ref":"#/definitions/json_PurchasedResource" } } } }, "description":"" }, "json_PurchasedResource":{ "type":"object", "title":"PurchasedResource", "properties":{ "name":{ "description":"", "type":"string" }, "value":{ "description":"", "type":"number" }, "unit":{ "description":"", "type":"string" }, "startDate":{ "description":"", "type":"object" }, "endDate":{ "description":"", "type":"object" }, "createdOn":{ "description":"", "type":"object" }, "modifiedOn":{ "description":"", "type":"object" }, "serviceName":{ "description":"", "type":"string" }, "derived":{ "description":"", "type":"string" }, "quotaBalance":{ "description":"", "type":"number" }, "displayName":{ "description":"", "type":"string" }, "rateCardId":{ "description":"", "type":"string" }, "orderLineId":{ "description":"", "type":"string" } }, "description":"" }, "json_ServiceEntitlement":{ "type":"object", "title":"ServiceEntitlement", "properties":{ "id":{ "description":"", "type":"string" }, "type":{ "description":"", "type":"string" }, "serviceInstances":{ "description":"", "type":"array", "items":{ "type":"array", "items":{ "$ref":"#/definitions/json_ServiceInstance" } } }, "systemName":{ "description":"", "type":"string" }, "dataJurisdictionName":{ "description":"", "type":"string" }, "svcEntProperties":{ "description":"", "type":"array", "items":{ "type":"array", "items":{ "$ref":"#/definitions/json_Property" } } }, "svcEntitlementSetId":{ "description":"", "type":"number" } }, "description":"" }, "json_ServiceEntitlements":{ "type":"object", "title":"ServiceEntitlements", "properties":{ "items":{ "description":"", "type":"array", "items":{ "type":"array", "items":{ "$ref":"#/definitions/json_ServiceEntitlement" } } }, "canonicalLink":{ "description":"", "type":"string" } }, "description":"" }, "json_ServiceInstance":{ "type":"object", "title":"ServiceInstance", "properties":{ "id":{ "description":"", "type":"string" }, "status":{ "description":"", "type":"string" }, "systemName":{ "description":"", "type":"string" }, "dataJurisdictionName":{ "description":"", "type":"string" } }, "description":"" }, "json_SubscriptionType":{ "type":"string", "title":"SubscriptionType", "enum":[ "TRIAL", "PRODUCTION", "ORACLE_ASSIGNED_ENVIRONMENT" ], "description":"" }, "json_CloudCreditBillingConfig":{ "type":"object", "title":"CloudCreditBillingConfig", "properties":{ "billingType":{ "description":"", "type":"string" }, "gsiPartNumber":{ "description":"", "type":"string" } }, "description":"" }, "json_Resource":{ "type":"object", "title":"Resource", "properties":{ "dailyUnitDisplayName":{ "description":"", "type":"string" }, "hourlyUnitDisplayName":{ "description":"", "type":"string" }, "rawUnitDisplayName":{ "description":"", "type":"string" }, "usageDataType":{ "description":"", "type":"string" }, "name":{ "description":"", "type":"string" }, "servicename":{ "description":"", "type":"string" }, "canonicalLink":{ "description":"", "type":"string" }, "gsiProductId":{ "description":"", "type":"string" }, "aggregationMultiplier":{ "description":"", "type":"string" }, "gsiUsageUnit":{ "description":"", "type":"string" }, "resourceLimit":{ "description":"", "type":"array", "items":{ "type":"array", "items":{ "$ref":"#/definitions/json_ResourceLimit" } } }, "resourceHardLimit":{ "description":"", "type":"array", "items":{ "type":"array", "items":{ "$ref":"#/definitions/json_ResourceHardLimit" } } }, "description":{ "description":"", "type":"string" }, "displayName":{ "description":"", "type":"string" }, "conversionFactor":{ "description":"", "type":"number" }, "instanceType":{ "description":"", "type":"string" }, "applicableComponent":{ "description":"", "type":"string" }, "cloudCreditBillingConfig":{ "description":"", "type":"array", "items":{ "type":"array", "items":{ "$ref":"#/definitions/json_CloudCreditBillingConfig" } } }, "skuproductIds":{ "description":"", "type":"array", "items":{ "type":"array", "items":{ "$ref":"#/definitions/json_SkuProductIds" } } } }, "description":"" }, "json_ResourceHardLimit":{ "type":"object", "title":"ResourceHardLimit", "properties":{ "limitType":{ "description":"", "type":"string" }, "limit":{ "description":"", "type":"string" }, "resourceName":{ "description":"", "type":"string" }, "serviceName":{ "description":"", "type":"string" }, "limitMultiplier":{ "description":"", "type":"number" }, "limitProperty":{ "description":"", "type":"string" }, "resourceBnumber":{ "description":"", "type":"string" } }, "description":"" }, "json_ResourceLimit":{ "type":"object", "title":"ResourceLimit", "properties":{ "limit":{ "description":"", "type":"number" }, "limitType":{ "description":"", "type":"string" }, "direct":{ "description":"", "type":"string" }, "resourceName":{ "description":"", "type":"string" }, "serviceName":{ "description":"", "type":"string" }, "dependentForLimits":{ "description":"", "type":"array", "items":{ "type":"array", "items":{ "$ref":"#/definitions/json_ServiceResourceMap" } } }, "dependentOnLimits":{ "description":"", "type":"array", "items":{ "type":"array", "items":{ "$ref":"#/definitions/json_ServiceResourceMap" } } } }, "description":"" }, "json_ResourceLimits":{ "type":"object", "title":"ResourceLimits", "properties":{ "items":{ "description":"", "type":"array", "items":{ "type":"array", "items":{ "$ref":"#/definitions/json_ResourceLimit" } } }, "canonicalLink":{ "description":"", "type":"string" } }, "description":"" }, "json_Resources":{ "type":"object", "title":"Resources", "properties":{ "items":{ "description":"", "type":"array", "items":{ "type":"array", "items":{ "$ref":"#/definitions/json_Resource" } } }, "canonicalLink":{ "description":"", "type":"string" } }, "description":"" }, "json_ServiceResourceMap":{ "type":"object", "title":"ServiceResourceMap", "properties":{ "resourceName":{ "description":"Resource Name.", "type":"string" }, "serviceName":{ "description":"Service Name.", "type":"string" }, "limit":{ "description":"Quantity set as limit.", "type":"number" }, "limitType":{ "description":"Soft or Hard limit.", "type":"string" }, "canonicalLink":{ "description":"", "type":"string" } }, "description":"" }, "json_SkuProductIds":{ "type":"object", "title":"SkuProductIds", "properties":{ "skuId":{ "description":"Sku Id.", "type":"string" }, "skuType":{ "description":"Metered or Commitment sku", "type":"string" } }, "description":"" } }, "paths":{ "/api/v1/cloudbucklimits/{accountId}/{entitlementId}":{ "post":{ "tags":[ "Resource Usage Limits" ], "summary":"Define Soft or Hard Limits for Resources", "description":"Define new hard or soft limits for resources of a given service entitlement.", "operationId":"resource_CloudBuckLimitsResourcenew_createCloudBuckLimits_POST", "consumes":[ "application/vnd.com.oracle.oraclecloud.metering.cloudbucklimits+json" ], "produces":[ "application/vnd.com.oracle.oraclecloud.metering.cloudbucklimits+json" ], "parameters":[ { "name":"accountId", "in":"path", "required":true, "type":"string", "description":"Account name, starts with cacct." }, { "name":"entitlementId", "in":"path", "required":true, "type":"string", "description":"Service Entitlement Id." }, { "name":"body", "in":"body", "schema":{ "description":"", "$ref":"#/definitions/json_CloudBuckLimits" }, "description":"Limit definition." } ], "responses":{ "201":{ "schema":{ "description":"", "type":"file" }, "headers":{ }, "description":"Success" }, "default":{ "description":"Unexpected error." } }, "x-internal-id":"api-v1-cloudbucklimits-{accountId}-{entitlementId}-post", "x-filename-id":"api-v1-cloudbucklimits-accountid-entitlementid-post" }, "put":{ "tags":[ "Resource Usage Limits" ], "summary":"Update Hard or Soft Limits for Resources", "description":"Define or modify hard or soft limits for resources of a given service entitlement.", "operationId":"resource_CloudBuckLimitsResourcenew_updateCloudBuckLimits_PUT", "consumes":[ "application/vnd.com.oracle.oraclecloud.metering.cloudbucklimits+json" ], "produces":[ "application/vnd.com.oracle.oraclecloud.metering.cloudbucklimits+json" ], "parameters":[ { "name":"accountId", "in":"path", "required":true, "type":"string", "description":"Account name, starts with cacct." }, { "name":"entitlementId", "in":"path", "required":true, "type":"string", "description":"Service Entitlement Id." }, { "name":"body", "in":"body", "schema":{ "description":"", "$ref":"#/definitions/json_CloudBuckLimits" }, "description":"Limit definition." } ], "responses":{ "201":{ "schema":{ "description":"", "type":"file" }, "headers":{ }, "description":"Success" }, "default":{ "description":"Unexpected error." } }, "x-internal-id":"api-v1-cloudbucklimits-{accountId}-{entitlementId}-put", "x-filename-id":"api-v1-cloudbucklimits-accountid-entitlementid-put" }, "get":{ "tags":[ "Resource Usage Limits" ], "description":"Retrieve the hard and soft limits for a resource.", "operationId":"resource_CloudBuckLimitsResourcenew_getCloudBuckLimits_GET", "produces":[ "application/vnd.com.oracle.oraclecloud.metering.cloudbucklimits+json" ], "parameters":[ { "name":"accountId", "in":"path", "required":true, "type":"string", "description":"Account name, starts with cacct." }, { "name":"entitlementId", "in":"path", "required":true, "type":"string", "description":"Service Entitlement Id" }, { "name":"limitType", "in":"query", "type":"string", "description":"Hard or soft limt. Hard limits lead to breaches, soft to alerts." }, { "name":"resourceType", "in":"query", "type":"string", "description":"Resource Name." }, { "name":"serviceType", "in":"query", "type":"string", "description":"Service Name." } ], "responses":{ "200":{ "schema":{ "description":"", "$ref":"#/definitions/json_CloudBuckLimits" }, "headers":{ }, "description":"Success" }, "default":{ "description":"Unexpected error." } }, "summary":"View Hard and Soft Limits of a Service Resource", "x-internal-id":"api-v1-cloudbucklimits-{accountId}-{entitlementId}-get", "x-filename-id":"api-v1-cloudbucklimits-accountid-entitlementid-get" } }, "/api/v1/usagecost/{accountId}":{ "get":{ "tags":[ "Resource Usage Cost" ], "description":"Retrieve details of resource usage cost for all subscriptions in a given account.", "operationId":"resource_UsageCostResource_getAccountUsageCost_GET", "produces":[ "application/vnd.com.oracle.oraclecloud.metering.usage+json" ], "parameters":[ { "name":"accountId", "in":"path", "required":true, "type":"string", "description":"Account name, starts with cacct." }, { "name":"endTime", "in":"query", "required":true, "type":"string", "description":"Specifies the end of the interval for which usage cost is being retrieved." }, { "name":"resourceName", "in":"query", "type":"string", "description":"Resource Name." }, { "name":"serviceName", "in":"query", "type":"string", "description":"Service Name" }, { "name":"startTime", "in":"query", "required":true, "type":"string", "description":"Specifies the start of the interval for which usage cost is being retrieved." }, { "name":"timeZone", "in":"query", "required":true, "type":"string", "description":"Timezone specified for start and end time params. Default is UTC." }, { "name":"usageType", "in":"query", "required":true, "type":"string", "description":"UsageType can be TOTAL, HOURLY or DAILY. Defaults to TOTAL." }, { "name":"dcAggEnabled", "in":"query", "type":"string", "description":"If Y, then usage cost is grouped per datacenter" }, { "name":"computeTypeEnabled", "in":"query", "required":true, "type":"string", "description":"If Y, then usage cost is grouped by computeType, which is used to indicate the nature of cost incurred say Usage, Overage etc." }, { "name":"dataCenter", "in":"query", "type":"string", "description":"A filter for which Datacenter for which cost needs to be retrieved. This is used with OCI Classic services and not needed when grabbing data from OCI services. This is an optional parameter." }, { "name":"serviceEntitlementId", "in":"query", "required":true, "type":"string", "description":"Service Entitlement Id" } ], "responses":{ "200":{ "schema":{ "description":"", "$ref":"#/definitions/json_AccountUsageCostRecord" }, "headers":{ }, "description":"Success" }, "default":{ "description":"Unexpected error." } }, "summary":" View Resource Usage Cost for An Account", "x-internal-id":"api-v1-usagecost-{accountId}-get", "x-filename-id":"api-v1-usagecost-accountid-get" } }, "/api/v1/usagecost/{accountId}/tagged":{ "get":{ "tags":[ "Resource Usage Cost" ], "description":"Retrieve usage cost of all resources tagged with the supplied tags.", "operationId":"resource_UsageCostResource_getTaggedAccountUsageCost_GET", "produces":[ "application/vnd.com.oracle.oraclecloud.metering.usage+json" ], "parameters":[ { "name":"accountId", "in":"path", "required":true, "type":"string", "description":"Account name, starts with cacct." }, { "name":"computeTypeEnabled", "in":"query", "type":"string", "description":"If Y, then usage cost is grouped by computeType, which is used to indicate the nature of cost incurred say Usage, Overage, Promotion, PAYG etc. This is optional." }, { "name":"dataCenter", "in":"query", "type":"string", "description":"A filter for which Datacenter for which cost needs to be retrieved. This is used with OCI Classic services and not needed when grabbing data from OCI services. This is an optional parameter." }, { "name":"dcAggEnabled", "in":"query", "type":"string", "description":"if Y, then usage cost is grouped per datacenter. This is optional." }, { "name":"endTime", "in":"query", "type":"string", "description":"Specifies the end time of the interval for which usage cost is being retrieved.This is mandatory." }, { "name":"resourceName", "in":"query", "type":"string", "description":"Resource name filter. Example PIC_COMPUTE_VM_STANDARD, PIC_BLOCK_STORAGE_STANDARD etc. This is optional." }, { "name":"rollupLevel", "in":"query", "type":"string", "description":"If rollupLevel is set to RESOURCE, usage cost per resource and tag combination will be provided. In that case, each repeated tags param should be a single tag. This is optional." }, { "name":"serviceEntitlementId", "in":"query", "type":"string", "description":"Service Entitlement Id filter. This is optional." }, { "name":"serviceName", "in":"query", "type":"string", "description":"Service name filter. Examples DATATRANSFERBM, EXADATABM. This is optional." }, { "name":"startTime", "in":"query", "type":"string", "description":"Specifies the start of the interval for which usage cost is being retrieved. This is mandatory." }, { "name":"tags", "in":"query", "type":"array", "items":{ "type":"string" }, "collectionFormat":"multi", "description":"A tags parameter can use a pipe (|) separated to filter for multiple tags applied simultaneously with a logical AND. Repeated tags parameters are interpreted as or-clauses. You need to URL encode the tags which means . (dot) is replaced by %3A and = (equals) is replaced by %3D. E.g. Finance%3ACostCenter%3Dw1234 instead of Finance.CostCenter=w1234." }, { "name":"timeZone", "in":"query", "type":"string", "description":"Timezone in which start and end times are specified. Examples UTC, US/Pacific,America/Los_Angeles." }, { "name":"usageType", "in":"query", "type":"string", "description":"UsageType can be TOTAL, HOURLY or DAILY. Defaults to TOTAL. For HOURLY usageType, we allow maximum interval of 7 days; for DAILY it is 30 days. The results are grouped by time interval according to usageType chosen." } ], "responses":{ "200":{ "schema":{ "description":"", "$ref":"#/definitions/json_AccountUsageCostRecord" }, "headers":{ }, "description":"Success" }, "default":{ "description":"Unexpected error." } }, "summary":" View Tagged Resource Usage Cost for An Account", "x-internal-id":"api-v1-usagecost-{accountId}-tagged-get", "x-filename-id":"api-v1-usagecost-accountid-tagged-get" } }, "/api/v1/promotions/{accountId}":{ "get":{ "tags":[ "Credit Promotions" ], "description":"Retrieve details of all ongoing credit promotions for an account.", "operationId":"resource_PromotionResource_getPromotions_GET", "produces":[ "application/vnd.com.oracle.oraclecloud.metering.promotions+json" ], "parameters":[ { "name":"accountId", "in":"path", "required":true, "type":"string", "description":"Account name starts with cacct." }, { "name":"entitlementIds", "in":"query", "type":"string", "description":"Comma separated list of service entitlement Id." }, { "name":"promotionIds", "in":"query", "type":"string", "description":"Comma separated list of promotion id." }, { "name":"sourcepromotionIds", "in":"query", "type":"string", "description":"Comma separated list of sourcePromotionId." }, { "name":"subscriptionIds", "in":"query", "type":"string", "description":"Comma separated list of subscription id." } ], "responses":{ "200":{ "schema":{ "description":"", "$ref":"#/definitions/json_Promotions" }, "headers":{ }, "description":"Success" }, "default":{ "description":"Unexpected error." } }, "summary":"View Credit Promotions for an Account", "x-internal-id":"api-v1-promotions-{accountId}-get", "x-filename-id":"api-v1-promotions-accountid-get" } }, "/api/v1/promotions/{accountId}/{promotionId}":{ "get":{ "tags":[ "Credit Promotions" ], "description":"Retrieve details of a specific ongoing credit promotion.", "operationId":"resource_PromotionResource_getPromotion_GET", "produces":[ "application/vnd.com.oracle.oraclecloud.metering.promotions+json" ], "parameters":[ { "name":"accountId", "in":"path", "required":true, "type":"string", "description":"Account name, starts with cacct." }, { "name":"promotionId", "in":"path", "required":true, "type":"string", "description":"Promotion identifier" } ], "responses":{ "200":{ "schema":{ "description":"", "$ref":"#/definitions/json_Promotions" }, "headers":{ }, "description":"Success" }, "default":{ "description":"Unexpected error." } }, "summary":"View Details of an Ongoing Credit Promotion", "x-internal-id":"api-v1-promotions-{accountId}-{promotionId}-get", "x-filename-id":"api-v1-promotions-accountid-promotionid-get" } }, "/api/v1/usage/{accountId}":{ "get":{ "tags":[ "Resource Usage" ], "description":"Retrieve details of resource usage of all service entitlements in a given account.", "operationId":"resource_UsageResource_getAccountUsage_GET", "produces":[ "application/vnd.com.oracle.oraclecloud.metering.usage+json" ], "parameters":[ { "name":"accountId", "in":"path", "required":true, "type":"string", "description":"Account name, starts with cacct." }, { "name":"componentId", "in":"query", "type":"string", "description":"Components are usage attributes passed by services. Not applicable to aggregated usage." }, { "name":"dataCenter", "in":"query", "type":"string", "description":"Datacenter." }, { "name":"endTime", "in":"query", "required":true, "type":"string", "description":"Specifies the endpoint of the interval for which usage is being returned in given timezone." }, { "name":"endTimeUtc", "in":"query", "type":"string", "description":"Specifies the endpoint of the interval for which usage is being returned in UTC. " }, { "name":"quantity", "in":"query", "type":"number", "description":"Used for filtering usage by quantity." }, { "name":"reservationId", "in":"query", "type":"integer", "description":"Used for filtering usage based on reservationId." }, { "name":"resourceName", "in":"query", "type":"string", "description":"Resource Name" }, { "name":"serviceEntitlementId", "in":"query", "type":"string", "description":"Service Entitlement Id" }, { "name":"serviceName", "in":"query", "type":"string", "description":"Service Name" }, { "name":"startTime", "in":"query", "required":true, "type":"string", "description":"Specifies the start time of the interval for which usage is returned in supplied timezone." }, { "name":"startTimeUtc", "in":"query", "type":"string", "description":"" }, { "name":"timeZone", "in":"query", "required":true, "type":"string", "description":"Timezone." }, { "name":"tzd", "in":"query", "type":"string", "description":"Timezone descriptor." }, { "name":"units", "in":"query", "type":"string", "description":"Units." }, { "name":"usageSource", "in":"query", "type":"string", "description":"To be used to filter raw usage by usageSource, which is non null if some service is reportin usage on behalf of another service." }, { "name":"usageType", "in":"query", "required":true, "type":"string", "description":"UsageType can be TOTAL, HOURLY or DAILY. Defaults to TOTAL." }, { "name":"dcAggEnabled", "in":"query", "required":true, "type":"string", "description":"Y if output needs to be grouped per datacenter." } ], "responses":{ "200":{ "schema":{ "description":"", "$ref":"#/definitions/json_AccountUsageRecord" }, "headers":{ }, "description":"Success" }, "default":{ "description":"Unexpected error." } }, "summary":"View Resource Usage for an Account", "x-internal-id":"api-v1-usage-{accountId}-get", "x-filename-id":"api-v1-usage-accountid-get" } }, "/api/v1/usage/{accountId}/tags":{ "get":{ "tags":[ "Resource Usage" ], "description":"Retrieve all tags applied on usage posted for a given account.", "operationId":"resource_UsageResource_getAccountTaggedUsage_GET", "produces":[ "application/vnd.com.oracle.oraclecloud.metering.usage+json" ], "parameters":[ { "name":"accountId", "in":"path", "required":true, "type":"string", "description":"Account name, starts with cacct." }, { "name":"tagType", "in":"query", "default":"NATIVE", "type":"string", "description":"tagType can be NATIVE , NON-NATIVE or ALL. OCI tags are non-native" } ], "responses":{ "200":{ "schema":{ "description":"", "$ref":"#/definitions/json_AccountUsageTags" }, "headers":{ }, "description":"Success" }, "default":{ "description":"Unexpected error." } }, "summary":" View Resource Usage tags applied on an Account", "x-internal-id":"api-v1-usage-{accountId}-tags-get", "x-filename-id":"api-v1-usage-accountid-tags-get" } }, "/api/v1/checkQuota/{accountId}":{ "get":{ "tags":[ "Resource Quotas" ], "description":"Retrieve resource quotas for all service entitlements in a given account.", "operationId":"resource_CheckQuotaResourcesnew_getCheckQuota_GET", "produces":[ "application/json", "application/vnd.com.oracle.oracloud.metering.checkquota+json" ], "parameters":[ { "name":"accountId", "in":"path", "required":true, "type":"string", "description":"Account name, starts with cacct." }, { "name":"resources", "in":"query", "type":"string", "description":"Resources encode resourceName, quantity and usage source to be used in quota check." }, { "name":"serviceName", "in":"query", "required":true, "type":"string", "description":"Service name" } ], "responses":{ "200":{ "schema":{ "description":"", "$ref":"#/definitions/json_CheckQuota" }, "headers":{ }, "description":"Success" }, "default":{ "description":"Unexpected error." } }, "summary":"View Resource Quotas for an Account", "x-internal-id":"api-v1-checkQuota-{accountId}-get", "x-filename-id":"api-v1-checkquota-accountid-get" } }, "/api/v1/checkQuota/serviceEntitlement/{serviceEntitlementId}":{ "get":{ "tags":[ "Resource Quotas" ], "description":"Retrieve resource quotas of a given service entitlement.", "operationId":"resource_CheckQuotaResourcenew_getCheckQuota_GET", "produces":[ "application/json", "application/vnd.com.oracle.oracloud.metering.checkquota+json" ], "parameters":[ { "name":"serviceEntitlementId", "in":"path", "required":true, "type":"string", "description":"Service Entitlement Id." }, { "name":"resources", "in":"query", "type":"string", "description":"Resources encode resourceName, quantity and usage source to be used in quota check." }, { "name":"serviceName", "in":"query", "required":true, "type":"string", "description":"Service name." } ], "responses":{ "200":{ "schema":{ "description":"", "$ref":"#/definitions/json_CheckQuota" }, "headers":{ }, "description":"Success" }, "default":{ "description":"Unexpected error." } }, "summary":"View Resource Quotas of a Service Entitlement", "x-internal-id":"api-v1-checkQuota-serviceEntitlement-{serviceEntitlementId}-get", "x-filename-id":"api-v1-checkquota-serviceentitlement-serviceentitlementid-get" } }, "/api/v1/cloudbucks/{accountId}":{ "get":{ "tags":[ "Cloud Account Details" ], "description":"Retrieve subscription details of services and entitlements belonging to an account or identity domain.", "operationId":"resource_CloudBucksResourcenew_getCloudBucks_GET", "produces":[ "application/vnd.com.oracle.oraclecloud.metering.cloudbucks+json" ], "parameters":[ { "name":"accountId", "in":"path", "required":true, "type":"string", "description":"Account name, starts with cacct." }, { "name":"entitlementIds", "in":"query", "type":"string", "description":"Comma separated list of Service Entitlement Ids." } ], "responses":{ "200":{ "schema":{ "description":"", "$ref":"#/definitions/json_CloudBucks" }, "headers":{ }, "description":"Success" }, "default":{ "description":"Unexpected error." } }, "summary":"View Subscription Details of an Account", "x-internal-id":"api-v1-cloudbucks-{accountId}-get", "x-filename-id":"api-v1-cloudbucks-accountid-get" } }, "/api/v1/resources/{serviceName}":{ "get":{ "tags":[ "Service Resources" ], "description":"Retrieve resources of a given service.", "operationId":"resource_ResourcesResource_getServiceResources_GET", "produces":[ "application/vnd.com.oracle.oraclecloud.metering.resources+json" ], "parameters":[ { "name":"serviceName", "in":"path", "required":true, "type":"string", "description":"Service name" }, { "name":"applicableComponent", "in":"query", "type":"string", "description":"Whether OPC public cloud or OCM private cloud" }, { "name":"entitlementId", "in":"query", "type":"string", "description":"Service Entitlement Id" } ], "responses":{ "200":{ "schema":{ "description":"", "$ref":"#/definitions/json_Resources" }, "headers":{ }, "description":"Success" }, "default":{ "description":"Unexpected error." } }, "summary":"View Resources of a Service", "x-internal-id":"api-v1-resources-{serviceName}-get", "x-filename-id":"api-v1-resources-servicename-get" } } } }