跳转到主要内容
ZStack
基础设施相关接口/Agent 管理

心跳

更新代理状态资源指标接收周期性心跳。

PUT/api/v1/agents/{uuid}/heartbeat

操作 ID

Heartbeat

起始版本

1.0.0

执行模式

同步

认证信息

需要认证

认证信息

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

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

application/json

路径参数

  • uuid
    String必填

    资源的UUID，唯一标识该资源。

请求体字段

  • version
    String必填

    版本号。

    示例： 1.2.3

  • uptime
    String必填

    秒代理进程运行中。

    示例： 86400

  • cpuUsage
    Long必填

    CPU使用率百分比0 100。

    示例： 12.5

  • memUsage
    Long必填

    内存使用率。

    示例： 35.2

响应状态

200 OK
200 OK

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

  • uuid
    String

    资源的UUID，唯一标识该资源。

    示例： agent-abc123-def456

  • name
    String

    资源名称。

    示例： prod-agent-01

  • type
    String

    类型。

    示例： log

  • version
    String

    版本号。

    示例： 1.2.3

  • status
    String

    状态信息。

    示例： online

  • endpoint
    String

    接收端地址。

    示例： http://192.168.1.10:7890

  • platformId
    String

    平台ID。

    示例： plat-001-abc

  • region
    String

    区域。

    示例： us-east-1

  • labels
    String

    标签列表。

    示例： {"env":"prod","team":"ops"}

  • lastHeartbeatAt
    String

    最近一次心跳时间。

    示例： 2026-01-15T08:00:00Z

  • createDate
    String

    创建时间。

    示例： 2026-01-15T08:00:00Z

  • lastOpDate
    String

    最近一次操作时间。

    示例： 2026-01-15T08:00:00Z