Get Tenant Platform Usage

API code: GET_TENANT_PLATFORM_USAGE
Pre-authorized role(s): PROVIDER_ADMIN
Platform(s): CLOUDIAN

Request

URI

GET

https://apaas-29.eng.vmware.com//api/v1/core/tenants/{tenantId}/platform-usage

COPY

Path Parameters

string

tenantId

Required

The full tenant ID or tenant name. It must be URL encoded.

Query Parameters

string

operation

Optional

The type of service usage data to retrieve. Supported values are: SB, SO, HG, HP and HD. Please refer Cloudian Usage API document for the details.

string

start-time

Required

The start time of the interval for which to retrieve usage data. Format is yyyyMMddHHmm. For retrieving bucket usage data, the start time's "mm" (the minutes) must be 00.

string

end-time

Required

The end time in GMT of the interval for which to retrieve usage data. Format is yyyyMMddHHmm. For retrieving bucket usage data, the end time's "mm" (the minutes) must be 00.

string

granularity

Optional

The time period granularity of the usage data to retrieve or generate or delete. Supported values are: hour (Hourly rollup data), day (Daily rollup data), month (Monthly rollup data) and raw (Raw transactional data not rolled up). This is supported only for a GET or DELETE. For a GET with granularity "raw", the interval between "startTime" and "endTime" must not exceed 24 hours.

string

region

Optional

The region of a resource.

string

region-offset

Optional

Specifies the region to start with when query muti-region usage items. When a request use a "region" value of "ALL", then use the "regionOffset" parameter to specify the region name of your local region. This helps with pagination of the result set.

integer

page-size

Optional

The maximum number of results to return per request. This parameter is not supported if you are retrieving bucket usage data.

string

timestamp-marker

Optional

Specifies the timestamp to start with when query usage items. When the number of usage items in the response exceeds the value of page-size, nextTimestampMarker in the response specifies the first timestamp not returned that satisfies the search criteria. Use this value for the timestamp-marker request parameter in a subsequent request.

Authentication

This operation uses the following authentication methods.

Bearer Authentication

Responses

200

Returns PlatformUsage of type(s) application/json

{
    "granularity": "string",
    "timestampMarker": "string",
    "nextTimestampMarker": "string",
    "regionOffset": "string",
    "nextRegionOffset": "string",
    "items": [
        {
            "operation": "string",
            "unit": "string",
            "value": "string",
            "count": "string",
            "averageValue": "string",
            "maxValue": "string",
            "tenantId": "string",
            "storageTenantId": "string",
            "region": "string",
            "timestamp": "string",
            "uri": "string",
            "ip": "string",
            "policyId": "string",
            "whitelistAverageValue": "string",
            "whitelistCount": "string",
            "whitelistMaxValue": "string",
            "whitelistValue": "string",
            "shared": false
        }
    ],
    "truncated": false
}

string

granularity

Optional

granularity

string

timestampMarker

Optional

timestampMarker

string

nextTimestampMarker

Optional

nextTimestampMarker