创建VPN实例
接口功能介绍
创建VPN实例
接口约束
当前仅支持加载到默认路由表
URI
POST /v4/ec/vpn-instance/create
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| ecID | 是 | String | 云间高速ID | 55450584-fe8f-49b0-9e09-ef915caeee10 | |
| cgwID | 是 | String | 云网关ID | bc9a70eb-28d7-4032-9510-1bea00192f34 | |
| vpnID | 是 | String | vpn实例ID | vpn-gateway-b3d4 | |
| dcID | 是 | String | vpn所在的资源池ID | 81f7728662dd11ec810800155d307d5b | |
| rtbID | 是 | String | 路由表ID | bc9a70eb-28d7-4032-9510-1bea00192f34 | |
| weights | 否 | Integer | 权重，vpn默认70 | 70 | |
| vpnName | 是 | String | 云间高速侧显示的vpn名称（建议保持和vpn创建时的名称一致） | vpn-gateway | |
| routeLearn | 否 | Integer | 路由学习开关，开启后云网关自动学习网络实例路由 取值范围: 1:学习 0:不学习 默认学习 |
1 | |
| routeSync | 否 | Integer | 路由同步开关，开启后云网关路由自动同步到网络实例 取值范围: 1:同步 0:不同步 默认同步 |
1 |
请求参数
请求头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 | 处理结果 | create success |
请求示例
请求url
无
请求头header
无
请求体body
{
"ecID":"6949e4e6-8f92-4b05-8cae-b3977914f15b",
"rtbID": "1c2034a8-b1a8-4e97-9c0e-fa729e960fc7",
"cgwID": "ec505901-a16c-41fd-8ad0-33498ca4a235",
"vpnID":"cb57bc09-8659-12d3-601a-e251f564ea68",
"dcID":"81f7728662dd11ec810800155d307d5b",
"weights":70,
"vpnName":"vpn-gateway-900",
"routeSync":1,
"routeLearn":1
}
响应示例
{
"description":"",
"errorCode":"",
"message":"",
"statusCode":800,
"traceID":"2062f2ab-6722-4273-9850-997b4398ddb5",
"returnObj":{
"result": "create success"
}
}
状态码
| 状态码 | 含义 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 含义 |
|---|---|
| Openapi.PatternCheck.NotValid | 请求参数无效 |
| Openapi.NetworksEc.CreateError | 内部错误，请重试。如果多次尝试失败，请提交工单 |
