更新VPN实例
接口功能介绍
用户手动触发,更新VPN实例加载到云间高速的子网
接口约束
无
URI
POST /v4/ec/vpn-instance/update
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
vpnID | 是 | String | vpn网关ID | vpn-gateway-b3d4 | |
subnets | 是 | Array of Objects | vpn子网信息 | subnetInfos |
表 subnetInfos
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
CIDR | 是 | String | 子网CIDR | 1.2.3.4/24 | |
CIDRType | 是 | String | 子网类型 取值范围: "ssl":ssl类型 "IPsec":IPsec类型 |
ssl |
请求参数
请求头header参数
无
请求body参数
无
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
statusCode | 否 | Integer | 返回状态码 取值范围: 800:成功 900:失败 |
800 | |
errorCode | 否 | String | 业务细分码,为product.module.code三段式码 | ||
message | 否 | String | 失败时的错误描述,一般为英文描述 | ||
description | 否 | String | 失败时的错误描述,一般为中文描述 | ||
traceID | 否 | String | 链路追踪ID | 74cb2e66-1f95-45da-aac5-ee013470fd96 | |
returnObj | 否 | Object | 返回参数 | returnObj |
表 returnObj
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
result | 是 | String | 处理结果 | update success |
请求示例
请求url
无
请求头header
无
请求体body
{
"vpnID": "cb57bc09-8659-12d3-601a-e251f564ea68",
"subnets":[
{
"CIDR":"1.2.3.4/24",
"CIDRType":"ssl"
}
]
}
响应示例
{
"description":"",
"errorCode":"",
"message":"",
"statusCode":800,
"traceID":"2062f2ab-6722-4273-9850-997b4398ddb5",
"returnObj":{
"result": "update success"
}
}
状态码
状态码 | 含义 |
---|---|
200 | 请求成功 |
错误码
errorCode | 含义 |
---|---|
Openapi.PatternCheck.NotValid | 请求参数无效 |
Openapi.NetworksEc.UpdateError | 内部错误,请重试。如果多次尝试失败,请提交工单 |