VPN網關實例查看
更新時間 2025-04-03 11:15:15
最近更新時間: 2025-04-03 11:15:15
分享文章
VPN網關實例查看。
接口功能介紹
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 | |
| vpnGatewayID | 否 | String | VPN網關ID | 5741643e-a91c-54bc-93b8-a168fd3a6824 | |
| 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 | 請求參數無效 |