全部产品
Search
文档中心

云服务器 ECS:DescribeEniMonitorData - 查询辅助网卡流量信息

更新时间:Feb 04, 2024

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

接口说明

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

  • 每次最多返回 400 条监控数据,即如果指定的参数(EndTime - StartTime)/Period>400,则返回错误。
  • 单次最多能查询近 30 天内的监控信息,如果指定的参数 StartTime 超过 30 天,则返回错误。

调试

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

授权信息

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

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

请求参数

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

辅助网卡的 ID。默认查询指定实例上所有已绑定的辅助网卡。

eni-bp19da36d6xdwey****
RegionIdstring

地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。

cn-hangzhou
InstanceIdstring

辅助网卡绑定的实例 ID。

i-bp1a5zr3u7nq9cx****
StartTimestring

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

2018-05-21T12:19:00Z
EndTimestring

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

2018-05-21T12:22:00Z
Periodinteger

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

  • 60。
  • 600。
  • 3600。

默认值:60。

60

返回参数

名称类型描述示例值
object
TotalCountinteger

返回条目数量。

4
RequestIdstring

请求 ID。

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

辅助网卡流量的监控数据 EniMonitorDataType 组成的集合。

PacketRxstring

辅助网卡接收的内网数据包,单位:packets。

0
TimeStampstring

查询监控信息的时间戳。按照 ISO 8601 标准表示,并使用 UTC +0 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。

2018-05-21T03:22:00Z
DropPacketRxstring

辅助网卡接收丢弃的内网数据包,单位:packets。

0
EniIdstring

辅助网卡 ID。

eni-bp19da36d6xdwey****
DropPacketTxstring

辅助网卡发送丢弃的内网数据包,单位:packets。

0
PacketTxstring

辅助网卡发送的内网数据包,单位:packets。

0
IntranetTxstring

辅助网卡发送的内网数据平均速率,单位:kB/s。

0
IntranetRxstring

辅助网卡接收的内网数据平均速率,单位: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"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
403InvalidStartTime.MalformedThe specified parameter "StartTime" is not valid.-
403InvalidEndTime.MalformedThe specified parameter "EndTime" is not valid.传入的参数EndTime不符合规则。
403InvalidPeriod.ValueNotSupportedThe specified parameter "Period" is not valid.-
403InvalidStartTime.TooEarlyThe specified parameter "StartTime" is too early.-
403InvalidParameter.TooManyDataQueriedToo many data queried.监控数据节点超出范围。
403ThrottlingRequest was denied due to request throttling.请求被流控。
403InvalidInstanceType.NotSupportCreditThe InstanceType of the specified instance does not support credit.实例规格不支持突发性能实例。
403InvalidParameter.EndTimeThe specified parameter EndTime is earlier than StartTime.结束时间不能早于开始时间。
404InvalidDiskId.NotFoundThe DiskId provided does not exist in our records.指定的磁盘不存在。请您检查磁盘 ID 是否正确。
4003InvalidParam.MalformedThe specified parameter "EniId" and "InstanceId" are not valid-

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