Skip to main content

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: <= 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 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

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​

An array of edgehost summary items

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

    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

    hostAddressstring

    HostAddress is a FQDN or IP address of the Host

    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.

Loading...