Get Microservice Workloads for a Tree Grids
get
/api/microservice/Workload/readForTree
Gets microservice workloads in a format suitable for tree grids.
Request
Query Parameters
-
node(required): string
The node to start the tree. The response depends on this parameter as follows:
- If this parameter is empty, it returns all the clusters.
- If this parameter lists a cluster in /{cluster} format, it returns all the available namespaces within the cluster.
- If this parameter lists a namespace in /{cluster}/{namespace} format, and the type parameter is set to pod, it returns the list of running pods within the cluster's namespace as leaf nodes with summary details.
Examples -
type(required): string
The type of workload. This parameter is only used if the value of the node parameter is a namespace, /{cluster}/{namespace} format. Possible values are pod, deployment, service, statefulset, job, replicaset, daemonset, and cronjob.Example:
cronjob
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : SuccessfulGetOperation
Type:
Show Source
object
-
message: string
The response message.Example:
Loaded 1 entries
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
true
Nested Schema : type
Type:
Show Source
object
-
data: array
data
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : microserviceWorkloadReadForTree
Type:
Show Source
object
-
id: string
ID of the tree node to which it points toExample:
/cluster-1/a1-cache
-
leaf: boolean
Leaf Node of the treeExample:
false
-
text: string
Namespace typeExample:
a1-cache
Default Response
Failed operation
Root Schema : schema
Type:
Show Source
object
-
errors: array
errors
The list of errors reported. Validation errors will be keyed by record field.
-
message: string
The response message.Example:
Exception thrown
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
false
Nested Schema : errors
Type:
array
The list of errors reported. Validation errors will be keyed by record field.
Show Source
Nested Schema : items
Type:
object