Private Network(UVPC)

Batch Application for Auxiliary IP of Virtual Network Card - AllocateBatchSecondaryIp


Batch Application for Auxiliary IP of Virtual Network Card

💡 Only one of IP and Count is allowed to have parameters at the same time.


Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is AllocateBatchSecondaryIp.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
ZonestringAvailability Zone. See Availability Zone ListYes
ProjectIdstringProject ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the GetProjectList interface.Yes
MacstringNode macYes
ObjectIdstringResource IdYes
SubnetIdstringSubnet Id (If not specified, the default subnet will be created based on the zone)No
Ip.Nstring[arry] Supports applying in the following ways: ① By subnet: such as, the smallest mask number is 27 ② Specify IP address, such as
CountintNumber of Intranet IPs appliedNo

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
IpsInfoarray[IpsInfo]See IpsInfoYes

Data Model


Field NameTypeDescription InformationRequired
IpstringPrivate IP AddressNo
MacstringMAC AddressNo
SubnetIdstringSubnet Resource IDNo
VPCIdstringVPC Resource IDNo
StatusStatusInfoIP allocation result, see StatusInfoNo


Field NameTypeDescription InformationRequired
StatusCodestringEnumeration values: Succeeded, FailedNo
MessagestringReason for IP Assignment FailureNo


Request Example

Response Example

  "Action": "AllocateBatchSecondaryIpResponse",
  "IpInfo": [
      "Gateway": "pSmgKDHW",
      "Ip": "kfVBsTcw",
      "Mac": "MPJCarZQ",
      "Mask": "HbZJCMWG",
      "Status": [
          "Message": "CIEfBloY",
          "StatusCode": "vvInRaak"
      "SubnetId": "dnSKxsEH",
      "VPCId": "jfctXBmr"
  "RetCode": 0
  • Company
  • ContactUs
  • Blog
Copyright © 2024 SurferCloud All Rights Reserved
  • Contact our sales to help your business.
  • Contact our sales to help your business.