Metrics

→

https://api.spectrocloud.com/v1/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:

Name	Type	Description	Required
resourceKind	string		yes
metricKind	string		no
startTime	string	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.	no
endTime	string	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.	no
period	integer		no
includeMasterMachines	boolean	includeMasterMachines in boolean, group the data point by including master nodes if set to true	no
discrete	boolean	if true then api returns only aggregation values, else api returns all data points by default	no
spectroClusterUid	string		no

HTTP code: 200
Description: An array of metric items
Response body:

{
  "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/v1/metrics/{resourceKind}/{resourceUid}/values

summary:

Returns the metrics for a specified resource uid

Parameters:

Name	Type	Description	Required
resourceKind	string		yes
resourceUid	string		yes
metricKind	string	multiple metric kinds can be provided with comma separated	no
startTime	string	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.	no
endTime	string	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.	no
period	integer	period in minutes, group the data point by the specified period	no
includeMasterMachines	boolean	includeMasterMachines in boolean, group the data point by including master nodes if set to true	no
discrete	boolean	if true then api returns only aggregation values, else api returns all data points by default	no

HTTP code: 200
Description: An array of metric items
Response body:

{
  "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/v1/metrics/{resourceKind}/{resourceUid}/values

summary:

Deletes the metrics of the specified resource

Parameters:

Name	Type	Description	Required
resourceKind	string		yes
resourceUid	string		yes

HTTP code: 204
Description: The resource was deleted successfully

Edit on GitHub