獲取VPN網關詳情
更新時間 2023-12-28 15:00:12
最近更新時間: 2023-12-28 15:00:12
分享文章
獲取VPN網關詳情。
接口功能介紹
獲取VPN網關詳情
接口約束
支持集群模式資源池。
URI
GET /v4/vpn/vpn-gateway/list
路徑參數
無
Query參數
無
請求參數
請求header參數
無
請求body參數
get請求包含body參數,報文頭指定application/json,且body結構對象需要轉json。
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 資源池ID | b342b77ef26b11ecb0ac0242ac110002 | |
| vpnGatewayID | 是 | String | vpn網關ID | 740c0e7c-cd6b-4501-ba41-f86a83f8f837 |
響應參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| statusCode | 否 | Integer | 返回狀態碼 取值范圍: 800:成功 900:失敗 |
800 | |
| errorCode | 否 | String | 業務細分碼,為product.module.code三段式碼 | ||
| message | 否 | String | 失敗時的錯誤描述,一般為英文描述 | ||
| description | 否 | String | 失敗時的錯誤描述,一般為中文描述 | ||
| returnObj | 否 | Object | 返回對象 | returnObj |
表returnObj
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| totalCount | 否 | Integer | 查詢的總記錄數 | 3 | |
| currentCount | 否 | Integer | 當前頁記錄數 | 2 | |
| logMark | 否 | String | 鏈路追蹤ID | 74cb2e66-1f95-45da-aac5-ee013470fd96 | |
| results | 否 | Array of Objects | 列表 | results |
表results
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| vpnGatewayID | 否 | String | vpn網關ID | 740c0e7c-cd6b-4501-ba41-f86a83f8f837 | |
| vpnGatewayName | 否 | String | vpn網關名稱 | 123 | |
| ipsecStatus | 否 | String | ipsec狀態 取值范圍: normal:正常 null:不正常 |
normal | |
| sslStatus | 否 | String | ssl狀態 取值范圍: normal:正常 null:不正常 |
normal | |
| vpnServiceType | 否 | String | 網關實例類型 取值范圍: cloud_high:云間高速類型 vpc:vpc類型 |
vpc | |
| vpnGatewayType | 否 | String | 網關類型 取值范圍: normal:為普通類型 secret:為國密類型 |
normal | |
| ipsecConnectLimit | 否 | Integer | ipsec連接數限制 | 0 | |
| sslConnectLimit | 否 | String | ssl連接數限制 | 10 | |
| bandwidth | 否 | Integer | 帶寬大小,單位為Mbps | 10 | |
| ipsecCreateTime | 否 | String | ipsec create time | 2022-07-16 07:27:26 | |
| sslCreateTime | 否 | String | ssl create time | 2022-07-16 07:27:26 | |
| projectID | 否 | String | project ID | 0 | |
| vpnType | 否 | Array of Strings | vpn類型 取值范圍: ipsec:ipsec類型 ssl:ssl類型 ipsec,ssl:ipsec+ssl類型 |
ipsec | |
| vpcName | 否 | String | vpc名稱 | vpc-9ce5 | |
| vpcID | 否 | String | vpc ID | vpc-6jwowr794e | |
| localSubnets | 否 | Array of Objects | 子網信息 | "localSubnets":[ { "subnetID":"subnet-a0l1wqi058", "subnetName":"subnet-9ce5", "cidr":"10.112.0.0/24" } |
localSubnets |
| ecID | 否 | String | 接入云間高速ID | 740c0e7c-cd6b-4501-ba41-f86a83f8f837 | |
| ipsecConnectedNum | 否 | Integer | ipsec已連接數 | 2 | |
| sslUserNum | 否 | Integer | ssl客戶端數量 | 2 | |
| ipsecExpiredTime | 否 | String | ipsec到期時間 | 2023-07-16 07:27:26 | |
| sslExpiredTime | 否 | String | ssl到期時間 | 2023-07-16 07:27:26 | |
| vnpGatewayIP | 否 | String | vpn網關IP | 100.126.8.211 | |
| ipsecDescription | 否 | String | ipsec描述信息 | ipsec11 | |
| sslDescription | 否 | String | ssl 描述信息 | ssl11 |
表localSubnets
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| subnetID | 否 | String | subnet ID | subnet-a0l1wqi058 | |
| subnetName | 否 | String | subnet name | subnet-9ce5 | |
| cidr | 否 | String | cidr | 10.112.0.0/24 |
請求示例
請求url
無
請求頭header
無
請求體body
{
"regionID": "b342b77ef26b11ecb0ac0242ac110002",
"vpnGatewayID": "cd3c78f3-8b49-4ad0-ae3e-15342a744e73"
}
響應示例
{
"returnObj":{
"currentCount":1,
"totalCount":1,
"results":[
{
"ipsecDescription":"",
"ipsecStatus":null,
"projectID":"0",
"vpnType":[
"ssl"
],
"ipsecConnectedNum":0,
"vpnGatewayName":"123",
"bandwidth":10,
"vpcName":"vpc-9ce5",
"ipsecConnectLimit":0,
"ipsecCreateTime":null,
"sslExpiredTime":"2023-07-16 07:27:26",
"vnpGatewayIP":"100.126.8.182/32",
"vpnServiceType":"vpc",
"sslConnectLimit":"10",
"vpcID":"vpc-6jwowr794e",
"ecID":"",
"vpnGatewayType":"normal",
"sslStatus":"normal",
"vpnGatewayID":"740c0e7c-cd6b-4501-ba41-f86a83f8f837",
"sslDescription":"23",
"sslUserNum":0,
"ipsecExpiredTime":null,
"sslCreateTime":"2023-06-16 07:27:15",
"localSubnets":[
{
"subnetID":"subnet-a0l1wqi058",
"subnetName":"subnet-9ce5",
"cidr":"10.112.0.0/24"
}
]
}
],
"logMark":"118435974014"
},
"errorCode":"",
"message":"success",
"description":"",
"statusCode":800
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 800 | 表示請求成功 |
| 900 | 表示請求未成功 |
錯誤碼
| errorCode | 描述 |
|---|---|
| Openapi.PatternCheck.NotValid | 請求參數無效 |