DescribeEniMonitorData - 查询辅助网卡监控数据 - 云服务器 ECS

调用DescribeEniMonitorData查询一块辅助网卡在指定时间段内使用的流量信息。

接口说明

可查询的辅助网卡流量信息包括辅助网卡收发数据包的数量、内网出入流量、辅助网卡收发丢包的数量。当返回信息中缺少部分内容时，可能是由于系统没有获取到相应的信息。例如，当实例处于已停止（Stopped）状态或者辅助网卡没有挂载到实例上，即处于可用（Available）状态时，无法获取到相应的信息。调用该接口时，您需要注意：

一次最多返回 400 条数据，需满足（EndTime–StartTime）/Period小于等于 400 的条件限制，即返回参数TotalCount不能超过 400，否则将返回InvalidParameter.TooManyDataQueried的错误提示。
一次最多能查询近 30 天内的监控信息，即指定的参数StartTime距今不能超过 30 天。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

ecs:DescribeEniMonitorData

get

NetworkInterface

acs:ecs:{#regionId}:{#accountId}:eni/{#eniId}

*Instance

acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}

无

请求参数

名称	类型	必填	描述	示例值
EniId	string	否	辅助网卡的 ID。默认查询指定实例上所有已绑定的辅助网卡。	eni-bp19da36d6xdwey****
RegionId	string	是	地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。	cn-hangzhou
InstanceId	string	是	辅助网卡绑定的实例 ID。	i-bp1a5zr3u7nq9cx****
StartTime	string	是	获取数据的起始时间点。按照ISO 8601标准表示，并使用 UTC +0 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。如果指定的秒（ss）不是 00，则自动换算为下一分钟。	2018-05-21T12:19:00Z
EndTime	string	是	获取数据的结束时间点。按照ISO 8601标准表示，并使用 UTC +0 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。如果指定的秒（ss）不是 00，则自动换算为下一分钟。	2018-05-21T12:22:00Z
Period	integer	否	获取监控数据的间隔时间，单位：秒。取值范围： 60。 600。 3600。默认值：60。	60

返回参数

名称	类型	描述	示例值
	object
TotalCount	integer	返回条目数量。	4
RequestId	string	请求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
MonitorData	object
EniMonitorData	array<object>	辅助网卡流量的监控数据 EniMonitorDataType 组成的集合。
	object
PacketRx	string	辅助网卡接收的内网数据包，单位：packets。	0
TimeStamp	string	查询监控信息的时间戳。按照 ISO 8601 标准表示，并使用 UTC +0 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。	2018-05-21T03:22:00Z
DropPacketRx	string	辅助网卡接收丢弃的内网数据包，单位：packets。	0
EniId	string	辅助网卡 ID。	eni-bp19da36d6xdwey****
DropPacketTx	string	辅助网卡发送丢弃的内网数据包，单位：packets。	0
PacketTx	string	辅助网卡发送的内网数据包，单位：packets。	0
IntranetTx	string	辅助网卡发送的内网数据平均速率，单位：kB/s。	0
IntranetRx	string	辅助网卡接收的内网数据平均速率，单位：kB/s。	0

示例

正常返回示例

JSON格式

{
  "TotalCount": 4,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "MonitorData": {
    "EniMonitorData": [
      {
        "PacketRx": "0",
        "TimeStamp": "2018-05-21T03:22:00Z",
        "DropPacketRx": "0",
        "EniId": "eni-bp19da36d6xdwey****",
        "DropPacketTx": "0",
        "PacketTx": "0",
        "IntranetTx": "0",
        "IntranetRx": "0"
      }
    ]
  }
}

异常返回示例

JSON格式

{
 "RequestId":"5A03C2BA-3BCE-4A87-8076-7DC1629",
 "MonitorData":{
     "EniMonitorData":[
         {
             "PacketTx":0,
             "TimeStamp":"2018-05-21T03:22:00Z",
             "IntranetOut":0,
             "DropPacketRx":0,
             "IntranetIn":0,
             "EniId":"eni-myENI",
             "DropPacketTx":0,
             "PacketRx":0
         },
         {
             "PacketTx":0,
             "TimeStamp":"2018-05-21T03:21:00Z",
             "IntranetOut":0,
             "DropPacketRx":0,
             "IntranetIn":0,
             "EniId":"eni-myENI",
             "DropPacketTx":0,
             "PacketRx":0
         },
         {
             "PacketTx":52240,
             "TimeStamp":"2018-05-21T03:19:00Z",
             "IntranetOut":73344,
             "DropPacketRx":0,
             "IntranetIn":467,
             "EniId":"eni-myENI",
             "DropPacketTx":0,
             "PacketRx":6603
         },
         {
             "PacketTx":34925,
             "TimeStamp":"2018-05-21T03:20:00Z",
             "IntranetOut":48871,
             "DropPacketRx":0,
             "IntranetIn":350,
             "EniId":"eni-myENI",
             "DropPacketTx":0,
             "PacketRx":4888
         }
     ]
 }
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidEniId.NotFound	The specified ENI ID does not exist.	无效的实例。
403	InvalidStartTime.Malformed	The specified parameter "StartTime" is not valid.
403	InvalidEndTime.Malformed	The specified parameter "EndTime" is not valid.
403	InvalidPeriod.ValueNotSupported	The specified parameter "Period" is not valid.
403	InvalidStartTime.TooEarly	The specified parameter "StartTime" is too early.
403	InvalidParameter.TooManyDataQueried	Too many data queried.
403	Throttling	Request was denied due to request throttling.
403	InvalidInstanceType.NotSupportCredit	The InstanceType of the specified instance does not support credit.
403	InvalidParameter.EndTime	The specified parameter EndTime is earlier than StartTime.
4003	InvalidParam.Malformed	The specified parameter "EniId" and "InstanceId" are not valid
404	InvalidDiskId.NotFound	The DiskId provided does not exist in our records.	指定的磁盘不存在。请您检查磁盘 ID 是否正确。
404	InvalidEcsId.NotFound	The specified instance ID is invalid.	无效的实例。

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

变更历史

更多信息，参考变更详情。