Skip to main content

NodeMetrics [metrics.k8s.io/v1beta1]

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

Specification​

PropertyTypeDescription
apiVersionstringAPIVersion 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
kindstringKind 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
metadataObjectMetaStandard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
timestampTimeThe following fields define time interval from which metrics were collected from the interval [Timestamp-Window, Timestamp].
usageobject (Quantity)The memory usage is the memory working set.
windowDuration

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

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

HTTP method
`GET`
Description
list objects of kind NodeMetrics

HTTP responses

HTTP codeReponse body
200 - OKNodeMetricsList schema

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

Global path parameters

ParameterTypeDescription
namestringname of the NodeMetrics
HTTP method
`GET`
Description
read the specified NodeMetrics

HTTP responses

HTTP codeReponse body
200 - OKNodeMetrics schema