Private Network(UVPC)

Apply for Private Network Virtual IP - AllocateVIP


Based on the provided information, apply for an internal network VIP (Virtual IP), which is often used as a floating IP for high-availability applications.


Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is AllocateVIP.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
ZonestringAvailability ZoneNo
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
VPCIdstringSpecify the VPC to which the VIP belongsYes
SubnetIdstringSubnet IDYes
IpstringSpecify IPNo
CountintQuantity applied, default: 1No
NamestringVIP name, default: VIPNo
TagstringBusiness group name, default is DefaultNo
BusinessIdstringBusiness GroupNo

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
VIPSetarray[VIPSet]Information related to the VIP resources applied forNo
DataSetarray[string]Applied VIP AddressNo

Data Model


Field NameTypeDescription InformationRequired
VIPstringVirtual IPNo
VIPIdstringVirtual IP IDNo
VPCIdstringVPC idNo


Request Example

Response Example

  "Action": "AllocateVIPResponse",
  "DataSet": [
  "RetCode": 0,
  "VIPSet": [
      "VIP": "10.25.XX.111",
      "VIPId": "vip-XXXXXX",
      "VPCId": "uvnet-XXXXX"
  • Company
  • ContactUs
  • Blog
Copyright © 2024 SurferCloud All Rights Reserved
  • Contact our sales to help your business.
  • Contact our sales to help your business.