Skip to main content
Version: latest

Returns the metrics for a specified resource uid

GET 

/v1/metrics/:resourceKind/:resourceUid/values

Returns the metrics for a specified resource uid

Request

Path Parameters

    resourceKind stringrequired

    Possible values: [pod, namespace, spectrocluster, machine, project]

    resourceUid stringrequired

Query Parameters

    metricKind string

    Default value: all

    multiple metric kinds can be provided with comma separated

    startTime date-time

    Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

    endTime date-time

    Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

    period int32

    Default value: 1

    period in minutes, group the data point by the specified period

    includeMasterMachines boolean

    Deprecated. includeMasterMachines in boolean, group the data point by including control plane nodes if set to true

    includeControlPlaneMachines boolean

    includeControlPlaneMachines in boolean, group the data point by including control plane nodes if set to true

    discrete boolean

    if true then api returns only aggregation values, else api returns all data points by default

Header Parameters

    ProjectUid string

    Scope the request to the specified project uid

Responses

An array of metric items

Schema

    items

    object[]

    required

  • Array [

  • aggregation

    object

    Aggregation values

    avgnumber
    countint64
    maxnumber
    minnumber
    sumnumber
    kindstring

    points

    object[]

  • Array [

  • avgnumber
    countint64
    maxnumber
    minnumber
    sumnumber
    timestampint64
    valuenumber
  • ]

  • unitstring
  • ]

Loading...