DescribeNodegroup#

Description#

Request to receive node group parameters.

Request Syntax#

 GET /clusters/name/node-groups/nodegroupName HTTP/1.1

URI Request Parameters#

The request uses the following URI parameters.

  • name — The name of the cluster containing the node group.

    • Type: String

    • Required: Yes

  • nodegroupName — The name of the node group.

    • Type: String

    • Required: Yes

Request Parameters#

Request body is absent.

Response Syntax#

 HTTP/1.1 200
 Content-type: application/json

 {
    "nodegroup": {
       "capacityType": "string",
       "clusterName": "string",
       "createdAt": number,
       "diskSize": number,
       "health": {
          "issues": [
             {
                "code": "string",
                "message": "string",
                "resourceIds": [ "string" ]
             }
          ]
       },
       "instanceTypes": [ "string" ],
       "labels": {
          "string" : "string"
       },
       "launchTemplate": {
          "id": "string",
          "name": "string",
          "version": "string"
       },
       "modifiedAt": number,
       "nodegroupArn": "string",
       "nodegroupName": "string",
       "nodeRole": "string",
       "remoteAccess": {
          "ec2SshKey": "string",
       },
       "resources": {
          "autoScalingGroups": [
             {
                "name": "string"
             }
          ],
       },
       "scalingConfig": {
          "desiredSize": number,
          "maxSize": number,
          "minSize": number
       },
       "status": "string",
       "subnets": [ "string" ],
       "tags": {
          "string" : "string"
       },
       "taints": [
          {
             "effect": "string",
             "key": "string",
             "value": "string"
          }
       ],
       "updateConfig": {
          "maxUnavailable": number,
          "maxUnavailablePercentage": number
       },
       "version": "string"
    }
 }

Response Elements#

If the request is executed successfully, API will return an HTTP response with 200 code. The response contains the following data in JSON format.

  • nodegroup — The full description of the requested node group.

Examples#

boto3 K2 Cloud boto3 Client
import boto3

session = boto3.Session(
   aws_access_key_id="<AWS_ACCESS_KEY_ID>",
   aws_secret_access_key="<AWS_SECRET_ACCESS_KEY>",
   region_name="",
)

eks_client = session.client(
   'eks',
   endpoint_url='https://eks.k2.cloud/',
)

eks_client.describe_nodegroup(clusterName="production", nodegroupName="first")
c2-eks K2 Cloud API Client
c2-eks DescribeNodegroup clusterName production nodegroupName first
aws-cli
aws eks --endpoint https://eks.k2.cloud/ describe-nodegroup --cluster-name production --nodegroup-name first