Get Usage Overview | Usage Management Public APIs

Get Usage Overview

The API allows you to get a summary of the usage information for a given service identifier and metric identifier in an organization. The API returns the total usage, commitment, and overage values based on the latest updated usage information. You can specify an end date to filter the usages by their latest update time prior to the time specified. If you do not specify an end date, the API will use the latest update time as the end date.

Request

URI

GET

https://console.cloud.vmware.com/commerce/cost-and-usage/api/{org_id}/usage/overview

COPY

Path Parameters

string

org_id

Required

Unique identifier (GUID) of the organization

Query Parameters

string

service_definition_id

Required

Unique identifier of the service

string

metric_id

Required

Unique identifier of the metric

string

locale

Optional

Locale with language preference (e.g. en_US)

string

end_date

Optional

Filtering criteria based on latest update time (yyyy-mm-dd)

Responses

200

Returns UsageOverviewResponse of type(s) application/json

{
    "metadata": {
        "metric_id": "<metric ID for vRNI vCPUs Public Cloud>",
        "service_definition_id": "<service definition ID for VMC-AWS>",
        "display_name": "i3en US West 2",
        "unit_of_measure_display_name": "Hosts",
        "charge_attributes": {
            "category": "HOST_USAGE"
        }
    },
    "usages": [
        {
            "commitment": 3,
            "usage": 3,
            "overage": 0,
            "status": "AT_COMMITMENT",
            "seller": "VMWARE",
            "last_updated": "2021-06-20T01:02:03.000Z",
            "resources": [
                {
                    "resource_id": "res1",
                    "usage_quantity": 10
                }
            ]
        }
    ]
}

MetricMetadata

metadata

Required

metadata

array of UsageInfo

usages

Required

usages

400

Bad Request

Returns ApiError of type(s) application/json

{
    "error_code": "string",
    "error_message": "string",
    "error_details": [
        {
            "error_code": "string",
            "error_message": "string"
        }
    ]
}

string

error_code

Required

The code associated with the error

string

error_message

Required

A description of the error that occurred

array of ApiValidationError

error_details

Optional

Additional error details for ValidationException errors