Skip to main content
Version: latest

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

POST 

/v1/dashboard/pcgs/search

Retrieves a list of PCG summary with provided search filter. Supported fields as per schema /v1/dashboard/pcgs/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

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 cluster summary items

Schema

    items

    object[]

    required

  • Array [

  • kindstring

    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

    Overload spec

    cloudAccountUidstring
    ipAddressstring

    ipPools

    object[]

  • 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

    pool

    object

    Pool defines IP ranges or with CIDR for available IPs Gateway, Prefix and Nameserver if provided, will overwrite values in IPPool

    endstring

    End is the last IP address that can be rendered. It is used as a validation that the rendered IP is in bound.

    gatewaystring

    Gateway is the gateway ip address

    nameserver

    object

    Nameserver provide information for dns resolvation

    addressesstring[]
    searchstring[]
    prefixint32

    Prefix is the mask of the network as integer (max 128)

    startstring

    Start is the first ip address that can be rendered

    subnetstring

    Subnet is used to validate that the rendered IP is in bounds. eg: 192.168.0.0/24 If Start value is not given, start value is derived from the subnet ip incremented by 1 (start value is 192.168.0.1 for subnet 192.168.0.0/24)

    priavetGatewayUidstring
    restrictToSingleClusterboolean

    if true, restricts this IP pool to be used by single cluster at any time

    status

    object

    IP Pool status

    allottedIpsstring[]
    associatedClustersstring[]
    inUseboolean
  • ]

  • isSelfHostedboolean
    isSystemboolean
    spectroClusterUidstring
    tenantUidstring

    status

    object

    Overload status

    health

    Spectro cluster health status

    agentVersionstring

    conditions

    undefined[]

  • Array [

  • messagestring

    relatedObject

    object

    Object for which the resource is related

    kindstring

    Possible values: [spectrocluster, machine, cloudconfig, clusterprofile, pack, appprofile, appdeployment, edgehost]

    namestring
    uidstring
    typestring
  • ]

  • lastHeartBeatTimestampdate-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.

    statestring
    isActiveboolean
    isReadyboolean
    kubectlCommandsstring[]

    notifications

    Cluster notifications status

    isAvailableboolean
    statestring
  • ]

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