深入解析cAdvisor的REST API接口

施刚爽

于 2025-06-02 09:02:20 发布

阅读量231

点赞数 5

CC 4.0 BY-SA版权

本文链接：https://blog.youkuaiyun.com/gitblog_00064/article/details/148375021

深入解析cAdvisor的REST API接口

cadvisor Analyzes resource usage and performance characteristics of running containers. 项目地址: https://gitcode.com/gh_mirrors/ca/cadvisor

概述

cAdvisor作为一款开源的容器监控工具，提供了丰富的REST API接口，允许用户通过HTTP请求获取容器和主机的监控数据。本文将详细介绍cAdvisor API的各个版本及其功能，帮助开发者更好地利用这些接口进行容器监控。

API基础结构

cAdvisor的API遵循标准的RESTful设计原则，其基本URL格式为：

http://<主机名>:<端口>/api/<版本号>/<请求路径>

当前稳定版本为v1.3，同时v2.0版本正在beta测试中。

API版本详解

v1.0版本核心功能

作为最早的稳定版本，v1.0提供了两个核心端点：

容器信息端点
- 路径：/api/v1.0/containers/<绝对容器名称>
- 功能：获取指定容器的详细监控数据
- 响应内容：
  - 容器绝对名称
  - 子容器列表
  - 容器规格说明
  - 最近N秒的资源使用统计
  - 容器创建以来的资源使用直方图
机器信息端点
- 路径：/api/v1.0/machine
- 功能：获取主机硬件信息
- 响应内容：
  - 可调度的逻辑CPU核心数
  - 内存容量
  - 最大CPU频率
  - 可用文件系统信息
  - 网络设备详情
  - 机器拓扑结构

v1.1版本新增功能

在v1.0基础上增加了：

子容器信息端点
- 路径：/api/v1.1/subcontainers/<绝对容器名称>
- 特点：递归获取指定容器及其所有子容器的信息
- 适用场景：需要获取容器层级结构的完整监控数据

v1.2版本新增功能

在v1.1基础上增加了：

Docker容器信息端点
- 路径：/api/v1.2/docker/<Docker容器名称>
- 特点：专门针对Docker容器的信息获取
- 参数说明：容器名称可以是UUID或短名称

v1.3版本新增功能

在v1.2基础上增加了：

事件端点
- 路径：/api/v1.3/events/<绝对容器名称>
- 功能：获取容器相关事件
- 查询参数详解：

| 参数名 | 说明 | 默认值 | |-------------------|-----------------------------|------------| | start_time | 查询起始时间 | 最早时间 | | end_time | 查询结束时间 | 当前时间 | | stream | 是否实时流式传输新事件 | false | | subcontainers | 是否包含子容器事件 | false | | max_events | 返回的最大事件数 | 10 | | all_events | 是否包含所有支持的事件类型 | false | | oom_events | 是否包含OOM事件 | false | | oom_kill_events | 是否包含OOM kill事件 | false | | creation_events | 是否包含容器创建事件 | false | | deletion_events | 是否包含容器删除事件 | false |