接口功能介绍
查询智能网关基本信息
接口约束
输入参数名称类长度不超过64位，描述类长度不超过128位
pageNo和pageSize从1开始，不能小于1
URI
GET /v4/sdwan/edge-info/list
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| edgeID | 否 | String | 智能网关ID | 87a74704-3efd-11ed-910d-005056893e3e | |
| pageNo | 否 | Integer | 页数 | 1 | |
| pageSize | 否 | Integer | 页大小 | 1 | |
| search | 否 | String | 模糊查询，可以查resouceId | edge |
请求参数
请求头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
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| edgeID | 否 | String | 智能网关ID | 87a74704-3efd-11ed-910d-005056893e3e | |
| edgeName | 否 | String | 设备名称 | edge-guizhou6-001 | |
| status | 否 | String | 本参数表示设备状态 取值范围： online：已上线 offline：已下线 |
online | |
| edgeCIDR | 否 | Array of Strings | edge的子网 | ["21.2.3.0/24"] | |
| useType | 否 | String | 本参数表示使用方式 取值范围： singleNode：单机 activeStandby: 双机 |
singleNode | |
| deployMode | 否 | String | 本参数表示接入方式 取值范围： inline-mode:串接 dual-arm-mode:双臂旁挂 single-arm-mode:单臂旁挂 |
dual-arm-mode | |
| bizStatus | 否 | String | 本参数表示业务状态 取值范围： lock:已锁定 processing:操作中 ordered:已下单 active:已激活 |
active | |
| totalSize | 否 | String | 总带宽 | 5 | |
| expireTime | 否 | String | 到期时间 | 2024-03-23 09:28:22 | |
| description | 否 | String | edge描述 | edge-guizhou6-001 | |
| serialNumberDict | 否 | Object | serialNumberDict | ||
| serviceList | 否 | Array of Objects | 增值服务信息 | serviceList | |
| cloudService | 否 | Object | 所属云服务 | cloudService |
表serialNumberDict
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| masterSN | 否 | String | 主edge的sn | TESTOPENAPI2 | |
| slaveSN | 否 | String | 备edge的sn | TESTOPENAPI3 |
表serviceList
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| serviceName | 否 | String | 本参数表示增值服务名称 取值范围： 5G WIFI LTE extOnceOutlay extOncService extOutlayService |
5G | |
| createTime | 否 | String | 创建时间 | 2023-03-23 09:28:22 |
表cloudService
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| sdwanID | 否 | String | sdwan id | 6061886c-c940-11ed-a71d-525400af7402 | |
| sdwanName | 否 | String | sdwan名称 | sdwan-001 |
请求示例
请求url
/v4/sdwan/edge-info/list?pageNo=1
请求头header
无
请求体body
无
响应示例
{
"statusCode": 800,
"returnObj": {
"result": [
{
"edgeID": "87a74704-3efd-11ed-910d-005056893e3e",
"edgeName": "edge-guizhou6-001",
"status": "online",
"edgeCIDR": ["21.2.3.0/24"],
"useType": "singleNode",
"deployMode": "inline-mode",
"serialNumberDict": {
"masterSN": "TESTOPENAPI3",
"slaveSN": "TESTOPENAPI5"
},
"bizStatus": "active",
"serviceList": [
{
"serviceName": "5G",
"createTime": "2023-03-23T09:28:22Z"
}
],
"cloudService": {
"sdwanID": "6061886c-c940-11ed-a71d-525400af7402",
"sdwanName": "sdwan-001"
},
"totalSize": "0",
"expireTime": "2024-03-23T09:28:22Z",
"description": "edge-guizhou6-001"
}
],
"totalCount": 1,
"currentCount": 1
}，
"errorCode": "",
"message": "",
"description": ""
}
状态码
| 状态码 | 含义 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 含义 |
|---|---|
| Openapi.PatternCheck.NotValid | 请求参数无效 |
| EdgeInfo.SdwanSdwan.AccessFailed | 内部错误，请重试。如果多次尝试失败，请提交工单 |
