Skip to main content

Retrieves the list of metrics for a specified resource kind

GET 

/v1/metrics/:resourceKind/values

Returns all the metrics for a given resource kind

Request

Path Parameters

    resourceKind stringrequired

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

Query Parameters

    metricKind string

    Default value: all

    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

    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

    spectroClusterUid string

Header Parameters

    ProjectUid string

    Scope the request to the specified project uid

Responses

An array of metric items

Schema

    items

    object[]

    required

  • Array [

  • metadata

    object

    namestring
    uidstring

    metrics

    object[]

  • Array [

  • aggregation

    object

    Aggregation values

    avgnumber
    countint64
    maxnumber
    minnumber
    sumnumber
    kindstring

    points

    object[]

  • Array [

  • avgnumber
    countint64
    maxnumber
    minnumber
    sumnumber
    timestampint64
    valuenumber
  • ]

  • unitstring
  • ]

  • ]

Loading...