Analysis: Kubernetes Container Systems

Analysis: Kubernetes Container Systems

#340660

Description

The /analysis/containers/kubernetes/<analysisId>/systems resource is used to return a collection of all container systems that were included in the Kubernetes optimization analysis.

The number of analyzed systems (i.e. /containers/kubernetes/<analysisId>/systems entities) will always be greater than or equal to the number of system recommendations produced (i.e. /containers/kubernetes/<analysisId>/results entities), as some systems may not have any recommendations. See Analysis: Kubernetes Container Recommendations for details of the Kubernetes container recommendation resource.

Resource

/analysis/containers/kubernetes/<analysisId>/systems

Supported Operations

Table: Kubernetes Container Systems Supported Operations

HTTP Method

Input

Output

Description

GET /analysis/containers/kubernetes/<analysisId>/systems

Path Parameter:

analysisId

Collection of:

Use this resource to return a list of all container systems included in a Kubernetes container analysis.

Example: Listing All Systems in a Kubernetes Container Analysis

Parameters

Path Parameters

Table: Kubernetes Container Systems Path Parameters

Parameter Name

Type

Description

analysisId

string

The unique referenced ID of the Kubernetes container analysis.

Response

Table: Kubernetes Container Systems Response Schema

Element

Type

Filter/Sort

Description

hostName

string

 

The Densify internal reference used to ensure that containers are uniquely identified across multiple clusters, even if they potentially have the same namespace, pod and/or container names.

displayName

string

 

The display name is a combination of the pod and container name.

entityId

string

 

The Densify assigned entity ID of the container system.

href

string

 

The referenced resource to the Densify system entity representing this container.

See Systems for details of the /systems resource.

Examples

Example: Listing All Systems in a Kubernetes Container Analysis

The following example shows you how to return all systems (container) included in a Kubernetes container optimization analysis.

Request:

Copy 
GET /analysis/containers/kubernetes/d7298ac3-a143-41bb-b7d7-62f659f2a8c5/systems

Response:

Copy 
[
   {
      "hostName": "d3cf25f4-01b1-4c0b-66a8-86bd1ea771d3",
      "displayName": "kube-abcserver-kube-ctrl.densify.com__kube-abcserver",
      "entityId": "06770825-988a-4aa4-b047-41bda995a69e",
      "href": "/systems/06770825-988a-4aa4-b047-41bda995a69e"
   },
   {
      "hostName": "e9422b59-97ef-40b1-b589-587a23a761d3",
      "displayName": "kube-scheduler-kube-ctrl.densify.com__kube-scheduler"
      "entityId": "1f7981f5-dd90-416b-88f9-67f032188536",
      "href": "/systems/1f7981f5-dd90-416b-88f9-67f032188536"
   },
   ...
]