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
Possible values: <= 50
limit is a maximum number of responses to return for a list call. Maximum value of the limit is 50.
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 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 token to paginate the subsequent data items
Header Parameters
Scope the request to the specified project uid
- application/json
Body
Array [
Array [
]
]
Array [
]
filter
Possible values: [and, or]
filterGroups
undefined[]
Possible values: [and, or]
filters
undefined[]
condition
bool
date
match
Possible values: [and, or]
Possible values: [eq, gt, gte, lt, lte, range]
float
match
Possible values: [and, or]
Possible values: [eq, gt, gte, lt, lte]
int
match
Possible values: [and, or]
Possible values: [eq, gt, gte, lt, lte]
keyValue
match
Possible values: [and, or]
Possible values: [eq, contains, beginsWith]
string
match
Possible values: [and, or]
Possible values: [eq, contains, beginsWith]
Possible values: [string, int, float, bool, date, keyValue]
sort
undefined[]
Possible values: [environment, clusterName, clusterState, healthState, creationTimestamp, lastModifiedTimestamp]
Possible values: [asc, desc]
Default value: asc
Responses
- 200
An array of edgehost summary items
- application/json
- Schema
- Example (from schema)
Schema
Array [
Array [
Array [
]
]
Array [
Array [
]
]
Array [
]
Array [
]
Array [
]
]
items
object[]
required
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
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.
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
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.
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
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
spec
object
clusterProfileTemplates
object[]
packs
undefined[]
annotations
object
Possible values: [kernel, os, k8s, cni, csi, addon]
device
object
DeviceSpec defines the desired state of Device
Possible values: [arm64, amd64]
Default value: amd64
Architecture type of the edge host
cpu
object
number of cpu cores
disks
object[]
partitions
object[]
Size in GB
gpus
object[]
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
Model is the model of GPU, for a given vendor, for eg., TU104GL [Tesla T4]
Vendor is the GPU vendor, for eg., NVIDIA or AMD
memory
object
memory size in bytes
nics
object[]
os
object
host
Host specifications
HostAddress is a FQDN or IP address of the Host
projectMeta
object
status
object
health
EdgeHostHealth defines the desired health state of EdgeHostDevice
Possible values: [healthy, unhealthy]
inUseClusters
object[]
Possible values: [ready, unpaired, in-use]
listmeta
object
ListMeta describes metadata for the resource listing
Next token for the pagination. Next token is equal to empty string indicates end of result set.
Total count of the resources which might change during pagination based on the resources addition or deletion
Number of records feteched
The next offset for the pagination. Starting index for which next request will be placed.
{
"items": [
{
"metadata": {
"annotations": {},
"creationTimestamp": "2024-07-27T05:12:14.396Z",
"deletionTimestamp": "2024-07-27T05:12:14.396Z",
"labels": {},
"lastModifiedTimestamp": "2024-07-27T05:12:14.396Z",
"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": {
"hostAddress": "string",
"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
}
}