Chapter 13. NodeMetrics [metrics.k8s.io/v1beta1]

Description
NodeMetrics sets resource usage metrics of a node.
Type
object
Required
  • timestamp
  • window
  • usage

13.1. Specification

PropertyTypeDescription

apiVersion

string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: Content from git.k8s.io is not included.https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind

string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: Content from git.k8s.io is not included.https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata

ObjectMeta

Standard object’s metadata. More info: Content from git.k8s.io is not included.https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

timestamp

Time

The following fields define time interval from which metrics were collected from the interval [Timestamp-Window, Timestamp].

usage

object (Quantity)

The memory usage is the memory working set.

window

Duration

 

13.2. API endpoints

The following API endpoints are available:

  • /apis/metrics.k8s.io/v1beta1/nodes

    • GET: list objects of kind NodeMetrics
  • /apis/metrics.k8s.io/v1beta1/nodes/{name}

    • GET: read the specified NodeMetrics

13.2.1. /apis/metrics.k8s.io/v1beta1/nodes

HTTP method
GET
Description
list objects of kind NodeMetrics

Table 13.1. HTTP responses

HTTP codeReponse body

200 - OK

NodeMetricsList schema

13.2.2. /apis/metrics.k8s.io/v1beta1/nodes/{name}

Table 13.2. Global path parameters

ParameterTypeDescription

name

string

name of the NodeMetrics

HTTP method
GET
Description
read the specified NodeMetrics

Table 13.3. HTTP responses

HTTP codeReponse body

200 - OK

NodeMetrics schema