接口功能介绍
vpn网关实例修改
接口约束
支持集群模式资源池。
URI
POST /v4/vpn/vpn-service/update
路径参数
无
Query参数
无
请求参数
请求header参数
无
请求body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| vpnServiceID | 是 | String | VPN实例ID | 552a30a9-b818-509b-b353-784f6cb2109 | |
| regionID | 是 | String | 资源池ID | b342b77ef26b11ecb0ac0242ac110002 | |
| vpnServiceName | 是 | String | VPN实例名称 | 111 | |
| description | 否 | String | description | 1112 |
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| 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
{
"regionID":"b342b77ef26b11ecb0ac0242ac110002",
"vpnServiceName":"1111",
"vpnServiceID":"552a30a9-b818-509b-b353-784f6cb21092",
"description":"11112"
}
响应示例
{
"returnObj":{
"logMark":"274668534286"
},
"errorCode":"",
"message":"success",
"description":"",
"statusCode":800
}
状态码
| 状态码 | 描述 |
|---|---|
| 800 | 表示请求成功 |
| 900 | 表示请求未成功 |
错误码
| errorCode | 描述 |
|---|---|
| Openapi.PatternCheck.NotValid | 请求参数无效 |
