Jump to

• Request
• Response
• Examples

View Tagged Resource Usage Cost for An Account

get

/metering/api/v1/usagecost/{accountId}/tagged

Retrieve usage cost of all resources tagged with the supplied tags.

Request

Path Parameters

• accountId: string
  Account name, starts with cacct.

Query Parameters

• computeTypeEnabled: string
  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.
• dataCenter: string
  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.
• dcAggEnabled: string
  if Y, then usage cost is grouped per datacenter. This is optional.
• endTime: string
  Specifies the end time of the interval for which usage cost is being retrieved.This is mandatory.
• resourceName: string
  Resource name filter. Example PIC_COMPUTE_VM_STANDARD, PIC_BLOCK_STORAGE_STANDARD etc. This is optional.
• rollupLevel: string
  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.
• serviceEntitlementId: string
  Service Entitlement Id filter. This is optional.
• serviceName: string
  Service name filter. Examples DATATRANSFERBM, EXADATABM. This is optional.
• startTime: string
  Specifies the start of the interval for which usage cost is being retrieved. This is mandatory.
• tags: array
  Collection Format: multi

  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.

  • [0]: string

  {
      "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."
  }

• timeZone: string
  Timezone in which start and end times are specified. Examples UTC, US/Pacific,America/Los_Angeles.
• usageType: string
  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.

Back to Top

Response

Supported Media Types

• application/vnd.com.oracle.oraclecloud.metering.usage+json

200 Response

Success

Body ()

Root Schema : AccountUsageCostRecord

Type: object

Title: AccountUsageCostRecord

Show Source

• accountId(optional): string
• canonicalLink(optional): string
• items(optional): array items

{
    "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":""
}

Nested Schema : items

Type: array

Show Source

• Array of: array items

{
    "description":"",
    "type":"array",
    "items":{
        "type":"array",
        "items":{
            "$ref":"#/definitions/json_UsageCostRecord"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object UsageCostRecord
  Title: UsageCostRecord

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/json_UsageCostRecord"
    }
}

Nested Schema : UsageCostRecord

Type: object

Title: UsageCostRecord

Show Source

• costs(optional): array costs
• currency(optional): string
  Currency.
• dataCenterId(optional): object dataCenterId
  Datacenter Id
• endTimeUtc(optional): object endTimeUtc
  End time of the interval for which cost is returned.
• gsiProductId(optional): string
  GSI product id for the Sku.
• lastComputationDate(optional): object lastComputationDate
  Time at which cost was synced from billing system.
• quantity(optional): number
  Quantity.
• resourceName(optional): string
  Resource Name.
• serviceName(optional): string
  Service Name.
• startTimeUtc(optional): object startTimeUtc
  Start time of the interval for which cost is returned.
• subscriptionId(optional): string
  Purchase Entitlement Id.
• subscriptionType(optional): string
  Trial or production.
• tag(optional): string
  Tag applied on this usage.

{
    "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":""
}

Nested Schema : costs

Type: array

Show Source

• Array of: array items

{
    "description":"",
    "type":"array",
    "items":{
        "type":"array",
        "items":{
            "$ref":"#/definitions/json_UsageCost"
        }
    }
}

Nested Schema : dataCenterId

Type: object

Datacenter Id

Nested Schema : endTimeUtc

Type: object

End time of the interval for which cost is returned.

Nested Schema : lastComputationDate

Type: object

Time at which cost was synced from billing system.

Nested Schema : startTimeUtc

Type: object

Start time of the interval for which cost is returned.

Nested Schema : items

Type: array

Show Source

• Array of: object UsageCost
  Title: UsageCost

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/json_UsageCost"
    }
}

Nested Schema : UsageCost

Type: object

Title: UsageCost

Show Source

• computedAmount(optional): number
  Cost computed for usage.
• computedQuantity(optional): number
  Quantity used for computing cost.
• overagesFlag(optional): string
  If Y, then the cost is an overage.
• rateCardId(optional): string
  GSI rate card identifier.
• unitPrice(optional): number
  Price per unit of resource.

{
    "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":""
}

Default Response

Unexpected error.

Back to Top

Examples

These APIs are deprecated. See Cost Analysis Overview, Using the API for more information on how to track and optimize your Oracle Cloud Infrastructure spending. See Deprecated Notices (Endpoints) to see if there is a replacement endpoint.

Back to Top