// Automatically generated by 'openshift-apidocs-gen'. Do not edit.
:_mod-docs-content-type: ASSEMBLY
[id="nodemetrics-metrics-k8s-io-v1beta1"]
= NodeMetrics [metrics.k8s.io/v1beta1]
:toc: macro
:toc-title:

toc::[]


Description::
+
--
NodeMetrics sets resource usage metrics of a node.
--

Type::
  `object`

Required::
  - `timestamp`
  - `window`
  - `usage`


== Specification

[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `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`
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-ObjectMeta[`ObjectMeta`]
| Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

| `timestamp`
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-Time[`Time`]
| The following fields define time interval from which metrics were collected from the interval [Timestamp-Window, Timestamp].

| `usage`
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-api-resource-Quantity[`object (Quantity)`]
| The memory usage is the memory working set.

| `window`
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-Duration[`Duration`]
| 

|===

== 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
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../objects/index.adoc#io-k8s-metrics-pkg-apis-metrics-v1beta1-NodeMetricsList[`NodeMetricsList`] schema
|===


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

.Global path parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `name`
| `string`
| name of the NodeMetrics
|===


HTTP method::
  `GET`

Description::
  read the specified NodeMetrics


.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../monitoring_apis/nodemetrics-metrics-k8s-io-v1beta1.adoc#nodemetrics-metrics-k8s-io-v1beta1[`NodeMetrics`] schema
|===


