Private Network(UVPC)

Obtain private network virtual IP information - DescribeVIP


Obtain detailed information of the internal network VIP


Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is DescribeVIP.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 ListNo
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.Yes
VPCIdstringThe id of the VPC, must be filled in when specifying SubnetIdNo
SubnetIdstringSubnet id, if not specified, all vips under VPCId will be obtainedNo
TagstringService 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[VIPDetailSet]Details of the internal network VIP, please see VIPDetailSetNo
DataSetarray[string]Intranet VIP Address ListNo
TotalCountintNumber of VIPsNo

Data Model


Field NameTypeDescription InformationRequired
VIPIdstringVirtual IP IDNo
CreateTimeintCreation TimeNo
RealIpstringReal Host IPNo
VIPstringVirtual IPNo
SubnetIdstringSubnet IDNo
VPCIdstringVPC idNo
NamestringVIP NameNo
RemarkstringVIP NotesNo
TagstringVIP Business GroupNo


Request Example

Response Example

  "Action": "DescribeVIPResponse",
  "DataSet": [
  "RetCode": 0,
  "TotalCount": 1,
  "VIPSet": [
      "CreateTime": 1521970238,
      "Name": "VIP",
      "RealIp": "",
      "Remark": "Default",
      "SubnetId": "subnet-XXX",
      "Tag": "Default",
      "VIP": "10.25.XX.XX",
      "VIPId": "vip-XXX",
      "VPCId": "uvnet-XXX",
      "Zone": "cn-sh2-01"
  • Company
  • ContactUs
  • Blog
Copyright © 2024 SurferCloud All Rights Reserved
  • Contact our sales to help your business.
  • Contact our sales to help your business.