文档

DescribeEipMonitorData - 查看EIP的监控信息

更新时间:

调用DescribeEipMonitorData接口查看弹性公网IP(Elastic IP Address,简称EIP)的监控信息,最多查询30天内的数据,单次最多查询400个流量点的数据。

接口说明

为了提供更好的获取监控数据接口体验,建议您使用云监控(CloudMonitor)提供的统一接口 DescribeMetricList 查询 EIP 相关数据。更多信息,请参见 DescribeMetricList弹性公网 IP 相关数据

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

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

EIP 所属地域 ID。 您可以通过调用 DescribeRegions 接口获取地域 ID。

cn-hangzhou
AllocationIdstring

EIP 的实例 ID。

eip-2zeerraiwb7uj6idcfv****
StartTimestring

获取数据的起始时间。使用 UTC 时间。按照 ISO8601 标准,格式为YYYY-MM-DDThh:mm:ssZ。例如,北京时间 2013 年 01 月 10 日 20 点 00 分 00 秒,表示为2013-01-10T12:00:00Z

如果不是整分,则自动取下一分钟为起始时间点。

2020-01-05T01:05:05Z
EndTimestring

获取数据的结束时间。使用 UTC 时间。按照 ISO8601 标准,格式为YYYY-MM-DDThh:mm:ssZ。例如,北京时间 2013 年 01 月 10 日 20 点 00 分 00 秒,表示为2013-01-10T12:00:00Z

如果不是整分,则自动取下一分钟为结束时间点。

2020-01-05T03:05:10Z
Periodinteger

每条监控数据的时间长度。单位:秒。取值:60(默认值) 、3009003600

  • 如果(EndTimeStartTime)/ Period 大于 200,则最多返回 200 条监控数据。

  • 如果(EndTimeStartTime)/ Period 小于等于 200,则只返回起始时间点到结束时间点的监控数据。

60

返回参数

名称类型描述示例值
object

返回信息列表。

RequestIdstring

请求 ID。

C8B26B44-0189-443E-9816-D951F59623A9
EipMonitorDatasobject []

EIP 监控数据的详细信息。

EipTXlong

流出的流量。单位:Byte。

343
EipPacketsinteger

包数量。

3434
EipBandwidthinteger

平均带宽值,该值等于 EipFlow/Period。单位:Byte/s。

其中 Period 默认值为 60,单位为秒。

10
TimeStampstring

查询监控信息的时间戳。ISO8601 格式,如2020-01-21T09:50:23Z

2020-01-21T09:50:23Z
EipFlowlong

流入和流出的流量总和。单位:Byte。

465
EipRXlong

流入的流量。单位:Byte。

122

示例

正常返回示例

JSON格式

{
  "RequestId": "C8B26B44-0189-443E-9816-D951F59623A9",
  "EipMonitorDatas": {
    "EipMonitorData": [
      {
        "EipTX": 343,
        "EipPackets": 3434,
        "EipBandwidth": 10,
        "TimeStamp": "2020-01-21T09:50:23Z",
        "EipFlow": 465,
        "EipRX": 122
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400InvalidParameter.TooManymonitor parameter too many data required.-
400InvalidStartTime.MalformedThe specified parameter "StartTime" is not valid.开始时间不合法。
400InvalidEndTime.MalformedThe specified parameter "EndTime" is not valid.该结束时间不合法。
400InvalidPeriod.ValueNotSupportedThe specified parameter "Period" is not valid.参数Period的值不合法。
400InvalidStartTime.TooEarlyThe specified parameter "StartTime" is too early.开始时间不合法。
400InvalidAllocationId.NotFoundSpecified allocation id is not found.指定的公网 IP 不存在,请您检查填写的公网 IP 是否正确。
400OperationDenied.TooManyDataQueriedSpecified operation is denied as too many data to return.一次查询返回的数据量过多。
404InvalidIpInstanceId.NotFoundThe specified Eip InstanceId does not exist in our records.指定的eip实例不存在。
404InvalidInstanceId.NotFoundThe InstanceId provided does not exist in our records.该 ECS 实例不存在(实例不在该 VPC 下)。
404Forbidden.RegionNotFoundSpecified region is not found during access authentication.指定 Region 不存在,请您检查该 Region 是否正确。

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

变更历史

变更时间变更内容概要操作
2022-12-02OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)