调用DescribeEipMonitorData查看EIP的监控信息_专有网络VPC(VPC)-阿里云帮助中心

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

接口说明

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

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
vpc:DescribeEipMonitorData	get	*Address `acs:vpc:{#regionId}:{#accountId}:eip/{#AllocationId}`	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	否	EIP 所属地域 ID。您可以通过调用 DescribeRegions 接口获取地域 ID。	cn-hangzhou
AllocationId	string	是	EIP 的实例 ID。	eip-2zeerraiwb7uj6idcfv****
StartTime	string	是	获取数据的起始时间。使用 UTC 时间。按照 ISO8601 标准，格式为`YYYY-MM-DDThh:mm:ssZ`。例如，北京时间 2013 年 01 月 10 日 20 点 00 分 00 秒，表示为`2013-01-10T12:00:00Z`。如果不是整分，则自动取下一分钟为起始时间点。	2020-01-05T01:05:05Z
EndTime	string	是	获取数据的结束时间。使用 UTC 时间。按照 ISO8601 标准，格式为`YYYY-MM-DDThh:mm:ssZ`。例如，北京时间 2013 年 01 月 10 日 20 点 00 分 00 秒，表示为`2013-01-10T12:00:00Z`。如果不是整分，则自动取下一分钟为结束时间点。	2020-01-05T03:05:10Z
Period	integer	否	每条监控数据的时间长度。单位：秒。取值：60（默认值）、300 、 900 或 3600。如果（EndTime–StartTime）/ Period 小于等于 400，可正常返回起始时间点到结束时间点的所有监控数据。如果（EndTime–StartTime）/ Period 大于 400，无法正常返回监控数据。	60

返回参数

名称	类型	描述	示例值
	object	返回信息列表。
RequestId	string	请求 ID。	C8B26B44-0189-443E-9816-D951F59623A9
EipMonitorDatas	array<object>	EIP 监控数据的详细信息。
EipMonitorData	object	EIP 监控数据的详细信息。
EipTX	long	流出的流量。单位：Byte。	343
EipPackets	integer	包数量。	3434
EipBandwidth	integer	平均带宽值，该值等于 EipFlow/Period。单位：Byte/s。其中 Period 默认值为 60，单位为秒。	10
TimeStamp	string	查询监控信息的时间戳。ISO8601 格式，如`2020-01-21T09:50:23Z`。	2020-01-21T09:50:23Z
EipFlow	long	流入和流出的流量总和。单位：Byte。	465
EipRX	long	流入的流量。单位：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	错误码	错误信息	描述
400	InvalidParameter.TooMany	monitor parameter too many data required.	存在多个无效入参。
400	InvalidStartTime.Malformed	The specified parameter "StartTime" is not valid.	开始时间不合法。
400	InvalidEndTime.Malformed	The specified parameter "EndTime" is not valid.	该结束时间不合法。
400	InvalidPeriod.ValueNotSupported	The specified parameter "Period" is not valid.	参数Period的值不合法。
400	InvalidStartTime.TooEarly	The specified parameter "StartTime" is too early.	开始时间不合法。
400	InvalidAllocationId.NotFound	Specified allocation id is not found.	指定的公网 IP 不存在，请您检查填写的公网 IP 是否正确。
400	OperationDenied.TooManyDataQueried	Specified operation is denied as too many data to return.	一次查询返回的数据量过多。
404	InvalidIpInstanceId.NotFound	The specified Eip InstanceId does not exist in our records.	指定的eip实例不存在。
404	InvalidInstanceId.NotFound	The InstanceId provided does not exist in our records.	该 ECS 实例不存在（实例不在该 VPC 下）。
404	Forbidden.RegionNotFound	Specified region is not found during access authentication.	指定 Region 不存在，请您检查该 Region 是否正确。

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

变更历史

变更时间	变更内容概要	操作
2022-12-02	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情