Resource Usage Over Time V1

POST 
/license/api/v1/usage/time_series

Get a breakdown of resource usage over time.

Request

application/json;charset=UTF-8

Body

required

accountIds string[]required

List of account IDs

limit int32

Limit of items per request. Default is 1000.

timeRange objectrequired

Model for TimeRangeConfig

type stringrequired

Possible values: [relative]

value object

Model for RelativeTimeDuration

unit string

Possible values: [minute, hour, day, week, month, year, epoch, login, INVALID, minute, hour, day, week, month, year, epoch, login]

Time unit

amount int32

Number of time units

relativeTimeType string

Possible values: [BACKWARD]

cloudType string

Cloud type values

csvHeaderRequired boolean

CSV file header

Responses

200

Graph query Api response.

application/json;charset=UTF-8

Schema

Schema

dataPoints object[]
Graph GraphDataPoint points
Array [
timeRange object
Time range
startTime objectrequired
Start Time im Millis
empty boolean
present boolean
asLong int64
endTime objectrequired
End Time im Millis
empty boolean
present boolean
asLong int64
counts object
Graph resource usage by cloud type
property name* object
Graph resource usage by cloud type
property name* int32
Graph resource usage by cloud type
]
workloadsPurchased int32

Purchased workload count

timeUnit string

Possible values: [minute, hour, day, week, month, year, epoch, login, INVALID]

Returned data in time unit

availableAsOf int64

Selected data end time in milli second

Example (from schema)

{
  "dataPoints": [
    {
      "timeRange": {
        "startTime": {
          "empty": true,
          "present": true,
          "asLong": 0
        },
        "endTime": {
          "empty": true,
          "present": true,
          "asLong": 0
        }
      },
      "counts": {}
    }
  ],
  "workloadsPurchased": 0,
  "timeUnit": "minute",
  "availableAsOf": 0
}

400

invalid_parameter_value

application/json;charset=UTF-8

Schema

Schema

timestamp stringrequired

timestamp

status int32required

Http status

error stringrequired

Error message

message stringrequired

Error message

path stringrequired

Request path

Example (from schema)

{
  "timestamp": "string",
  "status": 0,
  "error": "string",
  "message": "string",
  "path": "string"
}

403

Forbidden

application/json;charset=UTF-8

Schema

Schema

timestamp stringrequired

timestamp

status int32required

Http status

error stringrequired

Error message

message stringrequired

Error message

path stringrequired

Request path

Example (from schema)

{
  "timestamp": "string",
  "status": 0,
  "error": "string",
  "message": "string",
  "path": "string"
}

Loading...