接口功能介绍
查询edge lan口信息
接口约束
输入参数名称类长度不超过64位，描述类长度不超过128位
URI
GET /v4/sdwan/edge-lan-nic-info/list
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| edgeID | 是 | String | 智能网关ID | 2893f150-19b5-11eb-8e79-824da1059800 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 否 | Integer | 返回状态码('800为成功，900为失败)，默认值:800 | 800 | |
| errorCode | 否 | String | 业务细分码，为product.module.code三段式码 | ||
| message | 否 | String | 失败时的错误描述，一般为英文描述 | ||
| description | 否 | String | 失败时的错误描述，一般为中文描述 | ||
| returnObj | 否 | Object | 返回参数 | returnObj |
表returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| result | 是 | Object | 端口信息 | result | |
| totalCount | 否 | Integer | 总数量 | 1 | |
| currentCount | 否 | Integer | 当前页数量 | 1 |
表result
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| nicList | 否 | Array of Objects | 端口名称 | nicList | |
| slaveNicList | 否 | Array of Objects | 备用端口名称 | slaveNiclist |
表nicList
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| portName | 否 | String | 端口名称 | GigabitEthernet5/0/0 | |
| portType | 否 | String | 本参数表示端口类型 取值范围： WAN1:WAN1 WAN2:WAN2 LAN:LAN LTE:LTE |
LAN | |
| portStatus | 否 | String | 本参数表示端口状态 取值范围： up:开启 down:关闭 |
down |
表slaveNicList
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| portName | 否 | string | 端口名称 | GigabitEthernet5/0/0 | |
| portType | 否 | string | 本参数表示端口类型 取值范围： WAN1:WAN1 WAN2:WAN2 LAN:LAN LTE:LTE |
LAN | |
| portStatus | 否 | string | 本参数表示端口状态 取值范围： up:开启 down:关闭 |
down |
请求示例
请求url
/v4/sdwan/detect-ip/list?edgeID=82c40584-fe8f-49b0-9e09-ef915caeee10
请求头header
无
请求体body
无
响应示例
{
"statusCode": 800,
"returnObj": {
"result": {
"nicList": [
{
"portName": "GigabitEthernet5/0/0",
"portType": "LAN",
"portStatus": "down"
}
],
"slaveNicList": [
{
"portName": "GigabitEthernet5/0/0",
"portType": "LAN",
"portStatus": "down"
}
]
},
"totalCount": 2,
"currentCount": 2
},
"errorCode": "",
"message": "",
"description": ""
}
状态码
| 状态码 | 含义 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 含义 |
|---|---|
| Openapi.PatternCheck.NotValid | 请求参数无效 |
| EdgeInfo.SdwanSdwan.AccessFailed | 内部错误，请重试。如果多次尝试失败，请提交工单 |
