Basic Network(UNet)

Get shared bandwidth information - DescribeShareBandwidth


Get shared bandwidth information


Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is DescribeShareBandwidth.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
ShareBandwidthIds.NstringShared Bandwidth Id to be returnedNo

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
DataSetarray[UnetShareBandwidthSet]Shared Bandwidth Information Group See UnetShareBandwidthSetNo
TotalCountintThe total shared bandwidth that meets the conditions, is greater than or equal to the returned DataSet length.No

Data Model


Field NameTypeDescription InformationRequired
IPVersionstringShared Bandwidth TypeYes
ShareBandwidthintShared Bandwidth Value (Prepaid)/Shared Bandwidth Peak (Postpaid), Unit MbpsNo
ShareBandwidthIdstringResource ID of Shared BandwidthNo
ChargeTypestringPayment method, Prepayment: Yearly, Monthly, Dynamic Pay-as-you-go; Postpayment: PostPay (Monthly)No
CreateTimeintCreation time, in Unix Timestamp formatNo
ExpireTimeintExpiration time, in Unix Timestamp formatNo
EIPSetarray[EIPSetData]EIP Information, see EIPSetData for detailsNo
NamestringShared Bandwidth NameNo


Field NameTypeDescription InformationRequired
BandwidthintEIP Bandwidth ValueNo
EIPAddrarray[EIPAddrSet]EIP's IP information, see EIPAddrSet for details.No
EIPIdstringEIP Resource IdNo


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


Request Example

Response Example

  "Action": "DescribeShareBandwidthResponse",
  "DataSet": [
      "ChargeType": "Dynamic",
      "CreateTime": 1529660427,
      "EIPSet": [
          "Bandwidth": 1000,
          "EIPAddr": [
              "IP": "106.75.XX.XX",
              "OperatorName": "BGP"
          "EIPId": "eip-XXXXX"
      "ExpireTime": 1529898027,
      "Name": "test",
      "ShareBandwidth": 20,
      "ShareBandwidthId": "bwshare-XXXX"
  "Request_uuid": "a36b7aec-3911-4096-9110-XXXXX",
  "RetCode": 0,
  "TotalCount": 1,
  "TotolCount": 2
  • Company
  • ContactUs
  • Blog
Copyright © 2024 SurferCloud All Rights Reserved
  • Contact our sales to help your business.
  • Contact our sales to help your business.