查询云应用服务器监控信息 - ShowServerMetricData

功能介绍

该接口可获取某一计算机在一段时间段(范围：1小时到30天)的数据信息（例如CPU占用率、内存占用率、用户的在线时间段等），最长数据保存时间不能超过180天。

调试

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

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
workspace:server:getMetricData
Read
server *
g:ResourceTag/<tag-key>
g:EnterpriseProjectId
-
-

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
workspace:server:getMetricData	Read	server *	g:ResourceTag/<tag-key> g:EnterpriseProjectId	-	-

URI

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

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目唯一标识。
server_id	是	String	服务器唯一标识。

表2 Query参数
参数	是否必选	参数类型	描述
start_time	是	String	监控开始时间：由日期加时间组成，UTC格式，例如“2021-05-11T11:45:42.000Z”。
end_time	是	String	监控结束时间：由日期加时间组成，UTC格式，例如“2021-05-11T11:45:42.000Z”。
metric_name	否	String	监控查询指标：例如 "cpu_util"，详情见下表；当metric_name为空时，为批量查询。\| 指标 \| 指标名称 \| 测量对象 \| 监控周期 \|\| ------------------------------------- \| ----------------- \| ------------ \| -------- \|\| cpu_util \| CPU使用率 \| 弹性云服务器 \| 5分钟 \|\| mem_util \| 内存使用率 \| 弹性云服务器 \| 5分钟 \|\| disk_util_inband \| 磁盘使用率 \| 弹性云服务器 \| 5分钟 \|\| disk_read_bytes_rate \| 磁盘读带宽 \| 弹性云服务器 \| 5分钟 \|\| disk_write_bytes_rate \| 磁盘写带宽 \| 弹性云服务器 \| 5分钟 \|\| disk_read_requests_rate \| 磁盘读IOPS \| 弹性云服务器 \| 5分钟 \|\| disk_write_requests_rate \| 磁盘写IOPS \| 弹性云服务器 \| 5分钟 \|\| network_incoming_bytes_rate_inband \| 带内网络流入速率 \| 弹性云服务器 \| 5分钟 \|\| network_outgoing_bytes_rate_inband \| 带内网络流出速率 \| 弹性云服务器 \| 5分钟 \|\| network_incoming_bytes_aggregate_rate \| 带外网络流入速率 \| 弹性云服务器 \| 5分钟 \|\| network_outgoing_bytes_aggregate_rate \| 带外网络流出速率 \| 弹性云服务器 \| 5分钟 \|

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	否	String	用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码：200

表4 响应Body参数
参数	参数类型	描述
cpu_info	Array of DataPoints objects	cpu使用率信息。
memory_info	Array of DataPoints objects	内存使用率信息。
disk_util_inband	Array of DataPoints objects	磁盘使用率。
disk_read_bytes_rate	Array of DataPoints objects	磁盘读带宽。
disk_write_bytes_rate	Array of DataPoints objects	磁盘写带宽。
disk_read_requests_rate	Array of DataPoints objects	磁盘读IOPS。
disk_write_requests_rate	Array of DataPoints objects	磁盘写IOPS。
network_incoming_bytes_rate_inband	Array of DataPoints objects	带内网络流入速率。
network_outgoing_bytes_rate_inband	Array of DataPoints objects	带内网络流出速率。
network_incoming_bytes_aggregate_rate	Array of DataPoints objects	带外网络流入速率。
network_outgoing_bytes_aggregate_rate	Array of DataPoints objects	带外网络流出速率。
network_vm_connections	Array of DataPoints objects	网络连接数。

表5 DataPoints
参数	参数类型	描述
average	Double	平均数值。
timestamp	Long	时间戳。

状态码：400

表6 响应Body参数
参数	参数类型	描述
error_code	String	错误码，失败时返回。
error_msg	String	错误描述。

状态码：401

表7 响应Body参数
参数	参数类型	描述
error_code	String	错误码，失败时返回。
error_msg	String	错误描述。

状态码：403

表8 响应Body参数
参数	参数类型	描述
error_code	String	错误码，失败时返回。
error_msg	String	错误描述。

状态码：404

表9 响应Body参数
参数	参数类型	描述
error_code	String	错误码，失败时返回。
error_msg	String	错误描述。

状态码：405

**表10** 响应Body参数
参数	参数类型	描述
error_code	String	错误码，失败时返回。
error_msg	String	错误描述。

状态码：500

**表11** 响应Body参数
参数	参数类型	描述
error_code	String	错误码，失败时返回。
error_msg	String	错误描述。

状态码：503

**表12** 响应Body参数
参数	参数类型	描述
error_code	String	错误码，失败时返回。
error_msg	String	错误描述。

请求示例

无

响应示例

状态码：200

操作成功。

{
  "cpu_info" : [ {
    "average" : 0.4832775919732441,
    "timestamp" : 1618810632000
  }, {
    "average" : 0.4832775919732441,
    "timestamp" : 1618810931000
  }, {
    "average" : 0.5018382352941176,
    "timestamp" : 1618811203000
  }, {
    "average" : 0.4830508474576271,
    "timestamp" : 1618812396000
  } ],
  "disk_read_bytes_rate" : [ {
    "average" : 0.4832775919732441,
    "timestamp" : 1618810632000
  } ],
  "memory_info" : [ {
    "average" : 12.501838235294118,
    "timestamp" : 1618811203000
  }, {
    "average" : 12.483050847457626,
    "timestamp" : 1618812396000
  } ],
  "disk_util_inband" : [ {
    "average" : 12.483050847457626,
    "timestamp" : 1618812396000
  } ],
  "disk_write_bytes_rate" : [ {
    "average" : 12.483050847457626,
    "timestamp" : 1618812396000
  } ],
  "disk_read_requests_rate" : [ {
    "average" : 12.48,
    "timestamp" : 1618812396000
  } ],
  "network_outgoing_bytes_rate_inband" : [ {
    "average" : 170.5190311418685,
    "timestamp" : 1618812396000
  } ],
  "network_incoming_bytes_aggregate_rate" : [ {
    "average" : 158.4299674267101,
    "timestamp" : 1618812396000
  } ],
  "network_outgoing_bytes_aggregate_rate" : [ {
    "average" : 144.38275862068966,
    "timestamp" : 1618812396000
  } ]
}

状态码

状态码	描述
200	操作成功。
400	由于包含语法错误，当前请求无法被服务器理解。
401	鉴权失败。
403	没有操作权限。
404	找不到资源。
405	请求中指定的方法不被允许。
500	服务内部错误，具体返回错误码请参见错误码说明。
503	服务不可用。