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
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 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 cluster summary items
- application/json
- Schema
- Example (from schema)
Schema
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
Overload spec
ipPools
object[]
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
pool
object
Pool defines IP ranges or with CIDR for available IPs Gateway, Prefix and Nameserver if provided, will overwrite values in IPPool
End is the last IP address that can be rendered. It is used as a validation that the rendered IP is in bound.
Gateway is the gateway ip address
nameserver
object
Nameserver provide information for dns resolvation
Prefix is the mask of the network as integer (max 128)
Start is the first ip address that can be rendered
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)
if true, restricts this IP pool to be used by single cluster at any time
status
object
IP Pool status
status
object
Overload status
health
Spectro cluster health status
conditions
undefined[]
relatedObject
object
Object for which the resource is related
Possible values: [spectrocluster, machine, cloudconfig, clusterprofile, pack, appprofile, appdeployment, edgehost]
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.
notifications
Cluster notifications status
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": [
{
"kind": "string",
"metadata": {
"annotations": {},
"creationTimestamp": "2024-07-02T18:20:57.830Z",
"deletionTimestamp": "2024-07-02T18:20:57.830Z",
"labels": {},
"lastModifiedTimestamp": "2024-07-02T18:20:57.830Z",
"name": "string",
"uid": "string"
},
"spec": {
"cloudAccountUid": "string",
"ipAddress": "string",
"ipPools": [
{
"metadata": {
"annotations": {},
"creationTimestamp": "2024-07-02T18:20:57.830Z",
"deletionTimestamp": "2024-07-02T18:20:57.830Z",
"labels": {},
"lastModifiedTimestamp": "2024-07-02T18:20:57.830Z",
"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": "2024-07-02T18:20:57.830Z",
"state": "string"
},
"isActive": true,
"isReady": true,
"kubectlCommands": [
"string"
],
"notifications": {
"isAvailable": true
},
"state": "string"
}
}
],
"listmeta": {
"continue": "string",
"count": 0,
"limit": 0,
"offset": 0
}
}