Docs
api
Basic Network(UNet)
AllocateShareBandwidth

Enable Shared Bandwidth - AllocateShareBandwidth

Overview

Enable Shared Bandwidth

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is AllocateShareBandwidth.Yes
PublicKeystringThe user’s public key can be obtained from ConsoleYes
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 will be used. Sub-accounts must be filled in.No
NamestringShared Bandwidth NameYes
ChargeTypestringPayment method: Year Yearly, Month Monthly, Dynamic Hourly;Yes
ShareBandwidthintShared Bandwidth ValueYes
QuantityintPurchasing DurationNo
IPVersionstringShared bandwidth type, IPv4 or IPv6, defaults to IPv4 if not passed.No
OperatorNamestringShared Bandwidth Lines: BGP Domestic Multi-line, International Multi-line, ChinaMobile Mobile Single-line, Unicom Unicom Single-line, Telecom Telecom Single-line, BGPPro Premium BGP (Only Hong Kong supports Premium BGP)No
TagstringBusiness group name, default is “Default”No

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
ShareBandwidthIdstringShared Bandwidth Resource IdNo

Example

Request Example

https://api.dezai.com/?Action=AllocateShareBandwidth
&Region=cn-bj2
&ShareBandwidth=20
&ChargeType=Month
&Name=sharebwname
&BwType=XnbjjTdZ
&OperatorName=TUhLWpBx
&Tag=odFOhzhe

Response Example

{
  "Action": "AllocateShareBandwidthResponse",
  "Request_uuid": "94053674-0160-40f2-8981-XXXXXXX",
  "RetCode": 0,
  "ShareBandwidthId": "mdfMzyBm"
}