eks.clusters.get

One cluster: endpoint, version, status, control-plane readiness

GET /eks/api/clusters/{cluster}IAM eks:DescribeClusterRead

Request syntax

GET /eks/api/clusters/{cluster}

Path parameters

  • clusterRequired

    string

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

Response

200 with the cluster: id, name, regionId, tier, version, kubernetesVersion, availableVersion, latestPatch, status, reconcileError, endpoint, endpointIpv4, allowedCidrs, endpointPublicAccess, endpointPrivateAccess, endpointPrivateIpv4, serviceAccountIssuer, vpcId, podCidr, serviceCidr, controlPlaneNodes, deletionProtection, autoscaler, logging, support, forcedUpgrade, slaPercent, createdAt, …, plus availability (this month’s measured API availability and SLA credit), backup (status, lastSnapshot), upgradeBlockers (what would refuse an upgrade to availableVersion now), upgrade (a control-plane upgrade under way: from, to, replaced, held, canRetry, canCancel; null otherwise), controlPlane (desiredNodes, readyNodes, machines with status, version, lastSeenAt, agent), nodegroupCount and nodegroupsBehind. 404 when no cluster has that id or name, 403 without the permission on it.

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:DescribeCluster 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 clusters get cluster

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