跳转到主要内容
基础设施相关接口/Agent 管理
PUTAgent起始版本 1.0同步需要认证

心跳

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

调试可用性

在线调试

使用当前认证信息和示例参数提交 Mock 请求。

路径参数

请求参数

路径参数

  • uuidString必填

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

请求体字段

  • versionString必填

    版本号。

    示例: 1.2.3

  • uptimeString必填

    秒代理进程运行中。

    示例: 86400

  • cpuUsageLong必填

    CPU使用率百分比0 100。

    示例: 12.5

  • memUsageLong必填

    内存使用率。

    示例: 35.2

响应状态

200 OK

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

  • uuidString

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

    示例: agent-abc123-def456

  • nameString

    资源名称。

    示例: prod-agent-01

  • typeString

    类型。

    示例: log

  • versionString

    版本号。

    示例: 1.2.3

  • statusString

    状态信息。

    示例: online

  • endpointString

    接收端地址。

    示例: http://192.168.1.10:7890

  • platformIdString

    平台ID。

    示例: plat-001-abc

  • regionString

    区域。

    示例: us-east-1

  • labelsString

    标签列表。

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

  • lastHeartbeatAtString

    最近一次心跳时间。

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

  • createDateString

    创建时间。

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

  • lastOpDateString

    最近一次操作时间。

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

请求地址

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

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

操作 ID

Heartbeat

永久链接

请求示例

curl -X PUT '{host}/api/v1/agents/{uuid}/heartbeat' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"version":"1.2.3","uptime":86400,"cpuUsage":12.5,"memUsage":35.2}'

响应示例

200
{
  "uuid": "agent-abc123-def456",
  "name": "prod-agent-01",
  "type": "log",
  "version": "1.2.3",
  "status": "online",
  "endpoint": "http://192.168.1.10:7890",
  "platformId": "plat-001-abc",
  "region": "us-east-1"
}

变更历史

此 API 暂无变更历史记录。

查看全部变更历史