用戶網關查詢
更新時間 2023-12-28 15:00:11
最近更新時間: 2023-12-28 15:00:11
分享文章
查詢已創建的VPN用戶網關。
接口功能介紹
查詢已創建的VPN用戶網關
接口約束
支持主備模式資源池。
URI
GET /v4/vpn/user-gateway/list
路徑參數
無
Query 參數
無
請求參數
請求頭 header 參數
無
請求體 body 參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 資源池ID | ||
| pageNo | 否 | String | 頁碼 | 1 | |
| pageSize | 否 | String | 頁大小 | 10 | |
| userGatewayID | 否 | String | 用戶網關ID | ||
| userGatewayName | 否 | String | 用戶網關名稱 | ||
| queryContent | 否 | String | 模糊查詢 |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 返回狀態碼(800為成功，900為失敗) | ||
| message | String | 失敗時的錯誤描述，一般為英文描述 | ||
| description | String | 失敗時的錯誤描述，一般為中文描述 | ||
| returnObj | Object | 返回對象 | returnObj | |
| errorCode | String | 業務細分碼，為product.module.code三段式碼 | ||
| errorDetail | String | 錯誤明細 |
表returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| currentCount | Integer | 當前返回的用戶網關數量 | ||
| totalCount | Integer | 總共的用戶網關數量 | ||
| totalPage | Integer | 總共頁數 | ||
| results | Array of Object | 用戶網關列表 | UserGateway | |
| errorCode | String | 錯誤碼 | ||
| message | String | 錯誤信息 | ||
| description | String | 描述 | ||
| statusCode | String | 800成功，900失敗 |
表UserGateway
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| vpnConnectionID | String | VPN連接ID | ||
| userGatewayName | String | 用戶網關名字 | ||
| userGatewayID | String | 用戶網關ID | ||
| resourceId | String | 用戶網關資源ID | ||
| azName | String | 可能區名字 | ||
| dataID | String | 數據ID | ||
| isMaz | Boolean | 是否多可用區 | ||
| isPaas | Boolean | 是否為Paas | ||
| azID | String | 可用區ID | ||
| regionId | String | 資源池ID | ||
| availabilityZone | String | 可用區 | ||
| isTalkOrder | Boolean | 是否按需單 | ||
| azDisplayName | String | 可用區展示名字 | ||
| paymentType | String | 本參數表示付款類型。 取值范圍： MONTH YEAR onDemand |
||
| projectIDEcs | String | Project ID | ||
| customerId | String | 客戶ID | ||
| createdTime | String | 創建時間 | ||
| expiredTime | String | 過期時間 | ||
| updatedTime | String | 更新時間 | ||
| deletedTime | String | 刪除時間 | ||
| ipAddress | String | IP地址 |
請求示例
請求頭
無
請求體 body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"userGatewayID": "ff809aec-8f4b-4d46-8f18-b8fef3fb8325",
"userGatewayName": "user-gateway-4ca9-mlkjk",
"pageNo": "1",
"pageSize": "1"
}
響應示例
{
"returnObj": {
"currentCount": 1,
"totalCount": 9,
"totalPage": 9,
"results": [{
"vpnConnectionID": "aaa9ae52-3fcc-11ed-ba27-005056897257",
"dataID": null,
"availabilityZone": null,
"azID": null,
"resourceId": null,
"regionId": "73f321ea-62ff-11ec-a8bc-005056898fe0",
"paymentType": null,
"azName": null,
"tenantId": null,
"userGatewayID": "500fd9e3-dddf-479a-97bd-4a9b245f3204",
"isMaz": false,
"updatedTime": "2022-09-29T07:58:40Z",
"userGatewayName": "user-gateway-tong2",
"isTalkOrder": false,
"isPaas": false,
"deletedTime": null,
"customerId": "e19a4b13-ce65-53ff-97f1-8fc09f6f28e7",
"expiredTime": null,
"createdTime": "2022-09-29T07:56:22Z",
"projectIDEcs": "0",
"ipAddress": "100.124.2.18",
"azDisplayName": ""
}]
},
"errorCode": "",
"message": "",
"description": "",
"statusCode": 800
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 800 | 表示請求成功 |
| 900 | 表示請求未成功 |
錯誤碼
| errorCode | 描述 |
|---|---|
| OPENAPI.PatternCheck.NotValid | 請求參數無效 |
| OPENAPI.VPN.AccessFailed | 內部錯誤，請重試。如果多次嘗試失敗，請提交工單 |
