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

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 items

application/json

Schema

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 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
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 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
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[]
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.

Example (from schema)

{
  "items": [
    {
      "kind": "string",
      "metadata": {
        "annotations": {},
        "creationTimestamp": "2023-12-01T21:31:48.513Z",
        "deletionTimestamp": "2023-12-01T21:31:48.513Z",
        "labels": {},
        "lastModifiedTimestamp": "2023-12-01T21:31:48.513Z",
        "name": "string",
        "uid": "string"
      },
      "spec": {
        "cloudAccountUid": "string",
        "ipAddress": "string",
        "ipPools": [
          {
            "metadata": {
              "annotations": {},
              "creationTimestamp": "2023-12-01T21:31:48.514Z",
              "deletionTimestamp": "2023-12-01T21:31:48.514Z",
              "labels": {},
              "lastModifiedTimestamp": "2023-12-01T21:31:48.514Z",
              "name": "string",
              "uid": "string"
            },
            "spec": {
              "pool": {
                "end": "string",
                "gateway": "string",
                "nameserver": {
                  "addresses": [
                    "string"
                  ],
                  "search": [
                    "string"
                  ]
                },
                "prefix": 0,
                "start": "string",
                "subnet": "string"
              },
              "priavetGatewayUid": "string",
              "restrictToSingleCluster": true
            },
            "status": {
              "allottedIps": [
                "string"
              ],
              "associatedClusters": [
                "string"
              ],
              "inUse": true
            }
          }
        ],
        "isSelfHosted": true,
        "isSystem": true,
        "spectroClusterUid": "string",
        "tenantUid": "string"
      },
      "status": {
        "health": {
          "agentVersion": "string",
          "conditions": [
            {
              "message": "string",
              "relatedObject": {
                "kind": "spectrocluster",
                "name": "string",
                "uid": "string"
              },
              "type": "string"
            }
          ],
          "lastHeartBeatTimestamp": "2023-12-01T21:31:48.514Z",
          "state": "string"
        },
        "isActive": true,
        "isReady": true,
        "kubectlCommands": [
          "string"
        ],
        "state": "string"
      }
    }
  ],
  "listmeta": {
    "continue": "string",
    "count": 0,
    "limit": 0,
    "offset": 0
  }
}

Loading...