跳转到主要内容
API Explorer|API Explorer
监控与采集相关接口/监控查询与概览
GETMonitoring起始版本 1.0同步需要认证

获取概览

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

调试可用性

在线调试

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

查询参数

请求参数

查询参数

  • platformUuidString

    平台UUID。

响应状态

200 OK

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

  • totalVmsString

    总云主机。

    示例： 500

  • runningVmsString

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

    示例： 480

  • stoppedVmsString

    数量已停止虚拟机器。

    示例： 20

  • totalHostsString

    总数量物理主机。

    示例： 32

  • onlineHostsString

    数量在线物理主机。

    示例： 31

  • totalImagesString

    总数量已注册镜像。

    示例： 50

  • clustersList

    资源。

    示例： (nested array)

    • uuidString

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

      示例： cluster-abc-001

    • nameString

      资源名称。

      示例： Production Cluster

    • vmCountString

      云主机数量。

      示例： 128

    • hostCountString

      主机数量。

      示例： 16

请求地址

GET/api/v1/monitoring/overview

/api/v1/monitoring/overview

操作 ID

GetOverview

永久链接

请求示例

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

响应示例

200
{
  "totalVms": 500,
  "runningVms": 480,
  "stoppedVms": 20,
  "totalHosts": 32,
  "onlineHosts": 31,
  "totalImages": 50,
  "clusters": [
    {}
  ]
}

变更历史

此 API 暂无变更历史记录。

查看全部变更历史