DescribeNodegroup

Describes a managed node group.

Request Syntax

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

URI Request Parameters

The request uses the following URI parameters.

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
   "nodegroup": { 
      "amiType": "string",
      "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",
      "nodeRepairConfig": { 
         "enabled": boolean,
         "maxParallelNodesRepairedCount": number,
         "maxParallelNodesRepairedPercentage": number,
         "maxUnhealthyNodeThresholdCount": number,
         "maxUnhealthyNodeThresholdPercentage": number,
         "nodeRepairConfigOverrides": [ 
            { 
               "minRepairWaitTimeMins": number,
               "nodeMonitoringCondition": "string",
               "nodeUnhealthyReason": "string",
               "repairAction": "string"
            }
         ]
      },
      "nodeRole": "string",
      "releaseVersion": "string",
      "remoteAccess": { 
         "ec2SshKey": "string",
         "sourceSecurityGroups": [ "string" ]
      },
      "resources": { 
         "autoScalingGroups": [ 
            { 
               "name": "string"
            }
         ],
         "remoteAccessSecurityGroup": "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,
         "updateStrategy": "string"
      },
      "version": "string",
      "warmPoolConfig": { 
         "enabled": boolean,
         "maxGroupPreparedCapacity": number,
         "minSize": number,
         "poolState": "string",
         "reuseOnScaleIn": boolean
      }
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Errors

For information about the errors that are common to all actions, see Common Errors.