创建路由
接口功能介绍
创建路由,针对已经加载到云间高速的网络实例,创建一条下一跳为该网络实例的路由。
接口约束
无
URI
POST /v4/ec/route/create
路径参数
无
Query参数
无
请求参数
请求header参数
无
请求body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
ecID | 是 | String | 云间高速实例ID | 82c40584-fe8f-49b0-9e09-ef915caeee10 | |
cgwID | 是 | String | 云网关ID | 55450584-fe8f-49b0-9e09-ef915caeee10 | |
rtbID | 是 | String | 路由表ID | 11280584-fe8f-49b0-9e09-ef915caeee10 | |
routeType | 是 | String | 路由类型 取值范围: "1":自动学习 "2":自定义(默认) |
2 | |
routeCIDR | 是 | String | 子网信息 | 12.3.4.0/24 | |
nexthopType | 否 | String | 下一跳实例的类型,如不是黑洞路由则必填 取值范围: "1":vpc "2":云专线 "3":SDWAN "4":VPN "5":EDS "20":黑洞路由 "30":跨域连接 |
1 | |
nexthopID | 否 | String | 目的实例ID/跨域连接ID,如不是黑洞路由则必填 | 55450584-fe8f-49b0-9e09-ef915caeee10 | |
routeDescription | 否 | String | 路由描述信息 | 路由001 | |
IPVersion | 是 | String | 子网类型 取值范围: "1":IPv4类型 "2":IPv6类型 |
1 | |
isBlackholeRoute | 否 | Bool | 是否是黑洞路由, 如果选择true,则nexthopType、nexthopID字段可不传; 取值范围: false: 否 true:是 默认false(否) |
1 |
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
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
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
routeID | 否 | String | 路由ID | 55450584-fe8f-49b0-9e09-ef915caeee10 |
请求示例
请求头header
请求体body
{
"ecID": "82c40584-fe8f-49b0-9e09-ef915caeee10",
"cgwID": "55450584-fe8f-49b0-9e09-ef915caeee10",
"rtbID": "11280584-fe8f-49b0-9e09-ef915caeee10",
"routeType": "2",
"routeCIDR": "12.3.4.0/24",
"nexthopType": "1",
"nexthopID": "55450584-fe8f-49b0-9e09-ef915caeee10",
"routeDescription": "路由001",
"IPVersion": "1",
"isBlackholeRoute": false
}
响应示例
{
"description":"",
"errorCode":"",
"message":"",
"statusCode":800,
"traceID":"bc9a70eb-28d7-4032-9510-1bea00192f34",
"returnObj":
{
"routeID": "55450584-fe8f-49b0-9e09-ef915caeee10"
}
}
状态码
状态码 | 含义 |
---|---|
200 | 请求成功 |
错误码
errorCode | 含义 |
---|---|
Openapi.PatternCheck.NotValid | 请求参数无效 |
Openapi.RouteEc.CreateError | 内部错误,请重试。如果多次尝试失败,请提交工单 |