Retrieves spectro clusters resources cost summary information

POST 
https://api.spectrocloud.com/v1/dashboard/spectroclusters/resources/cost

Authorization: ApiKey

name: ApiKeytype: apiKeydescription: API key authorization where API key can be generated from Palette console under Profile > My API Keysin: header

Retrieves spectro clusters resources cost summary information

Request

Header Parameters

ProjectUid string

Scope the request to the specified project uid

application/json

Body

filter object
Resource cost summary filter
cloudsstring[]
clustersstring[]
endTimedate-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.
includeMasterMachinesboolean
namespacesstring[]
projectsstring[]
startTimedate-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.
workspacesstring[]
options object

Resource cost summary options

enableSummaryViewboolean

Default value: true

groupBystring

Possible values: [tenant, project, workspace, cluster, namespace, deployment, cloud]

Default value: cluster

periodint32

Default value: 60

Responses

200

An array of resources cost summary items

application/json

Schema

Schema

resources object[]
Array [
associatedResources object[]
Array [
kindstring
namestring
uidstringrequired
]
data object[]
Array [
cpufloat64
memoryfloat64
storagefloat64
timestampint64
totalfloat64
]
entity object
kindstring
namestring
uidstringrequired
total object
Resource total cost information
cpufloat64
memoryfloat64
storagefloat64
totalfloat64
]
total object
Resource total cost information
cpufloat64
memoryfloat64
storagefloat64
totalfloat64

Example (from schema)

{
  "resources": [
    {
      "associatedResources": [
        {
          "kind": "string",
          "name": "string",
          "uid": "string"
        }
      ],
      "data": [
        {
          "cpu": 0,
          "memory": 0,
          "storage": 0,
          "timestamp": 0,
          "total": 0
        }
      ],
      "entity": {
        "kind": "string",
        "name": "string",
        "uid": "string"
      },
      "total": {
        "cpu": 0,
        "memory": 0,
        "storage": 0,
        "total": 0
      }
    }
  ],
  "total": {
    "cpu": 0,
    "memory": 0,
    "storage": 0,
    "total": 0
  }
}

• curl
• python
• go
• nodejs
• java

• CURL

curl -L -X POST 'https://api.spectrocloud.com/v1/dashboard/spectroclusters/resources/cost' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'ApiKey: <API_KEY_VALUE>' \
--data-raw '{
  "filter": {
    "clouds": [
      "string"
    ],
    "clusters": [
      "string"
    ],
    "endTime": "2023-12-01T21:31:48.030Z",
    "includeMasterMachines": true,
    "namespaces": [
      "string"
    ],
    "projects": [
      "string"
    ],
    "startTime": "2023-12-01T21:31:48.030Z",
    "workspaces": [
      "string"
    ]
  },
  "options": {
    "enableSummaryView": true,
    "groupBy": "cluster",
    "period": 60
  }
}'

Request Collapse all

Base URL

https://api.spectrocloud.com

Auth

Security Scheme

ApiKeyAuthorization

ApiKey

Parameters

ProjectUid — header

Body

{
  "filter": {
    "clouds": [
      "string"
    ],
    "clusters": [
      "string"
    ],
    "endTime": "2023-12-01T21:31:48.030Z",
    "includeMasterMachines": true,
    "namespaces": [
      "string"
    ],
    "projects": [
      "string"
    ],
    "startTime": "2023-12-01T21:31:48.030Z",
    "workspaces": [
      "string"
    ]
  },
  "options": {
    "enableSummaryView": true,
    "groupBy": "cluster",
    "period": 60
  }
}