用戶網關修改
更新時間 2023-12-28 15:00:11
最近更新時間: 2023-12-28 15:00:11
分享文章
修改已創建的VPN用戶網關(目前只能修改網關名字)。
接口功能介紹
修改已創建的VPN用戶網關(目前只能修改網關名字)。
接口約束
支持主備模式資源池，并且目前只支持修改名字
URI
POST /v4/vpn/user-gateway/update
路徑參數
無
Query 參數
無
請求參數
請求頭 header 參數
無
請求體 body 參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 資源池ID | ||
| userGatewayID | 是 | String | 用戶網關 ID | ||
| userGatewayName | 是 | String | 用戶網關名字 |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 返回狀態碼(800為成功，900為失敗) | ||
| message | String | 失敗時的錯誤描述，一般為英文描述 | ||
| description | String | 失敗時的錯誤描述，一般為中文描述 | ||
| returnObj | Object | 返回對象 | returnObj | |
| errorCode | String | 業務細分碼，為product.module.code三段式碼 | ||
| errorDetail | Object | 錯誤明細 |
表returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| results | Array of String | 成功為空，失敗為失敗信息 |
請求示例
請求頭
無
請求體 body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"userGatewayID": "500fd9e3-dddf-479a-97bd-4a9b245f3204",
"userGatewayName": "user-gateway-tong2-update"
}
響應示例
{
"returnObj": {
"results": []
},
"errorCode": "",
"message": "",
"description": "",
"statusCode": 800
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 800 | 表示請求成功 |
| 900 | 表示請求未成功 |
錯誤碼
| errorCode | 描述 |
|---|---|
| OPENAPI.PatternCheck.NotValid | 請求參數無效 |
| OPENAPI.VPN.CreateError | 內部錯誤，請重試。如果多次嘗試失敗，請提交工單 |
