You are viewing documentation for Kubernetes version: v1.28
Kubernetes v1.28 documentation is no longer actively maintained. The version you are currently viewing is a static snapshot. For up-to-date information, see the latest version.
Kubernetes Metrics (v1beta1)
Package v1beta1 is the v1beta1 version of the metrics API.
Resource Types
NodeMetrics
Appears in:
NodeMetrics sets resource usage metrics of a node.
| Field | Description |
|---|---|
apiVersionstring | metrics.k8s.io/v1beta1 |
kindstring | NodeMetrics |
metadatameta/v1.ObjectMeta
|
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata Refer to the Kubernetes API documentation for the fields of themetadata field. |
timestamp [Required]meta/v1.Time
|
The following fields define time interval from which metrics were collected from the interval [Timestamp-Window, Timestamp]. |
window [Required]meta/v1.Duration
|
No description provided. |
usage [Required]core/v1.ResourceList
|
The memory usage is the memory working set. |
NodeMetricsList
NodeMetricsList is a list of NodeMetrics.
| Field | Description |
|---|---|
apiVersionstring | metrics.k8s.io/v1beta1 |
kindstring | NodeMetricsList |
metadata [Required]meta/v1.ListMeta
|
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
items [Required][]NodeMetrics
|
List of node metrics. |
PodMetrics
Appears in:
PodMetrics sets resource usage metrics of a pod.
| Field | Description |
|---|---|
apiVersionstring | metrics.k8s.io/v1beta1 |
kindstring | PodMetrics |
metadatameta/v1.ObjectMeta
|
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata Refer to the Kubernetes API documentation for the fields of themetadata field. |
timestamp [Required]meta/v1.Time
|
The following fields define time interval from which metrics were collected from the interval [Timestamp-Window, Timestamp]. |
window [Required]meta/v1.Duration
|
No description provided. |
containers [Required][]ContainerMetrics
|
Metrics for all containers are collected within the same time window. |
PodMetricsList
PodMetricsList is a list of PodMetrics.
| Field | Description |
|---|---|
apiVersionstring | metrics.k8s.io/v1beta1 |
kindstring | PodMetricsList |
metadata [Required]meta/v1.ListMeta
|
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
items [Required][]PodMetrics
|
List of pod metrics. |
ContainerMetrics
Appears in:
ContainerMetrics sets resource usage metrics of a container.
| Field | Description |
|---|---|
name [Required]string
|
Container name corresponding to the one from pod.spec.containers. |
usage [Required]core/v1.ResourceList
|
The memory usage is the memory working set. |
This page is automatically generated.
If you plan to report an issue with this page, mention that the page is auto-generated in your issue description. The fix may need to happen elsewhere in the Kubernetes project.