获取平台健康度概览

获取 ZCF 平台自愈健康度的原始数据概览。

GET/api/v1/platform-health/overview

操作 ID

GetPlatformHealthOverview

起始版本

1.2.0

执行模式

同步

认证信息

需要认证

认证信息

调用该 API 时需要在请求头中携带以下认证信息。

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

此接口无需请求参数。

响应状态

200 OK

该 API 成功时返回以下响应结构。

generatedAt
String
生成时间。
示例： 2026-01-15T08:00:00Z
sources
List
资源。
示例： (nested array)
- name
  String
  资源名称。
  示例： my-resource
- readAt
  String
  读取时间。
  示例： 2026-01-15T08:00:00Z
- cached
  Boolean
  资源。
  示例： true
- error
  String
  错误码。操作成功时为 null，失败时返回具体错误信息。
  示例： "upgrade failed: timeout"
components
List
受影响引用组件列表。
示例： (nested array)
- component
  Object
  组件。
  uuid
  String
  资源的UUID，唯一标识该资源。
  示例： value
  name
  String
  资源名称。
  示例： my-resource
  category
  String
  类型分类。
  示例： value
  installType
  String
  资源。
  示例： value
  deliveryType
  String
  资源。
  示例： value
  bundleName
  String
  资源。
  示例： value
  bundleManagementStatus
  String
  资源。
  示例： value
  configState
  String
  资源。
  示例： value
- instances
  List
  资源。
  示例： (nested array)
  uuid
  String
  资源的UUID，唯一标识该资源。
  示例： value
  componentUuid
  String
  资源。
  示例： value
  nodeUuid
  String
  资源。
  示例： value
  lcaUuid
  String
  资源。
  示例： value
  state
  String
  当前状态。
  示例： value
  runtimeStatus
  String
  资源。
  示例： value
  message
  String
  错误返回消息。
  示例： value
  updatedAt
  String
  更新时间。
  示例： 2026-01-15T08:00:00Z
  services
  List
  资源。
  示例： (nested array)
  uuid
  String
  资源的UUID，唯一标识该资源。
  示例： value
  name
  String
  资源名称。
  示例： my-resource
  type
  String
  类型。
  示例： value
  runtimeName
  String
  资源。
  示例： value
  runtimeStatus
  String
  资源。
  示例： value
  message
  String
  错误返回消息。
  示例： value
  updatedAt
  String
  更新时间。
  示例： 2026-01-15T08:00:00Z
  nodeIp
  String
  资源。
  示例： value
  nodeName
  String
  资源。
  示例： value
storageSamples
List
资源。
示例： (nested array)
- capacityItemId
  String
  资源。
  示例： value
- storageType
  String
  资源。
  示例： value
- componentId
  String
  资源。
  示例： value
- componentName
  String
  资源。
  示例： value
- mountPointHash
  String
  资源。
  示例： value
- mountPointMasked
  String
  资源。
  示例： value
- totalBytes
  Long
  资源。
  示例： 0
- usedBytes
  Long
  资源。
  示例： 0
- availableBytes
  Long
  资源。
  示例： 0
- usagePercent
  Long
  资源。
  示例： 0
- updatedAt
  String
  更新时间。
  示例： 2026-01-15T08:00:00Z
- name
  String
  资源名称。
  示例： my-resource
- storageRole
  String
  资源。
  示例： value
- componentUuid
  String
  资源。
  示例： value
- component
  String
  组件。
  示例： value
- uuid
  String
  资源的UUID，唯一标识该资源。
  示例： value
- filesystemId
  String
  资源。
  示例： value
- lcaUuid
  String
  资源。
  示例： value
- nodeFqdn
  String
  资源。
  示例： value
notificationChannels
List
通知渠道列表。
示例： (nested array)
- id
  String
  资源ID。
  示例： value
- name
  String
  资源名称。
  示例： my-resource
- type
  String
  类型。
  示例： value
- enabled
  Boolean
  是否启用。
  示例： true
- consecutiveFailures
  Integer
  资源。
  示例： 10
- message
  String
  错误返回消息。
  示例： value
- updatedAt
  String
  更新时间。
  示例： 2026-01-15T08:00:00Z
sentinel
Object
资源。
- message
  String
  错误返回消息。
  示例： value
- updatedAt
  String
  更新时间。
  示例： 2026-01-15T08:00:00Z
- status
  String
  状态信息。
  示例： value
externalConnections
List
资源。
示例： (nested array)
- id
  String
  资源ID。
  示例： value
- name
  String
  资源名称。
  示例： my-resource
- product
  String
  资源。
  示例： value
- status
  String
  状态信息。
  示例： value
- message
  String
  错误返回消息。
  示例： value
- updatedAt
  String
  更新时间。
  示例： 2026-01-15T08:00:00Z

请求示例

curl -X GET '{host}/api/v1/platform-health/overview' -H 'Authorization: Bearer {token}'

响应示例

{
  "generatedAt": "2026-07-01T12:00:00Z",
  "sources": [
    {
      "name": "lifecycle",
      "readAt": "2026-07-01T12:00:00Z"
    },
    {
      "name": "victoria_metrics",
      "readAt": "2026-07-01T12:00:00Z"
    }
  ],
  "components": [
    {
      "component": {
        "uuid": "cmp-zmetis",
        "name": "zmetis",
        "category": "zmetis",
        "bundleName": "zcf"
      },
      "instances": [
        {
          "uuid": "inst-1",
          "componentUuid": "cmp-zmetis",
          "nodeUuid": "node-1",
          "state": "Healthy",
          "runtimeStatus": "running",
          "message": "",
          "updatedAt": "2026-07-01T12:00:00Z",
          "services": [
            {
              "uuid": "svc-1",
              "name": "vmagent",
              "type": "systemd",
              "runtimeStatus": "running",
              "message": "",
              "updatedAt": "2026-07-01T12:00:00Z"
            }
          ]
        }
      ]
    }
  ],
  "storageSamples": [
    {
      "uuid": "storage-metrics-abc",
      "name": "vmstorage-data",
      "storageType": "volume",
      "storageRole": "metrics",
      "componentUuid": "cmp-zmetis",
      "component": "zmetis",
      "mountPointMasked": "vmstorage-xxxx",
      "totalBytes": 100,
      "usedBytes": 70,
      "availableBytes": 30,
      "usagePercent": 70,
      "updatedAt": "2026-07-01T12:00:00Z"
    }
  ],
  "notificationChannels": [
    {
      "id": "webhook-1",
      "name": "Webhook",
      "type": "webhook",
      "enabled": true,
      "consecutiveFailures": 0,
      "message": "",
      "updatedAt": "2026-07-01T12:00:00Z"
    }
  ],
  "sentinel": {
    "message": "",
    "updatedAt": "2026-07-01T12:00:00Z",
    "status": "Green"
  },
  "externalConnections": [
    {
      "id": "cloud-1",
      "name": "prod-cloud",
      "product": "cloud",
      "status": "connected",
      "message": "",
      "updatedAt": "2026-07-01T12:00:00Z"
    }
  ]
}

变更历史

查看全部变更历史

变更时间变更内容概要操作

变更时间
2026-07-14
新增响应字段 nodeIp, nodeName
查看 API
变更时间
2026-07-14
新增响应字段 nodeIp, nodeName
查看 API
变更时间
2026-07-09
新增响应字段 filesystemId, nodeFqdn
查看 API
变更时间
2026-07-07
新增响应字段 storageRole
查看 API

Agent 插件

Agent 管理

资产

指标目录与保留策略

采集任务

基础设施综合

安装器

生命周期

OTA 升级计划

OTA 版本与策略

联邦与 SSO

变更管理

资源删除

生命周期升级

指标采集

监控缓存

监控查询与概览

自动修复

监控综合

Grafana 集成

Grafana 仪表盘

日志

性能剖析

Zaku

告警规则

告警模板

告警通道与集成

告警事件

告警路由与策略

值班

SLO

健康检查

凭证

ZIAM

安全

ZMetis 审计

平台管理

平台联邦

平台自监控

平台健康

平台综合

ZMetis 任务

认证信息

请求参数

响应状态

变更历史