DescribeEipTraffic

1. API Description

This API (DescribeEipTraffic) is used to query the traffic monitoring data of the specified elastic IP within a given time range. Supports data aggregation by statistical granularity (step) and filtering by outbound public IP.

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 .
step	No	Integer	Time duration. Default value: 5 minutes; Supported values: 1 or 5 minutes. Default value: 5
wanIp	No	String	Query traffic by a specified IP address.
direction	No	EipTrafficDirection	Traffic direction.

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.

4. Code Example

Example

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

POST /api/v2/zec 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
400	INVALID_TIME_RANGE	The query time range is invalid.
400	OPERATION_DENIED_TIME_STEP_NOT_SUPPORT	Data point intervals are not supported.
400	OPERATION_DENIED_EIP_DIRECTION_NOT_SUPPORTED	The direction parameter is only valid for PathBasedBandwidthIP type EIPs.