接口功能介绍
查询智能网关链路信息
接口约束
输入参数名称类长度不超过64位，描述类长度不超过128位
URI
GET /v4/sdwan/edge-link/list
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| edgeID | 是 | String | 智能网关ID | 87a74704-3efd-11ed-910d-005056893e3e |
请求参数
请求header参数
无
请求body参数
无
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 否 | Integer | 返回状态码(800为成功，900为失败) ，默认值:800 | 800 | |
| errorCode | 否 | String | 业务细分码，为product.module.code三段式码 | ||
| message | 否 | String | 失败时的错误描述，一般为英文描述 | ||
| description | 否 | String | 失败时的错误描述，一般为中文描述 | ||
| returnObj | 否 | Object | 返回参数 | returnObj |
表returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| result | 否 | Array of Objects | 查询edge 链路信息 | result | |
| totalCount | 否 | Integer | 总数量 | 1 | |
| currentCount | 否 | Integer | 当前页数量 | 1 |
表result
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| linkPort | 否 | String | 本参数表示端口名称 取值范围: WAN1:WAN1 WAN2:WAN2 LAN:LAN LTE:LTE |
WAN1 | |
| transportNet | 否 | String | 本参数表示传输网络类型 取值范围: internet:internet mpls:mpls lte:lte |
internet | |
| level | 否 | String | 本参数表示主备链路配置 取值范围： master:主 slave:备 |
master | |
| status | 否 | string | 本参数表示端口状态 取值范围： up:开启 down:关闭 |
up | |
| active | 否 | string | 是否活跃 | false | |
| LTEType | 否 | string | 本参数表示LTE类型 取值范围： 4G:4G 5G:5G |
4G |
请求示例
请求url
/v4/sdwan/edge-link/list?edgeID=87a74704-3efd-11ed-910d-005056893e3e
请求头header
无
请求体body
get请求包含body参数,报文头指定application/json,body对象转json字符串。
{
"edgeID": "87a74704-3efd-11ed-910d-005056893e3e"
}
响应示例
{
"statusCode": 800,
"returnObj": {
"result": [
{
"linkPort": "WAN1",
"transportNet": "internet",
"level": "master",
"status": "up",
"active": "false",
"LTEType": "4G"
}
],
"totalCount": 1,
"currentCount": 1
}，
"errorCode": "",
"message": "",
"description": ""
}
状态码
| 状态码 | 含义 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 含义 |
|---|---|
| Openapi.PatternCheck.NotValid | 请求参数无效 |
| EdgeLink.SdwanSdwan.AccessFailed | 内部错误，请重试。如果多次尝试失败，请提交工单 |
