DescribeEipTraffic

1. API Description

This API is used to query the traffic of an elastic IP in a specified time range.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name	Required	Type	Description
eipId	Yes	String	ID of the elastic IP.
startTime	Yes	String	Start time. Use UTC time according to the ISO8601 standard. Format: YYYY-MM-DDThh:mm:ssZ.
endTime	Yes	String	End time. Use UTC time according to the ISO8601 standard. Format: YYYY-MM-DDThh:mm:ssZ.
wanIp	No	String	If the IP is a 3-in-1 elastic IP, the value is required.
step	No	Integer	Time duration. Default value: 5 minutes; Supported values: 1 or 5 minutes.

3. Output Parameters

Parameter Name	Type	Description
requestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.
dataList	Array of EipTrafficData	List of bandwidth data.
in95	Integer	Inbound burstable 95th bandwidth.
inAvg	Integer	Average value of inbound bandwidth.
inMax	Integer	Maximum value of inbound bandwidth.
inMin	Integer	Minimum value of inbound bandwidth.
inTotal	Integer	Total data transfer of inbound bandwidth.
out95	Integer	Outbound burstable 95th bandwidth.
outAvg	Integer	Average value of outbound bandwidth.
outMax	Integer	Maximum value of outbound bandwidth.
outMin	Integer	Minimum value of outbound bandwidth.
outTotal	Integer	Total data transfer of outbound bandwidth.
totalUnit	String	Unit of total data transfer. For example, B.
unit	String	Unit of bandwidth. For example, bps.

4. Code Example

Example

Query the traffic of an elastic IP in a specified time range.

POST /api/v2/vm HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: DescribeEipTraffic
<Common Request Params>

Request:
{
  "eipId": "926368879272403391",
  "startTime": "2023-07-11T08:00:011Z",
  "endTime": "2023-07-11T08:10:00Z"
}

Response:
{
  "requestId": "TE1375F34-6DC9-4BED-BDF2-DC9D07E4D3A6",
  "response": {
    "requestId": "TE1375F34-6DC9-4BED-BDF2-DC9D07E4D3A6",
    "dataList": [
      {
        "internetRX": 109096,
        "internetTX": 80,
        "time": "2023-07-11T08:05:00Z"
      },
      {
        "internetRX": 106680,
        "internetTX": 56,
        "time": "2023-07-11T08:10:00Z"
      }
    ],
    "in95": 109096,
    "inAvg": 107888,
    "inMax": 109096,
    "inMin": 106680,
    "inTotal": 8091600,
    "out95": 80,
    "outAvg": 68,
    "outMax": 80,
    "outMin": 56,
    "outTotal": 5100,
    "totalUnit": "B",
    "unit": "bps"
  }
}

5. Developer Resources

Zenlayer Cloud API 2.0 integrates SDKs to make it easier for you to call APIs. More programming languages will be supported.

6. Error Codes

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

HTTP Status Code	Error Code	Description
404	INVALID_INSTANCE_NOT_FOUND	Elastic IP does not exist.
403	INVALID_START_TIME_MUST_BEFORE_END_TIME	The start time should be earlier than the end time.
403	INVALID_TIME_RANGE	Invalid date range. The date range should be within 24 hours.
403	TIME_OUT_OF_RANGE	Only the data transfer within 30 days are supported to query.