All Products
Search
Document Center

ENS:DescribeEpnBandWidthData

Last Updated:Mar 20, 2024

Queries the EPN bandwidth usage.

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
EnsRegionIdstringNo

The ID of the Edge Node Service (ENS) node.

cn-beijing-cmcc
InstanceIdstringNo

The ID of the instance.

i-5sg1owx0g4ojy66ab2tez77r2
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 the seconds place is not 00, the start time is automatically set to the next minute.
2021-12-15T16:00: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 the seconds place is not 00, the start time is automatically set to the next minute.
2021-12-16T16:00:00Z
PeriodstringYes

The precision of the monitoring data that you want to obtain. Valid values: 300, 1200, 3600, and 14400. Default value: 300. Unit: seconds.

300
IspstringNo

The Internet service provider (ISP). Valid values:

  • cmcc: China Mobile
  • telecom: China Telecom
  • unicom: China Unicom
  • multiCarrier: multi-line ISP
cmcc
NetworkingModelstringNo

The networking mode. Valid values:

  • SpeedUp: intelligent acceleration network (Internet)
  • Connection: internal network
  • SpeedUpAndConnection: intelligent acceleration network and internal network
SpeedUp
EPNInstanceIdstringNo

The ID of the EPN instance.

epn-20200825134537VyK81T

Response parameters

ParameterTypeDescriptionExample
object
MonitorDataobject

The monitoring data of the instance.

BandWidthMonitorDataobject []

The bandwidth data.

DownBandWidthlong

The outbound bandwidth. Unit: bit/s.

0
InternetRXlong

The Internet traffic to the instance. Unit: bytes.

0
InternetTXlong

The Internet traffic from the instance. Unit: bytes.

0
TimeStampstring

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

2019-10-12T05:45:00Z
UpBandWidthlong

The inbound bandwidth. Unit: bit/s.

0
MaxDownBandWidthlong

The maximum outbound bandwidth within the queried time range. Unit: bit/s.

16817468
MaxUpBandWidthlong

The maximum inbound bandwidth within the queried time range. Unit: bit/s.

231008
RequestIdstring

The request ID.

1D289DAA-F6DA-5FC4-AE47-F5C8B6277BFC

Examples

Sample success responses

JSONformat

{
  "MonitorData": {
    "BandWidthMonitorData": [
      {
        "DownBandWidth": 0,
        "InternetRX": 0,
        "InternetTX": 0,
        "TimeStamp": "2019-10-12T05:45:00Z",
        "UpBandWidth": 0
      }
    ],
    "MaxDownBandWidth": 16817468,
    "MaxUpBandWidth": 231008
  },
  "RequestId": "1D289DAA-F6DA-5FC4-AE47-F5C8B6277BFC"
}

Error codes

HTTP status codeError codeError message
400MissingParameterThe input parameters that is mandatory for processing this request is not supplied.
400USERNOTFOUNDThe user is not in ens-controller.
400NoPermissionPermission denied.
400InvalidParameter.%sThe specified field %s invalid. Please check it again.

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

Change history

Change timeSummary of changesOperation
2024-01-25The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
Input ParametersThe request parameters of the API has changed.
    delete Input Parameters: Version