VPN用戶服務創建
更新時間 2023-12-28 15:00:13
最近更新時間: 2023-12-28 15:00:13
分享文章
VPN用戶服務創建。
接口功能介紹
vpn用戶服務創建
接口約束
支持集群模式資源池。
URI
POST /v4/vpn/ipsec-user-service/create
路徑參數
無
Query參數
無
請求參數
請求header參數
無
請求body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| ipsecServiceName | 是 | String | IPSCE 服務名稱 | 111ipsec | |
| regionID | 是 | String | 資源池ID | b342b77ef26b11ecb0ac0242ac110002 | |
| ipAddress | 是 | String | IPAddress | 111.0.0.1 | |
| vpnGatewayID | 否 | String | vpn網關ID | 35d5fa99-c040-4bb0-806a-8be317cc4d89 |
響應參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| statusCode | 否 | Integer | 返回狀態碼 取值范圍: 800:成功 900:失敗 |
800 | |
| errorCode | 否 | String | 業務細分碼,為product.module.code三段式碼 | ||
| message | 否 | String | 失敗時的錯誤描述,一般為英文描述 | ||
| description | 否 | String | 失敗時的錯誤描述,一般為中文描述 | ||
| returnObj | 否 | Object | 返回對象 | returnObj |
表returnObj
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| logMark | 否 | String | 鏈路追蹤ID | 74cb2e66-1f95-45da-aac5-ee013470fd96 |
請求示例
請求url
無
請求頭header
無
請求體body
{
"ipsecServiceName":"111",
"regionID":"b342b77ef26b11ecb0ac0242ac110002",
"ipAddress":"111.0.0.1"
}
響應示例
{
"returnObj":{
"logMark":"231890973174"
},
"errorCode":"",
"message":"success",
"description":"",
"statusCode":800
}
狀態碼
| 狀態碼 | 含義 |
|---|---|
| 800 | 請求成功 |
| 900 | 請求未成功 |
錯誤碼
| errorCode | 含義 |
|---|---|
| Openapi.PatternCheck.NotValid | 請求參數無效 |
| vpn.RegionInfo.Empty | 該資源池信息為空,可能資源池ID不正確 |