查询VPN列表
更新时间：2024-12-30
描述
查询VPN列表信息。
请求结构
GET /v{version}/vpn?marker={marker}&maxKeys={maxKeys}&vpcId={vpcId}&eip={eip}&type={type} HTTP/1.1
Host: bcc.bj.baidubce.com
Authorization: authorization string 请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号，当前取值为1 |
| marker | String | 否 | Query参数 | 批量获取列表的查询的起始位置，是一个由系统生成的字符串 |
| maxKeys | Integer | 否 | Query参数 | 每页包含的最大数量，最大数量通常不超过1000，缺省值为1000 |
| vpcId | String | 是 | Query参数 | VPN所属VPC的标识符 |
| eip | String | 否 | Query参数 | VPN绑定的eip地址 |
| type | String | 否 | Query参数 | VPN网关类型，值“IPSec”返回IPsec-VPN网关，值“SSL |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| marker | String | 标记查询的起始位置 |
| isTruncated | Boolean | true表示后面还有数据，false表示已经是最后一页 |
| nextMarker | String | 获取下一页所需要传递的marker值；当isTruncated为false时，该域不出现 |
| maxKeys | Integer | 每页包含的最大数量 |
| vpns | List<Vpn> | VPN列表 |
请求示例
GET /v{version}/vpn?marker=vpn-IyWRtII7&maxKeys=1 HTTP/1.1
Host: bcc.bj.baidubce.com
ContentType: application/json
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2017-03-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de 返回示例
HTTP/1.1 200 OK
x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
Date: Thu, 16 Mar 2017 06:29:48 GMT
Content-Type: application/json;charset=UTF-8
Server: BWS
{
"nextMarker": "vpn-xktdeMSf",
"marker": "vpn-IyWRtII7",
"maxKeys": 1,
"isTruncated": true,
"vpns": [
{
"status": "active",
"eip": "10.12.34.32",
"vpnId": "vpn-IyWRtII7",
"vpcId": "83edd0d2-8a68-4ce5-a396-9d2917d58a57",
"description": "",
"expiredTime": "2022-04-25 17:22:34",
"paymentTiming": "Postpaid",
"vpnConnNum": 0,
"bandwidthInMbps": 10,
"type": "IPSec",
"vpnConns": [],
"vpnName": "VPN_aoko_2",
"createTime": "2021-04-25 17:22:34"
}
]
}