Jump to

• Request
• Response

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

  Select an example example1 example2 example3

• type: 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 Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulGetOperation
  The response body for a successful get operation.
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulGetOperation"
        },
        {
            "type":"object",
            "properties":{
                "total":{
                    "description":"The total number of results regardless of paging.",
                    "type":"integer",
                    "example":"1"
                },
                "data":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/microserviceWorkloadReadForTree"
                    }
                }
            }
        }
    ]
}

Nested Schema : SuccessfulGetOperation

Type: object

The response body for a successful get operation.

Show Source

• message: string
  The response message.

  Example: Loaded 1 entries
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: true

{
    "description":"The response body for a successful get operation.",
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Loaded 1 entries"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• data: array data
• total: integer
  The total number of results regardless of paging.

  Example: 1

{
    "type":"object",
    "properties":{
        "total":{
            "description":"The total number of results regardless of paging.",
            "type":"integer",
            "example":"1"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/microserviceWorkloadReadForTree"
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object microserviceWorkloadReadForTree

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/microserviceWorkloadReadForTree"
    }
}

Nested Schema : microserviceWorkloadReadForTree

Type: object

Show Source

• id: string
  ID of the tree node to which it points to

  Example: /cluster-1/a1-cache
• leaf: boolean
  Leaf Node of the tree

  Example: false
• text: string
  Namespace type

  Example: a1-cache

{
    "properties":{
        "id":{
            "description":"ID of the tree node to which it points to",
            "type":"string",
            "example":"/cluster-1/a1-cache"
        },
        "leaf":{
            "description":"Leaf Node of the tree",
            "type":"boolean",
            "example":false
        },
        "text":{
            "description":"Namespace type",
            "type":"string",
            "example":"a1-cache"
        }
    },
    "type":"object"
}

Default Response

Failed operation

Body ()

Root Schema : schema

Type: object

Show Source

• 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

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"false"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Exception thrown"
        },
        "errors":{
            "description":"The list of errors reported. Validation errors will be keyed by record field.",
            "type":"array",
            "items":{
                "description":"An error.",
                "type":"object"
            }
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

The list of errors reported. Validation errors will be keyed by record field.

Show Source

• Array of: object items
  An error.

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "description":"An error.",
        "type":"object"
    }
}

Nested Schema : items

Type: object

An error.

Back to Top