接口功能介绍
查询绑定Sdwan智能网关信息
接口约束
输入参数名称类长度不超过64位，描述类长度不超过128位
pageNo和pageSize从1开始，不能小于1
URI
GET /v4/sdwan/edge-bind-sdwan/list
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| sdwanID | 是 | String | sdwan的ID | 14eba528-bd80-11ed-a12a-005056893e3e | |
| status | 否 | String | 本参数表示设备状态 取值范围: online:上线 offline:下线 |
online | |
| pageNo | 否 | Integer | 页码 | 1 | |
| pageSize | 否 | Integer | 每页计算数目 | 10 | |
| search | 否 | String | 模糊查询 | sdwan | |
| projectID | 否 | String | 企业项目ID | 0 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 否 | Integer | 返回状态码('800为成功，900为失败)，默认值:800 | 800 | |
| errorCode | 否 | String | 业务细分码，为product.module.code三段式码 | ||
| message | 否 | String | 失败时的错误描述，一般为英文描述 | ||
| description | 否 | String | 失败时的错误描述，一般为中文描述 | ||
| returnObj | 否 | Object | 返回参数 | returnObj |
表returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| totalCount | 否 | Integer | 总数 | 1 | |
| currentCount | 否 | Integer | 当前页数量 | 1 | |
| result | 否 | Array of Objects | 结果列表 | result |
表result
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| edgeName | 否 | String | 盒子名称 | edge-001 | |
| edgeID | 否 | String | 盒子ID | ac012e8f-ea32-4a2c-89da-7db35eedb334 | |
| status | 否 | String | 本参数表示设备状态 取值范围: online:上线 offline:下线 |
online | |
| isAuth | 否 | String | 本参数表示设备状态 取值范围: false: 同账号 true: 跨账号 |
false | |
| customerID | 否 | String | 所属账号ID | be012e8f-ea32-4a2c-89da-7db35eedb334 | |
| customerEmail | 否 | String | 所属账号邮箱 | openapiuser@chinatelecom.cn | |
| size | 否 | Integer | 基础带宽大小,单位mbps | 1 | |
| totalSize | 否 | Integer | 总带宽,单位mbps | 10 | |
| deviceModel | 否 | String | 本参数表示设备型号 取值范围： economic:经济型 standard:标准版 enterprise:企业版 enhance:企业增强版 vcpe:虚拟智能网关 |
economic | |
| currentVersion | 否 | String | 软件版本号 | v1.4.4 |
请求示例
请求url
/v4/sdwan/edge-bind-sdwan/list?sdwanID=be012e8f-ea32-4a2c-89da-7db35eedb334
请求头header
无
请求体body
无
响应示例
{
"statusCode": 800,
"returnObj": {
"result": [
{
"edgeID": "99c0aba2-d529-11ed-b0f8-525400af7402",
"edgeName": "edge-openapi-001",
"status": "online",
"isAuth": false,
"customerEmail": "openapiuser@chinatelecom.cn",
"customerID": "19bf37bb87cc4c86aa2542b06b4fa032",
"size": 1,
"totalSize": 1,
"deviceModel": "economic",
"currentVersion": "v1.4.4"
}
],
"totalCount": 1,
"currentCount": 1
}
}
状态码
| 状态码 | 含义 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 含义 |
|---|---|
| Openapi.PatternCheck.NotValid | 请求参数无效 |
