Retrieves a list of Edgehosts summary with provided search filter. Supported fields as per schema /v1/dashboard/edgehosts/search/schema

POST 
/v1/dashboard/edgehosts/search

Retrieves a list of Edgehosts summary with provided search filter. Supported fields as per schema /v1/dashboard/edgehosts/search/schema

Request

Query Parameters

limit int64

Possible values: <= 20

limit is a maximum number of responses to return for a list call. Maximum value of the limit is 20. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results.

offset int64

offset is the next index number from which the response will start. The response offset value can be used along with continue token for the pagination.

continue string

continue token to paginate the subsequent data items

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 edgehost summary 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 are system generated key value metadata for the resource. As an input certain annotations like description can be set
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
Labels are key value data to organize and categorize resources. Providing spectro__tag as value for a label is considered as a kubernetes compliant tag
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 of the resource
uidstring
UID is the unique identifier generated for the resource. This is not an input field for any request.
Populated by the system. Read-only.
spec object
clusterProfileTemplates object[]
Array [
cloudTypestring
namestring
packs undefined[]
Array [
addonTypestring
annotations object
property name*string
displayNamestring
layerstring
Possible values: [kernel, os, k8s, cni, csi, addon]
logoUrlstring
namestring
packUidstring
tagstring
typestring
versionstring
]
typestring
uidstring
versionstring
]
device object
DeviceSpec defines the desired state of Device
archTypestring
Possible values: [arm64, amd64]
Default value: amd64
Architecture type of the edge host
cpu object
coresint32
number of cpu cores
disks object[]
Array [
controllerstring
partitions object[]
Array [
fileSystemTypestring
freeSpaceint32
mountPointstring
totalSpaceint32
usedSpaceint32
]
sizeint32
Size in GB
vendorstring
]
gpus object[]
Array [
addresses object
Addresses is a map of PCI device entry name to its addresses. Example entry would be "11:00.0 VGA compatible controller [0300]: NVIDIA Corporation Device [10de:1eb1] (rev a1)"- > 0000_11_00_0" The address is BDF (Bus Device Function) identifier format seperated by underscores. The first 4 bits are almost always 0000. In the above example 11 is Bus, 00 is Device,0 is function. The values of these addreses are expected in hexadecimal format
property name*string
modelstring
Model is the model of GPU, for a given vendor, for eg., TU104GL [Tesla T4]
vendorstring
Vendor is the GPU vendor, for eg., NVIDIA or AMD
]
memory object
sizeInMBint64
memory size in bytes
nics object[]
Array [
dnsstring[]
gatewaystring
ipstring
isDefaultboolean
macAddrstring
nicNamestring
subnetstring
]
os object
familystring
versionstring
host
Host specifications
macAddressstring
projectMeta object
namestring
uidstring
typestring
status object
health
EdgeHostHealth defines the desired health state of EdgeHostDevice
agentVersionstring
messagestring
statestring
Possible values: [healthy, unhealthy]
inUseClusters object[]
Array [
namestring
uidstring
]
statestring
Possible values: [ready, unpaired, in-use]
]
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": "2023-12-01T21:31:48.508Z",
        "deletionTimestamp": "2023-12-01T21:31:48.508Z",
        "labels": {},
        "lastModifiedTimestamp": "2023-12-01T21:31:48.508Z",
        "name": "string",
        "uid": "string"
      },
      "spec": {
        "clusterProfileTemplates": [
          {
            "cloudType": "string",
            "name": "string",
            "packs": [
              {
                "addonType": "string",
                "annotations": {},
                "displayName": "string",
                "layer": "kernel",
                "logoUrl": "string",
                "name": "string",
                "packUid": "string",
                "tag": "string",
                "type": "string",
                "version": "string"
              }
            ],
            "type": "string",
            "uid": "string",
            "version": "string"
          }
        ],
        "device": {
          "archType": "amd64",
          "cpu": {
            "cores": 0
          },
          "disks": [
            {
              "controller": "string",
              "partitions": [
                {
                  "fileSystemType": "string",
                  "freeSpace": 0,
                  "mountPoint": "string",
                  "totalSpace": 0,
                  "usedSpace": 0
                }
              ],
              "size": 0,
              "vendor": "string"
            }
          ],
          "gpus": [
            {
              "addresses": {},
              "model": "string",
              "vendor": "string"
            }
          ],
          "memory": {
            "sizeInMB": 0
          },
          "nics": [
            {
              "dns": [
                "string"
              ],
              "gateway": "string",
              "ip": "string",
              "isDefault": true,
              "macAddr": "string",
              "nicName": "string",
              "subnet": "string"
            }
          ],
          "os": {
            "family": "string",
            "version": "string"
          }
        },
        "host": {
          "macAddress": "string"
        },
        "projectMeta": {
          "name": "string",
          "uid": "string"
        },
        "type": "string"
      },
      "status": {
        "health": {
          "agentVersion": "string",
          "message": "string",
          "state": "healthy"
        },
        "inUseClusters": [
          {
            "name": "string",
            "uid": "string"
          }
        ],
        "state": "ready"
      }
    }
  ],
  "listmeta": {
    "continue": "string",
    "count": 0,
    "limit": 0,
    "offset": 0
  }
}

Loading...