接口功能介绍
EDGE链路配置
接口约束
输入参数名称类长度不超过64位,描述类长度不超过128位
URI
POST /v4/sdwan/edge/link-config
Query参数
无
请求参数
请求header参数
无
请求body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
edgeID | 是 | String | edge id | 3a5644b2-e9c4-11eb-b46f-005056898fe0 | |
links | 是 | Array of Objects | 链路配置 必填 [{'port': 'WAN1','transport_net': 'internet', 'level': 'master'}] | links |
表links
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
port | 是 | String | 本参数表示端口名称 取值范围: WAN1:WAN1 WAN2:WAN2 LAN:LAN LTE:LTE |
WAN1 | |
transportNet | 是 | String | 本参数表示传输网络类型 取值范围: internet:internet mpls:mpls lte:lte cda:cda |
internet | |
level | 是 | String | 本参数表示主备链路配置 取值范围: master:主 slave-1:备用1 slave-2:备用2 |
master |
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
statusCode | 否 | Integer | 返回状态码(800为成功,900为失败) ,默认值:800 | 800 | |
errorCode | 否 | String | 业务细分码,为product.module.code三段式码 | ||
message | 否 | String | 失败时的错误描述,一般为英文描述 | ||
description | 否 | String | 失败时的错误描述,一般为中文描述 | ||
returnObj | 否 | Array of Strings | 返回参数 |
请求示例
请求头header
无
请求体body
{
"edgeID": "3a5644b2-e9c4-11eb-b46f-005056898fe0",
"links": [
{
"port": "WAN1",
"transportNet": "internet",
"level": "master"
}
]
}
响应示例
{
"statusCode": 800,
"returnObj": [],
"errorCode": "",
"message": "",
"description": ""
}
状态码
状态码 | 含义 |
---|---|
200 | 请求成功 |
错误码
errorCode | 含义 |
---|---|
Openapi.PatternCheck.NotValid | 请求参数无效 |