Basic Network(UNet)

Get Bandwidth Package Information - DescribeBandwidthPackage


Obtain bandwidth package information for a specific region


Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is DescribeBandwidthPackage.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, and the sub-account 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

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
TotalCountintTotal number of bandwidth packages that meet the conditionsNo
DataSetsarray[UnetBandwidthPackageSet]Details of Bandwidth Package, see UnetBandwidthPackageSetNo

Data Model


Field NameTypeDescription InformationRequired
BandwidthPackageIdstringResource ID of the bandwidth packageNo
EnableTimeintEffective time, in Unix Timestamp formatNo
DisableTimeintExpiration Time, in Unix Timestamp formatNo
CreateTimeintCreation time, in Unix Timestamp formatNo
BandwidthintTemporary bandwidth value of the bandwidth package, unit MbpsNo
EIPIdstringThe resource ID of the Elastic IP bound to the bandwidth packageNo
EIPAddrarray[EIPAddrSet]Details of the Elastic IP bound to the bandwidth package. Only when the EIPId corresponds to a dual-line IP, the length of EIPAddr is 2. In other cases, the length of EIPAddr is always 1. See EIPAddrSet for reference.No


Field NameTypeDescription InformationRequired
OperatorNamestringOperator Information, enumeration values are: BGP: BGP; International: International.No
IPstringElastic IP AddressNo


Request Example

Response Example

  "Action": "DescribeBandwidthPackageResponse",
  "DataSets": [
      "Bandwidth": 200,
      "BandwidthPackageID": "bwpack-XXXXXX",
      "CreateTime": 1430990525,
      "DisableTime": 1430997725,
      "EIPAddr": [
          "IP": "123.59.XX.XX",
          "OperatorName": "BGP"
      "EIPId": "eip-XXXXX",
      "EnableTime": 1430990525
  "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.