DescribeEipMonitorData - 查看EIP的監控資訊 - Elastic IP Address

介面說明

為了提供更好的擷取監控資料介面體驗，建議您使用CloudMonitor（CloudMonitor）提供的統一介面 DescribeMetricList 查詢 EIP 相關資料。更多資訊，請參見 DescribeMetricList 和彈性公網 IP 相關資料。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

當前API暫無授權資訊透出。

請求參數

名稱	類型	必填	描述	樣本值
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	object
EipMonitorData	array<object>	EIP 監控資料的詳細資料。
	object	EIP 監控資料的詳細資料。
EipTX	integer	流出的流量。單位：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	integer	流入和流出的流量總和。單位：Byte。	465
EipRX	integer	流入的流量。單位：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.
400	InvalidStartTime.TooEarly	The specified parameter "StartTime" is too early.
400	InvalidAllocationId.NotFound	Specified allocation id is not found.
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.
404	InvalidInstanceId.NotFound	The InstanceId provided does not exist in our records.
404	Forbidden.RegionNotFound	Specified region is not found during access authentication.

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。