---
title: "returns detailed information about Node"
method: GET
path: "/api/v1/node/{name}"
---

# returns detailed information about Node

`GET /api/v1/node/{name}`

## Path parameters

- `name` string, required

## Query parameters

- `filterBy` string
- `sortBy` string
- `itemsPerPage` string
- `page` string
- `metricNames` string
- `aggregations` string

## Response `200`

OK

- NodeNodeDetail
  - `addresses` V1NodeAddress[]
    - `address` string, required — The node address.
    - `type` string, required — Node address type, one of Hostname, ExternalIP or InternalIP.
  - `allocatedResources` NodeNodeAllocatedResources, required
    - `allocatedPods` integer, required
    - `cpuCapacity` integer, required
    - `cpuLimits` integer, required
    - `cpuLimitsFraction` number, double, required
    - `cpuRequests` integer, required
    - `cpuRequestsFraction` number, double, required
    - `memoryCapacity` integer, required
    - `memoryLimits` integer, required
    - `memoryLimitsFraction` number, double, required
    - `memoryRequests` integer, required
    - `memoryRequestsFraction` number, double, required
    - `podCapacity` integer, required
    - `podFraction` number, double, required
  - `conditions` CommonCondition[], required
    - `lastProbeTime` V1Time, required
      - `Time` string, date-time, required
    - `lastTransitionTime` V1Time, required
      - `Time` string, date-time, required
    - `message` string, required
    - `reason` string, required
    - `status` string, required
    - `type` string, required
  - `containerImages` string[], required
  - `errors` Error[], required
    - unknown
  - `eventList` CommonEventList, required
    - `errors` Error[], required
      - unknown
    - `events` CommonEvent[], required
      - `count` integer, required
      - `firstSeen` V1Time, required
        - `Time` string, date-time, required
      - `lastSeen` V1Time, required
        - `Time` string, date-time, required
      - `message` string, required
      - `object` string, required
      - `objectKind` string
      - `objectMeta` TypesObjectMeta, required
        - `annotations` object
        - `creationTimestamp` V1Time
          - `Time` string, date-time, required
        - `labels` object
        - `name` string
        - `namespace` string
        - `uid` string
      - `objectName` string
      - `objectNamespace` string
      - `reason` string, required
      - `sourceComponent` string, required
      - `sourceHost` string, required
      - `type` string, required
      - `typeMeta` TypesTypeMeta, required
        - `kind` string
        - `restartable` boolean
        - `scalable` boolean
    - `listMeta` TypesListMeta, required
      - `totalItems` integer, required
  - `metrics` ApiMetric[], required
    - `aggregation` string
    - `dataPoints` ApiDataPoint[], required
      - `x` integer, required
      - `y` integer, required
    - `metricName` string, required
    - `metricPoints` ApiMetricPoint[], required
      - `timestamp` string, date-time, required
      - `value` integer, required
  - `nodeInfo` V1NodeSystemInfo, required — NodeSystemInfo is a set of ids/uuids to uniquely identify the node.
    - `architecture` string, required — The Architecture reported by the node
    - `bootID` string, required — Boot ID reported by the node.
    - `containerRuntimeVersion` string, required — ContainerRuntime Version reported by the node through runtime remote API (e.g. containerd://1.4.2).
    - `kernelVersion` string, required — Kernel Version reported by the node from 'uname -r' (e.g. 3.16.0-0.bpo.4-amd64).
    - `kubeProxyVersion` string, required — KubeProxy Version reported by the node.
    - `kubeletVersion` string, required — Kubelet Version reported by the node.
    - `machineID` string, required — MachineID reported by the node. For unique machine identification in the cluster this field is preferred. Learn more from man(5) machine-id: http://man7.org/linux/man-pages/man5/machine-id.5.html
    - `operatingSystem` string, required — The Operating System reported by the node
    - `osImage` string, required — OS Image reported by the node from /etc/os-release (e.g. Debian GNU/Linux 7 (wheezy)).
    - `systemUUID` string, required — SystemUUID reported by the node. For unique machine identification MachineID is preferred. This field is specific to Red Hat hosts https://access.redhat.com/documentation/en-us/red_hat_subscription_management/1/html/rhsm/uuid
  - `objectMeta` TypesObjectMeta, required
    - `annotations` object
    - `creationTimestamp` V1Time
      - `Time` string, date-time, required
    - `labels` object
    - `name` string
    - `namespace` string
    - `uid` string
  - `phase` string, required
  - `podCIDR` string, required
  - `podList` PodPodList, required
    - `cumulativeMetrics` ApiMetric[], required
      - `aggregation` string
      - `dataPoints` ApiDataPoint[], required
        - `x` integer, required
        - `y` integer, required
      - `metricName` string, required
      - `metricPoints` ApiMetricPoint[], required
        - `timestamp` string, date-time, required
        - `value` integer, required
    - `errors` Error[], required
      - unknown
    - `listMeta` TypesListMeta, required
      - `totalItems` integer, required
    - `pods` PodPod[], required
      - `allocatedResources` PodPodAllocatedResources, required
        - `cpuLimits` integer, required
        - `cpuRequests` integer, required
        - `memoryLimits` integer, required
        - `memoryRequests` integer, required
      - `containerImages` string[], required
      - `containerStatuses` PodContainerStatus[], required
        - `name` string, required
        - `ready` boolean, required
        - `state` string, required
      - `metrics` PodPodMetrics, required
        - `cpuUsage` integer, required
        - `cpuUsageHistory` ApiMetricPoint[], required
          - `timestamp` string, date-time, required
          - `value` integer, required
        - `memoryUsage` integer, required
        - `memoryUsageHistory` ApiMetricPoint[], required
          - `timestamp` string, date-time, required
          - `value` integer, required
      - `nodeName` string, required
      - `objectMeta` TypesObjectMeta, required
        - `annotations` object
        - `creationTimestamp` V1Time
          - `Time` string, date-time, required
        - `labels` object
        - `name` string
        - `namespace` string
        - `uid` string
      - `restartCount` integer, required
      - `status` string, required
      - `typeMeta` TypesTypeMeta, required
        - `kind` string
        - `restartable` boolean
        - `scalable` boolean
      - `warnings` CommonEvent[], required
        - `count` integer, required
        - `firstSeen` V1Time, required
          - `Time` string, date-time, required
        - `lastSeen` V1Time, required
          - `Time` string, date-time, required
        - `message` string, required
        - `object` string, required
        - `objectKind` string
        - `objectMeta` TypesObjectMeta, required
          - `annotations` object
          - `creationTimestamp` V1Time
            - `Time` string, date-time, required
          - `labels` object
          - `name` string
          - `namespace` string
          - `uid` string
        - `objectName` string
        - `objectNamespace` string
        - `reason` string, required
        - `sourceComponent` string, required
        - `sourceHost` string, required
        - `type` string, required
        - `typeMeta` TypesTypeMeta, required
          - `kind` string
          - `restartable` boolean
          - `scalable` boolean
    - `status` CommonResourceStatus, required
      - `failed` integer, required
      - `pending` integer, required
      - `running` integer, required
      - `succeeded` integer, required
      - `terminating` integer, required
  - `providerID` string, required
  - `ready` string, required
  - `taints` V1Taint[]
    - `effect` string, required — Required. The effect of the taint on pods that do not tolerate the taint. Valid effects are NoSchedule, PreferNoSchedule and NoExecute.
    - `key` string, required — Required. The taint key to be applied to a node.
    - `timeAdded` V1Time
      - `Time` string, date-time, required
    - `value` string — The taint value corresponding to the taint key.
  - `typeMeta` TypesTypeMeta, required
    - `kind` string
    - `restartable` boolean
    - `scalable` boolean
  - `unschedulable` boolean, required

---

[API](https://skmtc.net/karmada-io/apis/kubernetes-dashboard-api.md) · [All operations](https://skmtc.net/karmada-io/apis/kubernetes-dashboard-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/karmada-io/kubernetes-dashboard-api/versions/8521b53800a7/schema)
