跳转到主要内容
ZStack
监控与采集相关接口/监控查询与概览

获取概览

获取高等级平台概览包含云主机集群数量。

GET/api/v1/monitoring/overview

操作 ID

GetOverview

起始版本

1.0.0

执行模式

同步

认证信息

需要认证

认证信息

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

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

查询参数

  • platformUuid
    String

    平台UUID。

响应状态

200 OK
200 OK

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

  • totalVms
    String

    总云主机。

    示例： 500

  • runningVms
    String

    数量当前运行中虚拟机器。

    示例： 480

  • stoppedVms
    String

    数量已停止虚拟机器。

    示例： 20

  • totalHosts
    String

    总数量物理主机。

    示例： 32

  • onlineHosts
    String

    数量在线物理主机。

    示例： 31

  • totalImages
    String

    总数量已注册镜像。

    示例： 50

  • clusters
    List

    资源。

    示例： (nested array)

    • uuid
      String

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

      示例： cluster-abc-001

    • name
      String

      资源名称。

      示例： Production Cluster

    • vmCount
      String

      云主机数量。

      示例： 128

    • hostCount
      String

      主机数量。

      示例： 16