Powered by Algolia

    Metrics

    https://api.spectrocloud.com/v1alpha1/metrics/{resourceKind}/values

    summary:
    Retrieves the list of metrics for a specified resource kind
    description:
    Returns all the metrics for a given resource kind
    Parameters:
    NameTypeDescriptionRequired
    resourceKindstringyes
    metricKindstringno
    startTimestringTime 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.no
    endTimestringTime 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.no
    periodintegerno
    includeMasterMachinesbooleanincludeMasterMachines in boolean, group the data point by including master nodes if set to trueno
    discretebooleanif true then api returns only aggregation values, else api returns all data points by defaultno
    spectroClusterUidstringno
    200
    An array of metric items
    {
    "items": [
    {
    "metadata": {
    "name": "string",
    "uid": "string"
    },
    "metrics": [
    {
    "aggregation": {
    "avg": "number",
    "count": "number",
    "max": "number",
    "min": "number",
    "sum": "number"
    },
    "kind": "string",
    "points": [
    {
    "avg": "number",
    "count": "number",
    "max": "number",
    "min": "number",
    "sum": "number",
    "timestamp": "number",
    "value": "number"
    }
    ],
    "unit": "string"
    }
    ]
    }
    ]
    }

    https://api.spectrocloud.com/v1alpha1/metrics/{resourceKind}/{resourceUid}/values

    summary:
    Returns the metrics for a specified resource uid
    Parameters:
    NameTypeDescriptionRequired
    resourceKindstringyes
    resourceUidstringyes
    metricKindstringmultiple metric kinds can be provided with comma separatedno
    startTimestringTime 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.no
    endTimestringTime 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.no
    periodintegerperiod in minutes, group the data point by the specified periodno
    includeMasterMachinesbooleanincludeMasterMachines in boolean, group the data point by including master nodes if set to trueno
    discretebooleanif true then api returns only aggregation values, else api returns all data points by defaultno
    200
    An array of metric items
    {
    "items": [
    {
    "aggregation": {
    "avg": "number",
    "count": "number",
    "max": "number",
    "min": "number",
    "sum": "number"
    },
    "kind": "string",
    "points": [
    {
    "avg": "number",
    "count": "number",
    "max": "number",
    "min": "number",
    "sum": "number",
    "timestamp": "number",
    "value": "number"
    }
    ],
    "unit": "string"
    }
    ]
    }

    https://api.spectrocloud.com/v1alpha1/metrics/{resourceKind}/{resourceUid}/values

    summary:
    Deletes the metrics of the specified resource
    Parameters:
    NameTypeDescriptionRequired
    resourceKindstringyes
    resourceUidstringyes
    204
    The resource was deleted successfully