Get VPC Information - DescribeVPC

Overview

Get VPC Information

Definition

Public Parameters

Parameter Name	Type	Description Information	Required
Action	string	Corresponding API command name, the current API is `DescribeVPC`.	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
ProjectId	string	Project ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the GetProjectList interface.	Yes
VPCIds.N	string	VPCId	No
Tag	string	Business Group Name	No
Offset	int	Data offset, default is 0	No
Limit	int	Data Pagination Value	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
DataSet	array[VPCInfo]	VPC information, see the specific structure below VPCInfo	No
TotalCount	int		No

Data Model

VPCInfo

Field Name	Type	Description Information	Required
NetworkInfo	array[VPCNetworkInfo]	VPC address space information, see VPCNetworkInfo	Yes
SubnetCount	int	Subnet Number	Yes
CreateTime	int	Creation Time	Yes
UpdateTime	int	Update Time	Yes
Tag	string	Business Group	Yes
Name	string	VPC Name	Yes
VPCType	string	DefaultVPC Default VPC, DefinedVPC, Custom VPC	No
VPCId	string	VPC Resource ID	No
Network	array[string]	VPC Subnet	No
IPv6Network	string	IPv6 segment associated with VPC	No
OperatorName	string	The IPv6 network segment associated with the VPC belongs to the operator	No

VPCNetworkInfo

Field Name	Type	Description Information	Required
Network	string	VPC address space	No
SubnetCount	int	Number of Subnets in Address Space	No

Example

Request Example

https://api.surfercloud.com/?Action=DescribeVPC
&ProjectId=org-xxx
&Region=cn-sh2
&VPCIds.0=uvnet-xxx
&Offset=9
&Limit=9

Response Example

{
  "Action": "DescribeVPCResponse",
  "DataSet": [
    {
      "CreateTime": 1514313728,
      "Name": "DefaultVPC",
      "Network": [
        "10.44.x.0/16"
      ],
      "NetworkInfo": [
        {
          "Network": "10.44.x.0/16",
          "SubnetCount": 1
        }
      ],
      "SubnetCount": 1,
      "Tag": "Default",
      "UpdateTime": 1514313728,
      "VPCId": "uvnet-xxx"
    },
    {
      "CreateTime": 1533891436,
      "Name": "testabc",
      "Network": [
        "192.168.x.0/16",
        "10.0.0.0/8"
      ],
      "NetworkInfo": [
        {
          "Network": "192.168.x.0/16",
          "SubnetCount": 1
        },
        {
          "Network": "10.0.0.0/8",
          "SubnetCount": 1
        }
      ],
      "Remark": "",
      "SubnetCount": 2,
      "Tag": "Default",
      "UpdateTime": 1533891438,
      "VPCId": "uvnet-xxxxx"
    }
  ],
  "RetCode": 0,
  "TotalCount": 9
}

DescribeVIP DescribeVPCIntercom