文档

DescribeInstanceMonitorData - 查询一台实例的监控信息

更新时间:

调用DescribeInstanceMonitorData查询一台ECS实例的监控信息。可查询的指标包括ECS实例的vCPU使用率、突发性能实例积分、接收的数据流量、发送的数据流量、平均带宽等。

接口说明

调用该接口时,您需要注意:

  • 每次最多返回 400 条监控数据,如果指定的参数(EndTime - StartTime)/Period大于 400 时,则返回错误信息。
  • 单次最多能查询近 30 天内的监控信息,如果指定的参数StartTime超过 30 天,则返回错误信息。
  • 当返回信息中缺少部分内容时,可能是系统没有获取到相应的信息。例如,当时实例处于已停止(Stopped)状态。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ecs:DescribeInstanceMonitorDataREAD
  • Instance
    acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}
  • ecs:tag

请求参数

名称类型必填描述示例值
InstanceIdstring

待查询的实例 ID。

i-bp1a36962lrhj4ab****
StartTimestring

获取数据的起始时间点。按照 ISO8601 标准表示,并使用 UTC +0 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。如果指定的秒(ss)不是00,则自动换算为下一分钟。

2014-10-29T23:00:00Z
EndTimestring

获取数据的结束时间点。按照 ISO8601 标准表示,并使用 UTC +0 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。如果指定的秒(ss)不是00,则自动换算为下一分钟。

2014-10-30T08:00:00Z
Periodinteger

获取监控数据的间隔时间,单位:秒。取值范围:

  • 60
  • 600
  • 3600

默认值:60

60

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
MonitorDataobject []

实例的监控数据集合。

CPUCreditBalancefloat

突发性能实例积分总数。

120
BPSReadinteger

实例云盘(包括系统盘和数据盘)的读带宽,单位:Byte/s。

1000
InternetTXinteger

在查询监控信息时(TimeStamp),实例在指定的间隔时间(Period)内发送的公网数据流量。单位:kbits。

343
CPUinteger

实例 vCPU 的使用比例,单位:百分比(%)。

2
CPUCreditUsagefloat

突发性能实例已使用的积分数。

30
IOPSWriteinteger

实例云盘(包括系统盘和数据盘)的 I/O 写操作,单位:次/s。

200
IntranetTXinteger

在查询监控信息时(TimeStamp),实例在指定的间隔时间(Period)内发送的内网数据流量。单位:kbits。

343
InstanceIdstring

实例 ID。

i-bp1a36962lrhj4****
BPSWriteinteger

实例云盘(包括系统盘和数据盘)的写带宽,单位:Byte/s。

13585
CPUNotpaidSurplusCreditUsagefloat

超额未支付积分。

0.5
CPUAdvanceCreditBalancefloat

超额积分(突发性能实例积分超限部分)。

0.4
IOPSReadinteger

实例云盘(包括系统盘和数据盘)的 I/O 读操作,单位:次/s。

1000
InternetBandwidthinteger

实例的公网带宽,单位时间内的网络流量,单位:kbits/s。

10
InternetRXinteger

在查询监控信息时(TimeStamp),实例在指定的间隔时间(Period)内接收的公网数据流量。单位:kbits。

122
TimeStampstring

查询监控信息的时间戳。

2014-10-30T05:00:00Z
IntranetRXinteger

在查询监控信息时(TimeStamp),实例在指定的间隔时间(Period)内接收的内网数据流量。单位:kbits。

122
IntranetBandwidthinteger

实例的内网带宽,单位时间内的网络流量,单位:kbits/s。

10

示例

正常返回示例

JSON格式

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "MonitorData": {
    "InstanceMonitorData": [
      {
        "CPUCreditBalance": 120,
        "BPSRead": 1000,
        "InternetTX": 343,
        "CPU": 2,
        "CPUCreditUsage": 30,
        "IOPSWrite": 200,
        "IntranetTX": 343,
        "InstanceId": "i-bp1a36962lrhj4****",
        "BPSWrite": 13585,
        "CPUNotpaidSurplusCreditUsage": 0.5,
        "CPUAdvanceCreditBalance": 0.4,
        "IOPSRead": 1000,
        "InternetBandwidth": 10,
        "InternetRX": 122,
        "TimeStamp": "2014-10-30T05:00:00Z",
        "IntranetRX": 122,
        "IntranetBandwidth": 10
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400InvalidStartTime.MalformedThe specified parameter "StartTime" is not valid.-
400InvalidEndTime.MalformedThe specified parameter "EndTime" is not valid.传入的参数EndTime不符合规则。
400InvalidPeriod.ValueNotSupportedThe specified parameter "Period" is not valid.-
400InvalidStartTime.TooEarlyThe specified parameter "StartTime" is too early.-
400InvalidParameter.TooManyDataQueriedToo many data queried.监控数据节点超出范围。
400ThrottlingRequest was denied due to request throttling.请求被流控。
400InvalidStartTime.ValueNotSupportedThe specified parameter StartTime is later than EndTime.结束时间不能早于开始时间。
404InvalidInstanceId.NotFoundThe specified InstanceId does not exist.指定的实例ID未找到。
500InternalErrorThe request processing has failed due to some unknown error.内部错误,请重试。

访问错误中心查看更多错误码。

  • 本页导读 (1)
文档反馈