Retrieves a list of cluster metadata with provided search filter spec Supported sort fields - ['environment', 'clusterName', 'clusterState', 'creationTimestamp', 'lastModifiedTimestamp']

POST 
/v1/dashboard/spectroclusters/metadata/search

Retrieves a list of cluster metadata with provided search filter spec Supported sort fields - ["environment", "clusterName", "clusterState", "creationTimestamp", "lastModifiedTimestamp"]

Request

Header Parameters

ProjectUid string

Scope the request to the specified project uid

application/json

Body

filter

conjunctionstringnullable

Possible values: [and, or]

filterGroups

undefined[]

Array [

conjunctionstringnullable

Possible values: [and, or]

filters

undefined[]

Array [

condition

bool

valueboolean

date

match

conjunctionstringnullable

Possible values: [and, or]

valuesdate-time[]

negationboolean

operatorstring

Possible values: [eq, gt, gte, lt, lte, range]

float

match

conjunctionstringnullable

Possible values: [and, or]

valuesfloat64[]

negationboolean

operatorstring

Possible values: [eq, gt, gte, lt, lte]

int

match

conjunctionstringnullable

Possible values: [and, or]

valuesinteger[]

negationboolean

operatorstring

Possible values: [eq, gt, gte, lt, lte]

keyValue

ignoreCaseboolean

keystring

match

conjunctionstringnullable

Possible values: [and, or]

valuesstring[]

negationboolean

operatorstring

Possible values: [eq, contains, beginsWith]

string

ignoreCaseboolean

match

conjunctionstringnullable

Possible values: [and, or]

valuesstring[]

negationboolean

operatorstring

Possible values: [eq, contains, beginsWith]

propertystring

typestring

Possible values: [string, int, float, bool, date, keyValue]

]

]

sort

undefined[]

Array [

fieldstringnullable

Possible values: [environment, clusterName, clusterState, healthState, creationTimestamp, lastModifiedTimestamp]

orderstring

Possible values: [asc, desc]

Default value: asc

]

Responses

200

An array of cluster summary meta items

application/json

Schema

Schema

items

object[]

required

Array [

metadata

object

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

annotations

object

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations

property name*string

creationTimestampdate-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.

deletionTimestampdate-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.

labels

object

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels

property name*string

lastModifiedTimestampdate-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.

namestring

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names

uidstring

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

specSummary

object

Spectro cluster meta summary

archTypestring[]

Possible values: [arm64, amd64]

Architecture type of the cluster

cloudAccountUidstring

cloudRegionstring

cloudTypestring

clusterTypestring

importModestring

location

object

Cluster location information

coordinatesfloat64[]

countryCodestring

countryNamestring

regionCodestring

regionNamestring

projectMeta

object

namestring

uidstring

tagsstring[]

status

Spectro cluster meta status summary

cost

object

Cluster meta Cost information

totalfloat64

fips

modestring

Possible values: [full, none, partial, unknown]

Default value: none

health

object

Cluster meta health information

isHeartBeatFailedboolean

statestring

statestring

updates

object

Cluster meta updates information

isUpdatesPendingboolean

]

listmeta

object

ListMeta describes metadata for the resource listing

continuestring

Next token for the pagination. Next token is equal to empty string indicates end of result set.

countinteger

Total count of the resources which might change during pagination based on the resources addition or deletion

limitinteger

Number of records feteched

offsetinteger

The next offset for the pagination. Starting index for which next request will be placed.

Example (from schema)

{
  "items": [
    {
      "metadata": {
        "annotations": {},
        "creationTimestamp": "2024-07-03T13:23:53.052Z",
        "deletionTimestamp": "2024-07-03T13:23:53.052Z",
        "labels": {},
        "lastModifiedTimestamp": "2024-07-03T13:23:53.052Z",
        "name": "string",
        "uid": "string"
      },
      "specSummary": {
        "archType": [
          "amd64"
        ],
        "cloudAccountUid": "string",
        "cloudRegion": "string",
        "cloudType": "string",
        "clusterType": "string",
        "importMode": "string",
        "location": {
          "coordinates": [
            0
          ],
          "countryCode": "string",
          "countryName": "string",
          "regionCode": "string",
          "regionName": "string"
        },
        "projectMeta": {
          "name": "string",
          "uid": "string"
        },
        "tags": [
          "string"
        ]
      },
      "status": {
        "cost": {
          "total": 0
        },
        "fips": {
          "mode": "none"
        },
        "health": {
          "isHeartBeatFailed": true,
          "state": "string"
        },
        "state": "string",
        "updates": {
          "isUpdatesPending": true
        }
      }
    }
  ],
  "listmeta": {
    "continue": "string",
    "count": 0,
    "limit": 0,
    "offset": 0
  }
}

Loading...