查询VPN信息列表
接口功能介绍
查询当前租户未加入云间高速的VPN实例信息列表,后续用于加入云间高速
接口约束
仅能查询到未加入云间高速的vpn信息,已加入云间高速的请通过[查询VPN实例]接口获取
URI
GET /v4/ec/vpn/list
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
dcID | 是 | String | 资源池ID | 55450584-fe8f-49b0-9e09-ef915caeee10 | |
vpnID | 否 | String | vpn ID | 74cb2e66-1f95-45da-aac5-ee013470fd96 |
请求参数
请求头header参数
无
请求body参数
无
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
statusCode | 否 | Integer | 返回状态码 取值范围: 800:成功 900:失败 |
800 | |
errorCode | 否 | String | 业务细分码,为product.module.code三段式码 | ||
message | 否 | String | 失败时的错误描述,一般为英文描述 | ||
description | 否 | String | 失败时的错误描述,一般为中文描述 | ||
traceID | 否 | String | 链路追踪ID | 74cb2e66-1f95-45da-aac5-ee013470fd96 | |
returnObj | 否 | Object | 返回参数 | returnObj |
表returnObj
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
currentCount | 否 | Integer | 当前页记录数 | 3 | |
totalPage | 否 | Integer | 总页数 | 1 | |
totalCount | 否 | Integer | 查询的总记录数 | 3 | |
results | 否 | Array of Objects | 返回查询结果,Json数组 | results |
表results
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
vpnID | 否 | String | vpn实例ID | vpn-gateway-b3d4 | |
vpnName | 否 | String | vpn名称 | vpn-001 |
请求示例
请求url
v4/ec/vpn/list?dcID=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": [{
"vpnID": "vpnCTYUN456",
"vpnName":"vpn-22j4"
}]
}
}
状态码
状态码 | 含义 |
---|---|
200 | 请求成功 |
错误码
errorCode | 含义 |
---|---|
Openapi.PatternCheck.NotValid | 请求参数无效 |
Openapi.NetworksEc.AccessFailed | 内部错误,请重试。如果多次尝试失败,请提交工单 |