eks.nodegroups.get

One node group and its nodes

GET /eks/api/clusters/{cluster}/nodegroups/{name}IAM eks:DescribeNodegroupRead

Request syntax

GET /eks/api/clusters/{cluster}/nodegroups/{name}

Path parameters

  • clusterRequired

    string

    Constraints: /^(ewk-[0-9a-f]{12}|[a-z]([a-z0-9-]{0,38}[a-z0-9])?)$/

  • nameRequired

    string

    Constraints: /^[a-z]([a-z0-9-]{0,30}[a-z0-9])?$/

Response

200 with the node group: id, name, instanceType, minSize, desiredSize, maxSize, labels, taints, version, nodeRoleId, autoscaling, zones, drainTimeoutMinutes, forceAfterTimeout, status, reconcileError, readyNodes, nodes (name, instanceId, status, version, zone, drainMessage, privateIpv4, publicIpv4, createdAt), createdAt. 404 for an unknown cluster or node group (403 without eks:DescribeNodegroup on it, checked before the node group is looked up).

A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.

Errors

  • 400The request does not pass the schema above. The body is { "error": …, "issues": […] }, one issue per field.
  • 401No credentials, or an access key that is unknown, revoked or expired.
  • 403The caller's policies do not allow eks:DescribeNodegroup on this resource. The body names the action and the resource, and the refusal is recorded in the audit log.
  • 404The resource does not exist in your organization.

Examples

The required parameters only, with example values. Replace id and the other placeholders with your own.

dcloud eks nodegroups get cluster name

Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_eks_nodegroups_get.