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
| Property | Type | Description |
|---|---|---|
|
|
| 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 |
|
|
| Metrics for all containers are collected within the same time window. |
|
|
| ContainerMetrics sets resource usage metrics of a container. |
|
|
| 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 |
|
| Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
| The following fields define time interval from which metrics were collected from the interval [Timestamp-Window, Timestamp]. | |
|
|
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
-
| Property | Type | Description |
|---|---|---|
|
|
| Container name corresponding to the one from pod.spec.containers. |
|
| 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
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
13.2.2. /apis/metrics.k8s.io/v1beta1/namespaces/{namespace}/pods
- HTTP method
-
GET - Description
- list objects of kind PodMetrics
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
13.2.3. /apis/metrics.k8s.io/v1beta1/namespaces/{namespace}/pods/{name}
| Parameter | Type | Description |
|---|---|---|
|
|
| name of the PodMetrics |
- HTTP method
-
GET - Description
- read the specified PodMetrics
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
