接口功能介绍
查询拓扑Node信息
接口约束
输入参数名称类长度不超过64位，描述类长度不超过128位
URI
GET /v4/sdwan/gplot/list
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| sdwanID | 是 | String | sdwan的id | be012e8f-ea32-4a2c-89da-7db35eedb334 |
请求参数
请求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 | 拓扑节点信息 | result | |
| totalCount | 否 | Integer | 总数量 | 1 | |
| currentCount | 否 | Integer | 当前页数量 | 1 |
表result
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| edgeID | 是 | String | edge的ID | 9aa1a302-388d-11ed-a977-005056898fe0 | |
| edgeName | 是 | String | edge名称 | 中关村设备2arm | |
| status | 是 | String | 本参数表示edge状态： 取值范围： online：在线 offline：下线 |
online | |
| useType | 是 | String | 本参数表示edge接入类型： 取值范围： singleNode：单机 activeStandby：双机 |
singleNode | |
| position | 是 | Object | 位置 | position | |
| serialNumberDict | 是 | Object | sn信息 | serialNumberDict |
表position
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| x | 是 | String | edge的x坐标 | 180.00 | |
| y | 是 | String | edge的y坐标 | 170.99 |
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| master | 是 | String | edge的主SN | G65GBCS210540460 | |
| slave | 是 | String | edge的备SN | G65GBCS210540478 |
请求示例
请求url
/v4/sdwan/gplot/list?sdwanID=be012e8f-ea32-4a2c-89da-7db35eedb334
请求头header
无
请求体body
无
响应示例
{
"statusCode": 800,
"returnObj": {
"result": [
{
"edgeID": "48faf728-175b-11ec-8d77-00505689ac50",
"edgeName": "中关村设备2arm",
"status": "offline",
"useType": "singleNode",
"position": {
"x": "360.00",
"y": "180.00"
},
"serialNumberDict": {
"master": "G65GBCS210540460",
"slave": null
}
}
],
"totalCount": 1,
"currentCount": 1
},
"errorCode": "",
"message": "",
"description": ""
}
状态码
| 状态码 | 含义 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 含义 |
|---|---|
| Openapi.PatternCheck.NotValid | 请求参数无效 |
