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


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

12.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: 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: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata

ObjectMeta_v2

Standard object’s metadata. More info: 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

 

12.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

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

HTTP method
GET
Description
list objects of kind NodeMetrics
Table 12.1. HTTP responses
HTTP codeReponse body

200 - OK

NodeMetricsList schema

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

Table 12.2. Global path parameters
ParameterTypeDescription

name

string

name of the NodeMetrics

HTTP method
GET
Description
read the specified NodeMetrics
Table 12.3. HTTP responses
HTTP codeReponse body

200 - OK

NodeMetrics schema

Red Hat logoGithubRedditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

© 2024 Red Hat, Inc.