性能监控 API

获取监控数据

获取服务内指定副本的监控信息,返回最近 30 分钟的每分钟数据。

请求 URL

GET https://open.c.163.com/api/v1/cm/metricdata?service=NMS&period={period}&metrics={metrics}

请求示例

GET /api/v1/cm/metricdata?service=NMS&period=60&metrics=[{"dimension":"microservice=qa-space-admin$web-app$web-app-69353-2783765391-5jp7y$nginx","metricName":"cpuUsage", "statistics":"minimum"}] HTTP/1.1
Authorization: Token 5b17a473c90c443ca1f37ddcdd59ad0f

请求参数

参数类型是否必填描述示例值
periodInteger采样数据聚合时长,可选值为 60/300,单位秒,默认 30 秒60
metricsJSONArray查询数据详情
- dimensionString维度,格式为 microservice={namespace}${serviceName}${podName}${containerName},$ 为分隔符。
➡ namespace:空间名称(以用户名结尾),不是空间显示名称(获取空间列表 - namespace 字段)
➡ serviceName:服务名称(获取服务列表 - service_name 字段)
➡ podName:副本名称(查看服务详情 V2 - replicas 字段)
➡ containerName:容器名称(查看服务详情 V2 - container_name 字段)
microservice=qa-space-admin$web-app$web-app-69353-2783765391-5jp7y$nginx
- metricNameString监控项名称(详见下方监控项列表参数)cpuUsage
- statisticsString聚合算法,可选 average/minmum/maximum,多个以逗号分隔,默认为 averageminimum
监控项列表参数说明单位
cpuUsageCPU使用率%
memUsageRate内存使用率%
systemDiskUsageRate系统盘使用率%
diskReadRequest磁盘读IOPS次/s
diskWriteRequest磁盘写IOPS次/s
diskReadRate磁盘读吞吐量KB/s
diskWriteRate磁盘写吞吐量KB/s
diskUsage磁盘空间占用量Byte
diskUsageRate磁盘空间利用率%
network1Transfer内网网络流出量Kbps
network1Receive内网网络流入量Kbps
network2Transfer公网网络流出量Kbps
network2Receive公网网络流入量Kbps

响应示例

[
  {
    "data": [
      {
        "createTime": 1492684740000,
        "minimum": 0.01635727219973723
      },
      {
        "createTime": 1492684800000,
        "minimum": 0.016491493171171746
      },
      {
        "createTime": 1492684860000,
        "minimum": 0.016547408777981717
      }
    ],
    "dimension": "microservice=qa-space-admin$web-app$web-app-69353-2783765391-5jp7y$nginx",
    "metricName": "cpuUsage",
    "metricNameDesc": "CPU使用率",
    "unit": "%"
  }
]

响应参数

参数类型必有描述实例值
dimensionString实例维度,格式为 Key=Valuemicroservice=qa-space-admin$web-app$web-app-69353-2783765391-5jp7y$nginx
metricNameString监控项名称cpuUsage
metricNameDescString监控项显示名CPU使用率
unitString监控项单位%
dataJSONArray数据数组,若无数据则为空数组详见示例
- createTimeLong数据时间详见示例
- averageDouble平均值本示例未返回
- minimumDouble最大值详见示例
- maximumDouble最小值本示例未返回