接口功能介绍
过载保护配置
接口约束
输入参数名称类长度不超过64位，描述类长度不超过128位
URI
POST /v4/sdwan/overload/config
路径参数
无
Query参数
无
请求参数
请求header参数
无
请求body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| edgeID | 是 | String | edge id | 3a5644b2-e9c4-11eb-b46f-005056898fe0 | |
| protects | 是 | Array Of Objects | 过载保护配置 | protects |
表protects
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| port | 是 | String | 本参数表示端口类型 取值范围： WAN1:WAN1 WAN2:WAN2 LAN:LAN LTE:LTE |
WAN1 | |
| transportNet | 是 | String | 本参数表示传输网络类型 取值范围: internet:internet mpls:mpls lte:lte cda:cda |
Internet | |
| linkDetection | 否 | String | 目标检测IP | 12.3.4.5,2.3.42.3 | |
| inRate | 是 | Integer | 入方向带宽（单位：Mbps） | 10 | |
| outRate | 是 | Integer | 出方向带宽（单位：Mbps） | 10 | |
| inProtect | 是 | Integer | 入方向保护阈值,范围0-100 | 90 | |
| outProtect | 是 | Integer | 出方向保护阈值,范围0-100 | 90 |
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 否 | Integer | 返回状态码(800为成功，900为失败) ，默认值:800 | 800 | |
| errorCode | 否 | String | 业务细分码，为product.module.code三段式码 | ||
| message | 否 | String | 失败时的错误描述，一般为英文描述 | ||
| description | 否 | String | 失败时的错误描述，一般为中文描述 | ||
| returnObj | 否 | Array of Objects | 返回参数 | returnObj |
表returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| operationID | 否 | String | 操作id | da7ecb46-d9eb-11e9-b0d1-54e1ad2f80f3 |
请求示例
请求头header
无
请求体body
{
"edgeID": "3a5644b2-e9c4-11eb-b46f-005056898fe0",
"protects": [
{
"port": "WAN1",
"transportNet": "internet",
"linkDetection": "12.3.4.5,2.3.42.3",
"inRate": 10,
"outRate": 10,
"inProtect": 90,
"outProtect": 90
}
]
}
响应示例
{
"statusCode": 800,
"returnObj": [
{
"operationID": "da7ecb46-d9eb-11e9-b0d1-54e1ad2f80f3"
}
]，
"errorCode": "",
"message": "",
"description": ""
}
状态码
| 状态码 | 含义 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 含义 |
|---|---|
| Openapi.PatternCheck.NotValid | 请求参数无效 |
