Basic Network(UNet)

Get Bandwidth Usage - DescribeBandwidthUsage


Get Bandwidth Usage Information


Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is DescribeBandwidthUsage.Yes
PublicKeystringThe user's public key can be obtained from Console (opens in a new tab)Yes
SignaturestringUser signature generated based on public key and API command, see Signature AlgorithmYes

Request Parameters

Parameter NameTypeDescription InformationRequired
RegionstringRegion. See List of Regions and Availability ZonesYes
ProjectIdstringProject ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the GetProjectList interface.No
LimitintReturn data pagination value, the integer value range is between [0,10000000], default is 20No
OffSetintReturn data offset, default is 0No
EIPIds.NstringThe Resource Id of the Elastic IP. If it is empty, it will return the bandwidth usage of all EIPs in the current Region that meet the conditions, where n is a natural number.No
BeginTimeintStart Time of StatisticsNo
EndTimeintEnd Time of StatisticsNo

Response Field

Field NameTypeDescription InformationRequired
RetCodeintReturn status code. If it is 0, it means successful return. If it is not 0, it means failure.Yes
ActionstringOperation command name.Yes
MessagestringReturns an error message, providing detailed description when RetCode is non-zero.No
TotalCountintThe number of elements in EIPSetNo
EIPSetarray[UnetBandwidthUsageEIPSet]Detailed bandwidth usage information for a single Elastic IP, see UnetBandwidthUsageEIPSet, if there is no Elastic IP resource, this return value does not exist.No

Data Model


Field NameTypeDescription InformationRequired
CurBandwidthfloatBandwidth usage in the last 5 minutes, unit in MbpsNo
EIPIdstringElastic IP Resource IDNo


Request Example

Response Example

  "Action": "DescribeBandwidthUsageResponse",
  "EIPSet": [
      "CurBandwidth": 0.0000629425048828125,
      "EIPId": "eip-XXXX"
  "RetCode": 0,
  "TotalCount": 1
  • Company
  • ContactUs
  • Blog
Copyright © 2024 SurferCloud All Rights Reserved
  • Contact our sales to help your business.
  • Contact our sales to help your business.