文档中心 > DescribeVpn
DescribeVpn

最近更新时间:2021-12-29

请求方法:GET

接口描述:调用DescribeVpn接口获取VPN列表。


请求参数

Param

名称

类型

是否必选

描述

Action

String

要执行的操作,取值:DescribeVpn。

RegionId

String

地域ID。

Page

Integer

当前页。

Size

Integer

页数大小。


返回参数

名称

类型

描述

Code

String

操作结果编码。

Msg

String

操作结果描述。

Res

Object

请求结果。

+Page

Integer

当前页。

+Size

Integer

页数大小。

+Total

Long

总条数。

+Data

Object[]

响应数据。

++RegionId

String

区域ID。

++AzoneId

String

可用域ID。

++InstanceId

String

NAT的ID。

++InstanceName

String

NAT的名称。

++UserId

String

用户ID。

++Status

String

状态。

++VpcId

String

VPC的ID。

++Vpc

Object

VPC信息。

++SubnetId

String

子网ID。

++PrivateAddress

String

私网IP。

++InstanceTypeCode

String

规格码。

++Bandwidth

Integer

带宽。

++ConnectionCount

Integer

最大连接数。

++InstanceBandwidth

Object

带宽规格信息。

++InstanceBandwidthCode

String

带宽规格码。

++Description

String

描述信息。

++InstanceOperationInfo

Object


++instanceType

Object


++PublicAddress

String

公网IP。


示例

请求示例

GET https://api.unicloud.com/networks/vpn?Action=DescribeVpn
&RegionId=cn-beijing
&Page=1
&Size=10
&<公共请求参数>

返回示例

JSON 格式

{
 "Msg": "查询VPN网关成功",
 "Res": {
   "Size": 10,
   "Total": 1,
   "Data": [
    {
       "Status": "CREATING",
       "InstanceTypeCode": "vpn.ipsec.normal",
       "Description": "",
       "InstanceBandwidth": {
         "Describe": "VPN公网-静态BGP多线*Mbps",
         "SpecificationCode": "vpn.bgp.static",
         "RangeAttribute": "bandwidth",
         "ComponentCode": "VpnBandwidth",
         "CreateTime": 1593762574623,
         "SpecificationClassCode": "vpn.bgp",
         "Step": "1",
         "SpecificationId": "1278959052243599360",
         "Start_bandwidth": "10",
         "UpdateTime": 1593765870289,
         "_id": {
           "TimeSecond": 1593762574,
           "Counter": 10287257,
           "MachineIdentifier": 10591708,
           "Time": 1593762574000,
           "Timestamp": 1593762574,
           "Date": 1593762574000,
           "ProcessIdentifier": 9
        },
         "SpecificationName": "BGP(多线)",
         "End_bandwidth": "500"
      },
       "InstanceId": "vpn-ke9lg11d6lk3",
       "InstanceOperationInfo": {
         "InstanceStartTime": 1606987364000,
         "IsPay": 1,
         "DueTime": "2021-01-04",
         "IsOld": 0,
         "RentUnit": "month",
         "AzId": "cn-beijing-a",
         "RegionName": "华北2-北京2",
         "OperationStatus": 1,
         "InstanceLabel": 1,
         "UserName": "moove-test19",
         "ProductCode": "VPN",
         "CreateTime": 1606987364000,
         "ProductType": "instance",
         "PayType": "YEAR_MONTH",
         "FormalPayTime": 1606987364000,
         "OrderId": 1334427833472540724,
         "IsMspProduct": false,
         "RentCount": 1,
         "InstanceName": "test",
         "ChargeType": 0,
         "UserId": "66c63797-961c-4783-8808-34464b64df96",
         "UpdateTime": 1606987364000,
         "RenewType": 1,
         "InstanceDescription": "",
         "Id": "vpn-ke9lg11d6lk3",
         "InstanceEndTime": 1609689600000,
         "RegionId": "cn-beijing",
         "IsPayClose": false
      },
       "Vpc": {
         "InstanceName": "vpntest",
         "Status": "RUNNING",
         "Subnets": [
          {
             "BindResources": [
              {
                 "ReviceId": "vpn-ke8n9ao02jlu",
                 "ResourceType": "UNICLOUD::VPC::VPN"
              }
            ],
             "DnsNameServers": [
               "113.207.55.15"
            ],
             "IpTotalCount": 250,
             "Cidr": "192.168.2.0/24",
             "IpAssignedCount": 1,
             "AllocationPool": {
               "Start": "192.168.2.2",
               "End": "192.168.2.251"
            },
             "GatewayIp": "192.168.2.1",
             "Id": "287e2bfb3d224cc8ae13b27a40c26c90",
             "Name": "sub1922"
          },
          {
             "BindResources": [
              {
                 "ReviceId": "vpn-ke9da72zqnj0",
                 "ResourceType": "UNICLOUD::VPC::VPN"
              },
              {
                 "ReviceId": "vpn-ke8nz6kd8wko",
                 "ResourceType": "UNICLOUD::VPC::VPN"
              },
              {
                 "ReviceId": "vpn-ke9glafadorz",
                 "ResourceType": "UNICLOUD::VPC::VPN"
              },
              {
                 "ReviceId": "ecs-ke893wtb6cif",
                 "ResourceType": "UNICLOUD::ECS::Instance"
              },
              {
                 "ReviceId": "ecs-ke9acfjbbq19",
                 "ResourceType": "UNICLOUD::ECS::Instance"
              }
            ],
             "DnsNameServers": [
               "113.207.55.15"
            ],
             "IpTotalCount": 250,
             "Cidr": "192.168.88.0/24",
             "IpAssignedCount": 5,
             "AllocationPool": {
               "Start": "192.168.88.2",
               "End": "192.168.88.251"
            },
             "GatewayIp": "192.168.88.1",
             "Id": "59b5e4abb7b14d649bc514028b9bdac7",
             "Name": "sub1921"
          }
        ],
         "Cidr": "192.168.0.0/16",
         "InstanceId": "vpc-q6xfuf8nwrhpb",
         "UserId": "66c63797-961c-4783-8808-34464b64df96",
         "InstanceCode": "vpc.standard",
         "RegionId": "cn-beijing"
      },
       "InstanceBandwidthCode": "vpn.bgp.static",
       "SubnetId": "59b5e4abb7b14d649bc514028b9bdac7",
       "InstanceName": "test",
       "ConnectionCount": 10,
       "VpcId": "vpc-q6xfuf8nwrhpb",
       "UserId": "66c63797-961c-4783-8808-34464b64df96",
       "Bandwidth": 10,
       "AzoneId": "cn-beijing-a",
       "RegionId": "cn-beijing",
       "InstanceType": {
         "Describe": "VPN-IPsec类型",
         "SpecificationCode": "vpn.ipsec.normal",
         "RangeAttribute": "count",
         "Start_count": "10",
         "ComponentCode": "VPN",
         "CreateTime": 1593761959928,
         "SpecificationClassCode": "vpn.ipsec",
         "Step": "1",
         "End_count": "500",
         "SpecificationId": "1278956474030096384",
         "UpdateTime": 1593761959928,
         "_id": {
           "TimeSecond": 1593761960,
           "Counter": 5606971,
           "MachineIdentifier": 1512685,
           "Time": 1593761960000,
           "Timestamp": 1593761960,
           "Date": 1593761960000,
           "ProcessIdentifier": 9
        },
         "SpecificationName": "IPsec"
      }
    }
  ],
   "Page": 1
},
 "Code": "Network.Success"
}