这是本节的多页打印视图。点击此处打印.

外部 API

1: Kubernetes 外部指标 (v1beta1)
2: Kubernetes 指标 (v1beta1)
3: Kubernetes 自定义指标 (v1beta2)

1 - Kubernetes 外部指标 (v1beta1)

v1beta1 包是 v1beta1 版本的外部指标 API。

资源类型

ExternalMetricValue
ExternalMetricValueList

`ExternalMetricValue`

出现在：

ExternalMetricValueList

ExternalMetricValue 是外部指标的一个度量值。单个度量值由指标名称和一组字符串标签标识。对于一个指标，可以有多个具有不同标签集的值。

字段	描述
`apiVersion` string	`external.metrics.k8s.io/v1beta1`
`kind` string	`ExternalMetricValue`
`metricName` [必需] `string`	指标的名称。
`metricLabels` [必需] `map[string]string`	用于标识指标的单个时间序列的标签集。
`timestamp` [必需] `meta/v1.Time`	标明这些度量值生成的时间。
`window` [必需] `int64`	当返回根据累积度量计算的速率度量值时，此字段标明计算这些度量值的时间窗口（[Timestamp-Window, Timestamp]）（或对于非计算的瞬时度量值为零）。
`value` [必需] `k8s.io/apimachinery/pkg/api/resource.Quantity`	度量值。

`ExternalMetricValueList`

ExternalMetricValueList 是某个给定指标的某些标签集的数值列表。

字段	描述
`apiVersion` string	`external.metrics.k8s.io/v1beta1`
`kind` string	`ExternalMetricValueList`
`metadata` [必需] `meta/v1.ListMeta`	无描述。
`items` [必需] `[]ExternalMetricValue`	与给定标签集匹配的度量值。

2 - Kubernetes 指标 (v1beta1)

v1beta1 包是 v1beta1 版本的指标 API。

`NodeMetrics`

出现在：

NodeMetricsList

NodeMetrics 设置节点的资源用量指标。

字段	描述
`apiVersion` string	`metrics.k8s.io/v1beta1`
`kind` string	`NodeMetrics`
`metadata` `meta/v1.ObjectMeta`	标准的对象元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata 参阅 Kubernetes API 文档了解 `metadata` 字段。
`timestamp` [必需] `meta/v1.Time`	以下字段定义从时间间隔 [Timestamp-Window，Timestamp] 中收集指标的时间间隔。
`window` [必需] `meta/v1.Duration`	无描述。
`usage` [必需] `core/v1.ResourceList`	内存用量是内存工作集。

`NodeMetricsList`

NodeMetricsList 是 NodeMetrics 的列表。

字段	描述
`apiVersion` string	`metrics.k8s.io/v1beta1`
`kind` string	`NodeMetricsList`
`metadata` [必需] `meta/v1.ListMeta`	标准的列表元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`items` [必需] `[]NodeMetrics`	节点指标的列表。

`PodMetrics`

出现在：

PodMetricsList

PodMetrics 设置 Pod 的资源用量指标。

字段	描述
`apiVersion` string	`metrics.k8s.io/v1beta1`
`kind` string	`PodMetrics`
`metadata` `meta/v1.ObjectMeta`	标准的对象元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata 参阅 Kubernetes API 文档了解 `metadata` 字段。
`timestamp` [必需] `meta/v1.Time`	以下字段定义了从时间间隔 [Timestamp-Window，Timestamp] 中收集指标的时间间隔。
`window` [必需] `meta/v1.Duration`	无描述。
`containers` [必需] `[]ContainerMetrics`	在相同时间窗口内收集所有容器的指标。

`PodMetricsList`

PodMetricsList 是 PodMetrics 的列表。

字段	描述
`apiVersion` string	`metrics.k8s.io/v1beta1`
`kind` string	`PodMetricsList`
`metadata` [必需] `meta/v1.ListMeta`	标准的列表元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`items` [必需] `[]PodMetrics`	Pod 指标的列表。

`ContainerMetrics`

出现在：

PodMetrics

ContainerMetrics 设置容器的资源用量指标。

字段	描述
`name` [必需] `string`	与 pod.spec.containers 中某个对应的容器名称。
`usage` [必需] `core/v1.ResourceList`	内存用量是内容工作集。

3 - Kubernetes 自定义指标 (v1beta2)

v1beta2 包是 v1beta2 版本的 custom_metrics API。

资源类型

MetricListOptions
MetricValue
MetricValueList

`MetricListOptions`

MetricListOptions 用于按其标签选择算符来选择指标。

字段	描述
`apiVersion` string	`custom.metrics.k8s.io/v1beta2`
`kind` string	`MetricListOptions`
`labelSelector` `string`	这个选择算符通过标签来限制所返回对象的列表。默认为任意值。
`metricLabelSelector` `string`	这个选择算符通过标签来限制所返回指标的列表。

`MetricValue`

出现在：

MetricValueList

MetricValue 是某些对象的指标值。

字段	描述
`apiVersion` string	`custom.metrics.k8s.io/v1beta2`
`kind` string	`MetricValue`
`describedObject` [必需] `core/v1.ObjectReference`	指向描述对象的引用。
`metric` [必需] `MetricIdentifier`	无描述。
`timestamp` [必需] `meta/v1.Time`	标明度量值生成的时间。
`windowSeconds` [必需] `int64`	当返回根据累积度量计算的速率度量值时，此字段标明计算这些度量值的时间窗口（[Timestamp-Window, Timestamp]）（或对于非计算的瞬时度量值为零）。
`value` [必需] `k8s.io/apimachinery/pkg/api/resource.Quantity`	度量值。

`MetricValueList`

MetricValueList 是某个给定指标的某些对象集的数值列表。

字段	描述
`apiVersion` string	`custom.metrics.k8s.io/v1beta2`
`kind` string	`MetricValueList`
`metadata` [必需] `meta/v1.ListMeta`	无描述。
`items` [必需] `[]MetricValue`	所描述对象的度量值。

`MetricIdentifier`

出现在：

MetricValue

MetricIdentifier 按名称和可选的选择算符来标识指标。

字段	描述
`name` [必需] `string`	name 是给定指标的名称。
`selector` `meta/v1.LabelSelector`	selector 表示可用于选择此指标的标签选择算符，通常就是传递给查询用于获取此指标的选择算符。当留空时，仅使用指标的 Name 来采集指标。