Obtain private network virtual IP information - DescribeVIP

Overview

Obtain detailed information of the internal network VIP

Definition

Public Parameters

Parameter Name	Type	Description Information	Required
Action	string	Corresponding API command name, the current API is `DescribeVIP`.	Yes
PublicKey	string	The user's public key can be obtained from Console (opens in a new tab)	Yes
Signature	string	User signature generated based on public key and API command, see Signature Algorithm	Yes

Request Parameters

Parameter Name	Type	Description Information	Required
Region	string	Region. See List of Regions and Availability Zones	Yes
Zone	string	Availability Zone. See Availability Zone List	No
ProjectId	string	Project 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
VPCId	string	The id of the VPC, must be filled in when specifying SubnetId	No
SubnetId	string	Subnet id, if not specified, all vips under VPCId will be obtained	No
VIPId	string	VIP ID	No
Tag	string	Service Group Name, default is Default	No
BusinessId	string	Business Group	No

Response Field

Field Name	Type	Description Information	Required
RetCode	int	Return status code. If it is 0, it means successful return. If it is not 0, it means failure.	Yes
Action	string	Operation command name.	Yes
Message	string	Returns an error message, providing detailed description when `RetCode` is non-zero.	No
VIPSet	array[VIPDetailSet]	Details of the internal network VIP, please see VIPDetailSet	No
DataSet	array[string]	Intranet VIP Address List	No
TotalCount	int	Number of VIPs	No

Data Model

VIPDetailSet

Field Name	Type	Description Information	Required
Zone	string	Region	No
VIPId	string	Virtual IP ID	No
CreateTime	int	Creation Time	No
RealIp	string	Real Host IP	No
VIP	string	Virtual IP	No
SubnetId	string	Subnet ID	No
VPCId	string	VPC id	No
Name	string	VIP Name	No
Remark	string	VIP Notes	No
Tag	string	VIP Business Group	No

Example

Request Example

https://api.surfercloud.com/?Action=DescribeVIP
&Region=cn-bj2
&ProjectId=org-xxx
&Zone=cn-bj2-04
&VPCId=vnet-xxx
&VIPId=BPYTaGSD
&VIPId=ANzHspQH

Response Example

{
  "Action": "DescribeVIPResponse",
  "DataSet": [
    "10.25.XX.XX"
  ],
  "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"
    }
  ]
}

DescribeSubnetResource DescribeVPC