All Products
Search
Document Center

Elastic Compute Service:DescribeEniMonitorData

Last Updated:Mar 19, 2024

Queries the monitoring data of a secondary elastic network interface (ENI) over a specific period of time.

Operation description

The monitoring data includes traffic sent and received over the internal network, the number of packets sent and received by the secondary ENI, and the number of dropped packets sent and received by the secondary ENI. Specific information may be missing from the returned monitoring data. This is because the system cannot obtain the relevant information. For example, if the instance to which the secondary ENI is bound is in the Stopped state, or if the secondary ENI is not bound to an instance and is in the Available state, the monitoring data of the secondary ENI cannot be obtained. When you call this operation, take note of the following items:

  • Up to 400 monitoring data entries can be returned at a time. If the value that is calculated by using the following formula is greater than 400: (EndTime - StartTime)/Period, an error is returned.
  • Only the monitoring data within the last 30 days can be queried. If the value of StartTime is more than 30 days earlier than the time when you call this operation, an error is returned.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
EniIdstringNo

The secondary ENI ID. By default, all secondary ENIs that are bound to the specified instance are queried.

eni-bp19da36d6xdwey****
RegionIdstringYes

The region ID. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
InstanceIdstringYes

The ID of the instance to which the secondary ENI is bound.

i-bp1a5zr3u7nq9cx****
StartTimestringYes

The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. If the value of seconds (ss) is not 00, the time is rounded up to the next minute.

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

The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. If the value of seconds (ss) is not 00, the time is rounded up to the next minute.

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

The interval at which to retrieve monitoring data. Unit: seconds. Valid values:

  • 60
  • 600
  • 3600

Default value: 60.

60

Response parameters

ParameterTypeDescriptionExample
object
TotalCountinteger

The total number of entries returned.

4
RequestIdstring

The request ID.

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

The details about the monitoring data of the secondary ENI.

PacketRxstring

The number of packets received by the secondary ENI over the internal network.

0
TimeStampstring

The timestamp to query the monitoring data. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

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

The number of dropped packets received by the secondary ENI over the internal network.

0
EniIdstring

The secondary ENI ID.

eni-bp19da36d6xdwey****
DropPacketTxstring

The number of dropped packets sent by the secondary ENI over the internal network.

0
PacketTxstring

The number of packets sent by the secondary ENI over the internal network.

0
IntranetTxstring

The average rate of data sent by the secondary ENI over the internal network. Unit: Kbit/s.

0
IntranetRxstring

The average rate of data received by the secondary ENI over the internal network. Unit: Kbit/s.

0

Examples

Sample success responses

JSONformat

{
  "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"
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
403InvalidStartTime.MalformedThe specified parameter "StartTime" is not valid.-
403InvalidEndTime.MalformedThe specified parameter "EndTime" is not valid.The specified EndTime parameter is invalid.
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.The instance type does not support burstable instances.
403InvalidParameter.EndTimeThe specified parameter EndTime is earlier than StartTime.The end time cannot be earlier than the start time.
404InvalidDiskId.NotFoundThe DiskId provided does not exist in our records.The specified disk does not exist. Check whether the disk ID is correct.
4003InvalidParam.MalformedThe specified parameter "EniId" and "InstanceId" are not valid-

For a list of error codes, visit the Service error codes.