查询VPN实例

接口功能介绍

查询VPN实例

接口约束

无

URI

GET /v4/ec/vpn-instance/list

路径参数
无

Query参数

请求参数

请求头header参数
无

请求body参数
无

响应参数

表returnObj

表results

| redundantType | 否 | Integer| 冗余类型
取值包括
1：主备
2：负载
0：无 | 1| |
| redundantInstUUID | 否 | String | 冗余负载实例的UUID | 11200584-fe8f-49b0-9e09-ef915caeee10| |
| redundantInstName| 否 | String | 冗余负载实例的名称 |red-instance | |
| redundantInstType | 否 | String | 冗余负载实例的类型
取值包括
2: 云专线
3: sdwan
4: vpn | 11200584-fe8f-49b0-9e09-ef915caeee10| |
| redundantInstID| 否 | String | 冗余负载侧ID，即当前为cdaID, sdwanID，vpnID |red-instance | |
| isAuth | 否 | Integer | 实例类型是否是授权账号
取值范围:
1:授权
0:非授权 |0 | |
| routeLearn | 否 | Integer | 路由学习开关，开启后云网关自动学习网络实例路由
取值范围:
1:学习
0:不学习
默认学习 | 1 | |
| routeSync | 否 | Integer | 路由同步开关，开启后云网关路由自动同步到网络实例
取值范围:
1:同步
0:不同步
默认同步 | 1 | |

表 subnetInfos

请求示例

请求url
v4/ec/vpn-instance/list?ecID=6949e4e6-8f92-4b05-8cae-b3977914f15b

请求头header
无

请求体body
无

响应示例

{
	"description": "",
	"errorCode": "",
	"message": "",
	"statusCode": 800,
	"traceID": "2062f2ab-6722-4273-9850-997b4398ddb5",
	"returnObj": {
		"totalCount": 1,
		"totalPage": 1,
		"currentCount": 1,
		"results": [{
			"ecID": "169b89b8-0d5f-4908-85b1-880f1fe50601",
			"cgwID": "bb6669fd-06c1-4022-9cb4-615a90d65798",
			"cgwName": "nm8",
			"dcID": "437d7519-5bde-4fc8-86ea-d403e82f7544",
			"dcName": "内蒙8",
            "vpnID": "vpnCTYUN456",
            "vpnName":"vpn-22j4",
			"instanceID": "3eebfdb0-9c05-4574-bfb1-c530dad9b896",
			"rtbID": "437d7519-5bde-4fc8-86ea-d403e82f7544",
			"rtbName": "default-route-table-nm8",
			"subnets": [{
                "CIDR": "1.2.3.4/24",
				"CIDRType": "ssl"
			}],
            "status": "running",
            "createDate": "2023-07-27 12:00:11",
            "weights": 70,
			"redundantType" : 0,
			"redundantInstUUID":"",
			"redundantInstName":"",
			"redundantInstType":"",
			"redundantInstID":"",
			"isAuth":0,
			"routeLearn":1,
			"routeSync":1
		}]
	}
}

状态码

错误码