接口功能介绍
查询Sdwan列表
接口约束
输入参数名称类长度不超过64位，描述类长度不超过128位
pageNo和pageSize从1开始，不能小于1
URI
GET /v4/sdwan/list
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| sdwanID | 否 | String | SD-WAN ID | 47ea26d0-3ff3-11ed-bca7-005056893e3e | |
| projectID | 否 | String | 企业项目ID | 0 | |
| pageNo | 否 | Integer | 页码 | 1 | |
| pageSize | 否 | Integer | 每页记录数目 | 10 |
请求参数
请求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
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| sdwanID | 否 | String | SD-WAN ID | 47ea26d0-3ff3-11ed-bca7-005056893e3e | |
| sdwanName | 否 | String | 名称 | sdwan-001 | |
| projectID | 否 | String | 企业项目ID | 0 | |
| description | 否 | String | 描述 | sdwan列表 | |
| ecName | 否 | String | 云间高速name | ec-001 | |
| ecID | 否 | String | 云间高速 id | e2c4b06e-3ff1-11ed-bca7-005056893e3e | |
| customerID | 否 | String | 客户id | bac_9eb5d50887d1442d9feae0b598c3297e | |
| edgeNum | 否 | Integer | 设备数量 | 1 | |
| onlineEdgeNum | 否 | Integer | 在线设备数量 | 1 | |
| projectID | 否 | String | 企业项目ID | 0 | |
| createTime | 否 | String | 创建时间 | 2022-09-29 12:30:56 |
请求示例
请求url
/v4/sdwan/list?sdwanID=47ea26d0-3ff3-11ed-bca7-005056893e3e
请求头header
无
请求体body
无
响应示例
{
"statusCode": 800,
"returnObj": {
"totalCount": 1,
"currentCount": 1,
"result": [
{
"sdwanID": "47ea26d0-3ff3-11ed-bca7-005056893e3e",
"sdwanName": "sdwan-001",
"description": "sdwan列表",
"ecName": "ec-001",
"ecID": "e2c4b06e-3ff1-11ed-bca7-005056893e3",
"customerID": "bac_9eb5d50887d1442d9feae0b598c3297e",
"edgeNum": 1,
"onlineEdgeNum": 1,
"projectID": "0",
"createTime": "2022-09-29 12:30:56"
}
]
}，
"errorCode": "",
"message": "",
"description": ""
}
状态码
| 状态码 | 含义 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 含义 |
|---|---|
| Openapi.PatternCheck.NotValid | 请求参数无效 |
