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

Description
PodMetrics sets resource usage metrics of a pod.
Type
object
Required
  • timestamp
  • window
  • containers

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

containers

array

Metrics for all containers are collected within the same time window.

containers[]

object

ContainerMetrics sets resource usage metrics of a container.

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

window

Duration

 

13.1.1. .containers

Description
Metrics for all containers are collected within the same time window.
Type
array

13.1.2. .containers[]

Description
ContainerMetrics sets resource usage metrics of a container.
Type
object
Required
  • name
  • usage
PropertyTypeDescription

name

string

Container name corresponding to the one from pod.spec.containers.

usage

object (Quantity)

The memory usage is the memory working set.

13.2. API endpoints

The following API endpoints are available:

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

    • GET: list objects of kind PodMetrics

  • /apis/metrics.k8s.io/v1beta1/namespaces/{namespace}/pods

    • GET: list objects of kind PodMetrics

  • /apis/metrics.k8s.io/v1beta1/namespaces/{namespace}/pods/{name}

    • GET: read the specified PodMetrics

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

HTTP method
GET
Description
list objects of kind PodMetrics

Table 13.1. HTTP responses

HTTP codeReponse body

200 - OK

PodMetricsList schema

13.2.2. /apis/metrics.k8s.io/v1beta1/namespaces/{namespace}/pods

HTTP method
GET
Description
list objects of kind PodMetrics

Table 13.2. HTTP responses

HTTP codeReponse body

200 - OK

PodMetricsList schema

13.2.3. /apis/metrics.k8s.io/v1beta1/namespaces/{namespace}/pods/{name}

Table 13.3. Global path parameters

ParameterTypeDescription

name

string

name of the PodMetrics

HTTP method
GET
Description
read the specified PodMetrics

Table 13.4. HTTP responses

HTTP codeReponse body

200 - OK

PodMetrics schema