接口功能介绍
删除已创建的用户网关
接口约束
支持主备模式资源池。
URI
POST /v4/vpn/user-gateway/delete
路径参数
无
Query 参数
无
请求参数
请求头 header 参数
无
请求体 body 参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | ||
| userGatewayID | 是 | String | 用户网关 ID |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| 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": "ff809aec-8f4b-4d46-8f18-b8fef3fb8325"
}
响应示例
{
"returnObj": {
"results": []
},
"errorCode": "",
"message": "",
"description": "",
"statusCode": 800
}
状态码
| 状态码 | 描述 |
|---|---|
| 800 | 表示请求成功 |
| 900 | 表示请求未成功 |
错误码
| errorCode | 描述 |
|---|---|
| OPENAPI.PatternCheck.NotValid | 请求参数无效 |
| OPENAPI.VPN.DeleteError | 内部错误，请重试。如果多次尝试失败，请提交工单 |
