Red Hat Summit 红帽全球峰会支持控制台（Console）开发人员开始试用联系人

1.12. Observability API

deprecated ： API 的文档已弃用。使用控制台或 oc 命令中的 API Explorer 查看当前和支持的 API。

1.12.1. 概述
复制链接

本文档介绍了与 Red Hat Advanced Cluster Management for Kubernetes 的 MultiClusterObservability 资源相关的 API 信息。MultiClusterObservability 资源有 4 个可用的请求：create、query、delete 和 update。

1.12.1.1. 版本信息
复制链接

版本 2.7

1.12.1.2. URI scheme
复制链接

BasePath : /kubernetes/apis
Schemes : HTTPS

1.12.1.3. Tags
复制链接

  • Observability.open-cluster-management.io : 创建和管理多集群的观察性

1.12.2. 路径
复制链接

1.12.2.1. 创建 multiclusterobservability 资源
复制链接

POST /apis/observability.open-cluster-management.io/v1beta2/multiclusterobservabilities
Copy to Clipboard Toggle word wrap
1.12.2.1.1. 描述
复制链接

创建 MultiClusterObservability 资源。

1.12.2.1.2. 参数
复制链接
Expand
类型Name描述模式

标头

COOKIE
必需

身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

Body

body
必需

描述要创建的 MultiClusterObservability 资源的参数。

MultiClusterObservability

1.12.2.1.3. 响应
复制链接
Expand
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.12.2.1.4. 使用
复制链接
  • application/yaml
1.12.2.1.5. Tags
复制链接
  • observability.apps.open-cluster-management.io
1.12.2.1.6. HTTP 请求示例
复制链接
1.12.2.1.6.1. 请求正文
复制链接
{
  "apiVersion": "observability.open-cluster-management.io/v1beta2",
  "kind": "MultiClusterObservability",
  "metadata": {
    "name": "example"
  },
  "spec": {
    "observabilityAddonSpec": {}
    "storageConfig": {
      "metricObjectStorage": {
        "name": "thanos-object-storage",
        "key": "thanos.yaml"
      "writeStorage": {
        - "key": " ",
          "name" : " "
        - "key": " ",
          "name" : " "
         }
       }
   }
}
Copy to Clipboard Toggle word wrap

1.12.2.2. 查询所有 multiclusterobservabilities
复制链接

GET /apis/observability.open-cluster-management.io/v1beta2/multiclusterobservabilities
Copy to Clipboard Toggle word wrap
1.12.2.2.1. 描述
复制链接

查询 MultiClusterObservability 资源以获取更多详细信息。

1.12.2.2.2. 参数
复制链接
Expand
类型Name描述模式

标头

COOKIE
必需

身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

1.12.2.2.3. 响应
复制链接
Expand
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.12.2.2.4. 使用
复制链接
  • application/yaml
1.12.2.2.5. Tags
复制链接
  • observability.apps.open-cluster-management.io

1.12.2.3. 查询单个 multiclusterobservability
复制链接

GET /apis/observability.open-cluster-management.io/v1beta2/multiclusterobservabilities/{multiclusterobservability_name}
Copy to Clipboard Toggle word wrap
1.12.2.3.1. 描述
复制链接

查询单个 MultiClusterObservability 资源以获取更多详细信息。

1.12.2.3.2. 参数
复制链接
Expand
类型Name描述模式

标头

COOKIE
必需

身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

multiclusterobservability_name
必需

要查询的 multiclusterobservability 的名称。

字符串

1.12.2.3.3. 响应
复制链接
Expand
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.12.2.3.4. Tags
复制链接
  • observability.apps.open-cluster-management.io

1.12.2.4. 删除一个 multiclusterobservability 资源
复制链接

DELETE /apis/observability.open-cluster-management.io/v1beta2/multiclusterobservabilities/{multiclusterobservability_name}
Copy to Clipboard Toggle word wrap
1.12.2.4.1. 参数
复制链接
Expand
类型Name描述模式

标头

COOKIE
必需

身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

multiclusterobservability_name
必需

要删除的 multiclusterobservability 的名称。

字符串

1.12.2.4.2. 响应
复制链接
Expand
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.12.2.4.3. Tags
复制链接
  • observability.apps.open-cluster-management.io

1.12.3. 定义
复制链接

1.12.3.1. MultiClusterObservability
复制链接

Expand
Name描述模式

apiVersion
必需

版本化的 MultiClusterObservability schema。

字符串

kind
必需

代表 REST 资源、MultiClusterObservability 的字符串值。

字符串

metadata
必需

描述定义策略的规则。

对象

spec

Expand
Name描述模式

enableDownsampling
可选

启用或禁用 downsample。默认值为 true。如果没有 downsample 数据，则查询不可用。

布尔值

imagePullPolicy
可选

MultiClusterObservability 镜像的 pull 策略。默认值为 Always。

corev1.PullPolicy

imagePullSecret
optional

MultiClusterObservability 镜像的 pull secret。默认值为 multiclusterhub-operator-pull-secret

字符串

nodeSelector
可选

节点选择器规格。

map[string]string

observabilityAddonSpec
required

所有安装了可观察附加组件的受管集群的全局设置。

observabilityAddonSpec

storageConfig
必需

指定可观察性要使用的存储配置。

StorageConfig

tolerations
可选

提供了所有组件可以容忍任何污点的功能。

[]corev1.Toleration

advanced
可选

可观察性的高级配置设置。

advanced

resources
可选

MultiClusterObservability 所需的计算资源。

corev1.ResourceRequirements

replicas
可选

MultiClusterObservability 副本。

整数

storageConfig

Expand
Name描述模式

alertmanagerStorageSize
可选

应用到 alertmanager 有状态集的存储量。默认值为 1Gi。

字符串

compactStorageSize
可选

应用于 thanos 紧凑有状态集合的存储量。默认值为 100Gi。

字符串

metricObjectStorage
必需

用于为指标配置 secret 的对象存储。

metricObjectStorage

receiveStorageSize
可选

应用到 thanos 接收有状态集的存储量。默认值为 100Gi。

字符串

ruleStorageSize
可选

应用到 thanos 规则有状态集的存储量。默认值为 1Gi。

字符串

storageClass
可选

指定 storageClass 有状态的集合。如果为您的操作系统配置了 metricObjectStorage 来创建存储，则此存储用于对象存储。默认值为 gp2。

字符串

storeStorageSize
可选

应用到 thanos 存储有状态集合的存储量。默认值为 10Gi。

字符串

writeStorage
可选

端点访问信息列表。

[ ]WriteStorage

writeStorage

Expand
Name描述模式

name
必需

带有端点访问信息的 secret 名称。

字符串

key
必需

要从中选择的 secret 的密钥。

字符串

metricObjectStorage

Expand
Name描述模式

key
必需

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。请参阅 Thanos 文档。

字符串

name
必需

metricObjectStorage 的名称。如需更多信息，请参阅 Kubernetes 名称。

字符串

observabilityAddonSpec

Expand
Name描述模式

enableMetrics
可选

指示 Observability 附加组件是否将指标发送到 hub 集群。默认值为 true。

布尔值

interval
可选

Observability 附加组件将指标发送到 hub 集群的间隔。默认值为 300 秒 (300s)。

整数

resources
可选

指标收集器资源要求的资源。默认 CPU 请求为 100m，内存请求为 100Mi。

corev1.ResourceRequirements

advanced

Expand
Name描述模式

retentionConfig
可选

指定供可观察性使用的数据保留配置。

RetentionConfig

rbacQueryProxy
可选

指定 rbac-query-proxy 部署的副本和资源。

CommonSpec

grafana
可选

指定 grafana 部署的副本和资源

CommonSpec

alertmanager
可选

指定 alertmanager statefulset 的副本和资源。

CommonSpec

observatoriumAPI
可选

指定 observatorium-api 部署的副本和资源。

CommonSpec

queryFrontend
可选

为 query-frontend 部署指定副本和资源。

CommonSpec

query
可选

指定查询部署的副本和资源。

CommonSpec

receive
可选

指定接收 statefulset 的副本和资源。

CommonSpec

rule
可选

指定规则 statefulset 的副本和资源。

CommonSpec

store
可选

指定存储 statefulset 的副本和资源。

CommonSpec

CompactSpec
可选

指定紧凑 statefulset 的资源。

compact

storeMemcached
可选

指定 store-memcached 的副本、资源等。

storeMemcached

queryFrontendMemcached
可选

指定 query-frontend-memcached 的副本、资源等。

CacheConfig

retentionConfig

Expand
Name描述模式

blockDuration
可选

阻塞时间序列数据库（TSDB）块持续时间的时间长度。默认值为 2h。

string

deleteDelay
可选

从存储桶中删除标记要删除的块前的时间。默认值为 48h。

字符串

retentionInLocal
可选

从本地存储保留原始样本的时间长度。默认值为 24h。

字符串

retentionResolutionRaw
可选

在存储桶中保留原始分辨率样本的时间。默认值为 30 天（30d）

string

retentionResolution5m
可选

在存储桶中保留分辨率 1 样本（5 分钟）的时间长度。默认值为 30 天（30d）

string

retentionResolution1h
可选

在存储桶中保留分辨率 2 样本（1 小时）的时间长度。默认值为 30 天（30d）

string

CompactSpec

Expand
Name描述模式

resources
可选

thanos 紧凑所需的计算资源。

corev1.ResourceRequirements

serviceAccountAnnotations
可选

annotations 是一个无结构的键值映射，它存储有紧凑的服务帐户。

map[string]string

storeMemcached

Expand
Name描述模式

resources
可选

MultiCLusterObservability 所需的计算资源.

corev1.ResourceRequirements

replicas
可选

MultiClusterObservability 副本。

整数

memoryLimitMb
optional

以 MB 为单位的 Memcached 内存限值。

整数

maxItemSize
可选

Memcached 的最大项目大小。默认值为 1m, min:1k, max:1024m。

字符串

connectionLimit
optional

Memcached 同时连接数上限。默认值为

整数

status

Expand
Name描述模式

status
可选

status 包含 MultiClusterObservability 的不同条件状态。

metav1.Condition

CommonSpec

Expand
Name描述模式

resources
可选

组件所需的计算资源。

corev1.ResourceRequirements

replicas
可选

组件的副本。

整数

QuerySpec

Expand

Name

描述

模式

CommonSpec
可选

指定查询部署的副本和资源。

CommonSpec

serviceAccountAnnotations
可选

annotations 是一个无结构的键值映射，它会与查询服务帐户存储。

map[string]string

ReceiveSpec

Expand

Name

描述

模式

CommonSpec
可选

指定查询部署的副本和资源。

CommonSpec

serviceAccountAnnotations
可选

annotations 是一个无结构的键值映射，它会与查询服务帐户存储。

map[string]string

StoreSpec

Expand

Name

描述

模式

CommonSpec
可选

指定查询部署的副本和资源。

CommonSpec

serviceAccountAnnotations
可选

annotations 是一个无结构的键值映射，它会与查询服务帐户存储。

map[string]string

RuleSpec

Expand

Name

描述

模式

CommonSpec
可选

指定查询部署的副本和资源。

CommonSpec

evalInterval
可选

指定规则的评估间隔。

字符串

serviceAccountAnnotations
可选

annotations 是一个无结构的键值映射，它会与查询服务帐户存储。

map[string]string

返回顶部
Red Hat logoGithubredditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务，以及可以信赖的内容，帮助红帽用户创新并实现他们的目标。 了解我们当前的更新.

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情，请参阅红帽博客.

關於紅帽

我们提供强化的解决方案，使企业能够更轻松地跨平台和环境（从核心数据中心到网络边缘）工作。

Theme

© 2025 Red Hat