接口功能介绍
VPN网关实例查看
接口约束
支持集群模式资源池。
URI
GET /v4/vpn/vpn-service/list
路径参数
无
Query参数
无
请求参数
请求header参数
无
请求body参数
get请求包含body参数,报文头指定application/json,且body结构对象需要转json。
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | b342b77ef26b11ecb0ac0242ac110002 | |
| vpnServiceID | 否 | String | VPN实例ID | 1241643e-a91c-54bc-93b8-a168fd3a6824 | |
| vpnServiceName | 否 | String | VPN实例名称 | vpc-2989-ssl | |
| queryContent | 否 | String | Query Content模糊查询 | vpc-2989-ssl | |
| projectID | 否 | String | project id | 0 | |
| pageSize | 否 | Integer | 每页行数 | 1 | |
| pageNo | 否 | Integer | 页码 | 1 |
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 否 | Integer | 返回状态码 取值范围: 800：成功 900：失败 |
800 | |
| errorCode | 否 | String | 业务细分码，为product.module.code三段式码 | ||
| message | 否 | String | 失败时的错误描述，一般为英文描述 | ||
| description | 否 | String | 失败时的错误描述，一般为中文描述 | ||
| returnObj | 否 | Object | 返回对象 | returnObj |
表returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| totalCount | 否 | Integer | 查询的总记录数 | 3 | |
| currentCount | 否 | Integer | 当前页记录数 | 2 | |
| totalPage | 否 | Integer | 总页数 | 2 | |
| logMark | 否 | String | 链路追踪ID | 74cb2e66-1f95-45da-aac5-ee013470fd96 | |
| results | 否 | Array of Objects | 列表 | results |
表results
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| vpnServiceID | 否 | String | VPN实例ID | 1241643e-a91c-54bc-93b8-a168fd3a6824 | |
| projectID | 否 | String | project ID | 0 | |
| description | 否 | String | 描述信息 | SSL616 | |
| vpnServiceName | 否 | String | VPN实例名称 | vpc-2989-ssl | |
| vpnServiceType | 否 | String | 网关实例类型，取值范围: cloud_high:云间高速类型 vpc:vpc类型 |
vpc | |
| vpcName | 否 | String | vpc name | vpc-2989 | |
| vpcID | 否 | String | vpc ID | vpc-bw5ks6j7in | |
| bandwidth | 否 | String | 带宽大小，单位为Mbps | 10 | |
| vpnType | 否 | String | vpn类型，取值范围: ipsec：ipsec类型 ssl：ssl类型 |
ssl类型 | |
| vpnConnectLimit | 否 | Integer | vpn连接数限制 | 10 | |
| vnpGatewayIP | 否 | String | vpn网关IP | 100.126.8.211 | |
| status | 否 | String | status | normal | |
| isLimitSpeed | 否 | Boolean | 是否限速 取值范围: false:不限速 true:限速 |
false | |
| localSubnets | 否 | Array of Objects | 子网信息 | [ { "subnetID":"subnet-w4hpvqy65g", "subnetName":"subnet-8b79", "cidr":"10.113.1.0/24" }, { "subnetID":"subnet-fza317dfh0", "subnetName":"subnet-2989", "cidr":"10.113.0.0/24" } ] |
localSubnets |
| resourceID | 否 | String | VPN Resource ID | 35fadbd2973047c6a65c18a03122cc0f | |
| linkResourceID | 否 | String | link resource ID | c43cc06492744523ad82b20cd4fde8b7 | |
| ecID | 否 | String | 接入云间高速ID | fegrg8f3-8b49-4ad0-ae3e-15342a744e73 | |
| vpnGatewayName | 否 | String | vpn网关名称 | vpc-2989 | |
| vpnGatewayID | 否 | String | vpn网关ID | cd3c78f3-8b49-4ad0-ae3e-15342a744e73 | |
| vpnGatewayType | 否 | String | 网关类型，取值范围： normal：为普通类型 secret：为国密类型 |
normal | |
| regionID | 否 | String | Resource Pool ID | b342b77ef26b11ecb0ac0242ac110002 | |
| createTime | 否 | String | create time | 2023-06-19 06:28:55 | |
| expireTime | 否 | String | expire time | 2024-06-19 06:28:55 |
表localSubnets
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| subnetID | 否 | String | subnet ID | subnet-fza317dfh0 | |
| subnetName | 否 | String | subnet name | subnet-8b79 | |
| cidr | 否 | String | cidr | 10.113.0.0/24 |
请求示例
请求url
无
请求头header
无
请求体body
{
"regionID":"b342b77ef26b11ecb0ac0242ac110002",
"pageSize":1,
"pageNo":1
}
响应示例
{
"returnObj":{
"currentCount":1,
"totalCount":4,
"totalPage":4,
"results":[
{
"status":"normal",
"description":"SSL616",
"vpnType":"ssl",
"projectID":"0",
"ecID":"",
"createTime":"2023-06-19 06:28:55",
"vpnConnectLimit":10,
"bandwidth":"10",
"vpcName":"vpc-2989",
"linkResourceID":"c43cc06492744523ad82b20cd4fde8b7",
"isLimitSpeed":false,
"vpnServiceType":"vpc",
"expireTime":"2024-06-19 06:28:55",
"vpcID":"vpc-bw5ks6j7in",
"resourceID":"35fadbd2973047c6a65c18a03122cc0f",
"regionID":"b342b77ef26b11ecb0ac0242ac110002",
"vpnGatewayType":"normal",
"vpnServiceID":"1241643e-a91c-54bc-93b8-a168fd3a6824",
"vnpGatewayIP":"100.126.8.211",
"vpnGatewayID":"cd3c78f3-8b49-4ad0-ae3e-15342a744e73",
"vpnGatewayName":"vpc-2989",
"localSubnets":[
{
"subnetID":"subnet-w4hpvqy65g",
"subnetName":"subnet-8b79",
"cidr":"10.113.1.0/24"
},
{
"subnetID":"subnet-fza317dfh0",
"subnetName":"subnet-2989",
"cidr":"10.113.0.0/24"
}
],
"vpnServiceName":"vpc-2989-ssl"
}
],
"logMark":"739832851418"
},
"errorCode":"",
"message":"success",
"description":"",
"statusCode":800
}
状态码
| 状态码 | 描述 |
|---|---|
| 800 | 表示请求成功 |
| 900 | 表示请求未成功 |
错误码
| errorCode | 描述 |
|---|---|
| Openapi.PatternCheck.NotValid | 请求参数无效 |
