edit-icon download-icon

DescribeEipMonitorData

Last Updated: Apr 13, 2018

Description

Query the monitoring information of EIP.

Request parameters

Name Type Required Description
Action String Yes

The action to perform.

Valid value: DescribeEipMonitorData

AllocationId String Yes The ID of the EIP instance.
StartTime String Yes

The start time to get data.

This parameter is represented according to ISO8601 and uses the time of UTC+8. Format: YYYY-MM-DDThh:mm:ssZ.

If ss is not 00, the next minute is automatically used as the start time.

EndTime String Yes

The end time of getting data.

This parameter is represented according to ISO8601 and uses the time of UTC+8. Format: YYYY-MM-DDThh:mm:ssZ.

If ss is not 00, the next minute is automatically used as the end time.

Period Integer No

The time length in seconds of each piece of monitoring data. The default value is 60.

Valid value: [60, 300, 900, 3600]

The value of (EndTime – StartTime)/ Period must be larger than 200, that is, up to 200 pieces of monitoring data are returned.

If the value of (EndTime – StartTime) is smaller than 200, only the monitoring data at the start time is returned.

Return parameters

Name Type Description
RequestId String The ID of the request.
EipMonitorDatas JSON string

An array of EIP monitoring data.

For more information, see EipMonitorDataType.

Error codes

See VPC API Error Center.

Examples

Request example

  1. https://vpc.aliyuncs.com/?Action=DescribeEipMonitorData
  2. &AllocationId=eip-2578g5v5a
  3. &StartTime=2014-10-29T23:00:00Z
  4. &EndTime=2014-10-30T08:00:00Z
  5. &<CommonParameters>

Response example

XML format

  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <DescribeEipMonitorDataResponse>
  3. <RequestId>C8B26B44-0189-443E-9816-D951F59623A9</RequestId>
  4. <EipMonitorDatas>
  5. <EipMonitorData>
  6. <EipRX>122</EipRX>
  7. <EipTX>343</EipTX>
  8. <EipFlow>675</EipFlow>
  9. <EipPackets>3434</EipPackets>
  10. <EipBandwidth>10</EipBandwidth>
  11. <TimeStamp>2010-01-21T09:50:23Z</TimeStamp>
  12. </EipMonitorData>
  13. </EipMonitorDatas>
  14. </DescribeEipMonitorDataResponse>

JSON format

  1. {
  2. "RequestId": "C8B26B44-0189-443E-9816-D951F59623A9",
  3. "EipMonitorDatas": {
  4. "EipMonitorData": [
  5. {
  6. "EipRX": "122",
  7. "EipTX": "343",
  8. "EipFlow": "675",
  9. "EipPackets": "3434",
  10. "EipBandwidth": "10",
  11. "IntranetFlow": 675,
  12. "IntranetBandwidth": 10,
  13. "TimeStamp": "2010-01-21T09:50:23Z"
  14. }
  15. ]
  16. }
  17. }
Thank you! We've received your feedback.