文档首页/ 云桌面 Workspace/ API参考/ 云应用API/ 服务器管理/ 查询指定时间范围指定指标的指定粒度的监控数据
更新时间：2024-09-05 GMT+08:00
查看PDF
分享

查询指定时间范围指定指标的指定粒度的监控数据

功能介绍

查询指定时间范围指定指标的指定粒度的监控数据，可以通过参数指定需要查询的数据维度。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v1/{project_id}/app-servers/server-metric-data/{server_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目唯一标识。

server_id

是

String

服务器唯一标识。
表2 Query参数

参数

是否必选

参数类型

描述

namespace

是

String

服务的命名空间：例如 "SYS.ECS/AGT.ECS"，当namespace为AGT.ECS，则查询GPU监控指标： - SYS.ECS：弹性云服务器的基础监控指标。 - AGT.ECS：弹性云服务器操作系统监控的监控指标（GPU指标）。

metric_name

是

String

监控查询指标名称: - SYS.ECS命名空间的指标名称,请参考帮助文档：“弹性云服务器支持的基础监控指标”。 - AGT.ECS命名空间的指标名称,请参考帮助文档：“操作系统监控指标：GPU”。

from

是

String

查询数据起始时间，UNIX时间戳，单位毫秒。

to

是

String

查询数据截止时间UNIX时间戳，单位毫秒。from必须小于to。

period

是

Integer

监控数据粒度。 取值范围： - 1: 实时数据。 - 300: 5分钟粒度。 - 1200: 20分钟粒度。 - 3600: 1小时粒度。 - 14400: 4小时粒度。 - 86400: 1天粒度。

filter

是

String

数据聚合方式，支持的聚合方式如下: - average：聚合周期内指标数据的平均值。 - max：聚合周期内指标数据的最大值。 - min：聚合周期内指标数据的最小值。 - sum：聚合周期内指标数据的求和值。 - variance：聚合周期内指标数据的方差。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

server_metrics

Array of ServerMetricData objects

监控数据。
表5 ServerMetricData

参数

参数类型

描述

metric_name

String

监控指标名称。

datapoints

Array of ServerDataPoints objects

指标数据列表。

dimension_value

String

维度值，仅查询GPU监控信息时有值。
表6 ServerDataPoints

参数

参数类型

描述

average

Double

聚合周期内指标数据的平均值。

max

Double

聚合周期内指标数据的最大值。

min

Double

聚合周期内指标数据的最小值。

sum

Double

聚合周期内指标数据的求和值。

variance

Double

聚合周期内指标数据的方差。

timestamp

Long

指标采集时间，UNIX时间戳，单位毫秒。

unit

String

指标单位。

状态码： 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码： 401

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码： 403

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码： 404

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码： 405

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码： 500

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码： 503

表13 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

请求示例

GET /v1/a4da8115c9d8464ead3a38309130523f/app-servers/server-metric-data/8115c9d8464ead3a38309130?namespace=AGT.ECS&metric_name=cpu_util&from=1691671739879&to=1691671739872&period=1&filter=average

响应示例

状态码： 200

操作成功。

{
  "server_metrics" : [ {
    "datapoints" : [ {
      "average" : 0.23,
      "timestamp" : 1442341200000,
      "unit" : "%"
    } ],
    "metric_name" : "gpu_usage_encoder",
    "dimension_value" : "2e84018fc8b4484b94e89aae212fe615"
  }, {
    "datapoints" : [ {
      "average" : 0.23,
      "timestamp" : 1442341200000,
      "unit" : "%"
    } ],
    "metric_name" : "gpu_usage_encoder",
    "dimension_value" : "7784018fc8b4484b94e89aae212fe455"
  } ]
}

状态码

状态码

描述

200

操作成功。

400

由于包含语法错误，当前请求无法被服务器理解。

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

405

请求中指定的方法不被允许。

500

服务内部错误，具体返回错误码请参见错误码说明。

503

服务不可用。

错误码

请参见错误码。

父主题： 服务器管理

相关文档