接口功能介绍
查询edge互联信息列表(已经互联的edge)
接口约束
输入参数名称类长度不超过64位，描述类长度不超过128位
pageNo和pageSize从1开始，不能小于1
URI
GET /v4/sdwan/edge-branch/list
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| sdwanID | 是 | String | sdwan id | 3a5644b2-e9c4-11eb-b46f-005056898fe0 | |
| edgeBranchID | 否 | String | 盒子互联信息ID | 4b5644b2-e9c4-11eb-b46f-005056898fe0 | |
| pageNo | 否 | Integer | 页码 | 1 | |
| pageSize | 否 | Integer | 当前页记录数目 | 10 | |
| search | 否 | String | 模糊查询 | edge |
请求参数
请求header参数
无
请求body参数
无
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 否 | Integer | 返回状态码(800为成功，900为失败) ，默认值:800 | 800 | |
| errorCode | 否 | String | 业务细分码，为product.module.code三段式码 | ||
| message | 否 | String | 失败时的错误描述，一般为英文描述 | ||
| description | 否 | String | 失败时的错误描述，一般为中文描述 | ||
| returnObj | 否 | Object | 返回参数 | returnObj |
表returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| totalCount | 否 | String | 总数 | 1 | |
| currentCount | 否 | String | 页码 | 1 | |
| result | 否 | Array of Objects | 返回列表 | result |
表result
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| edgeBranchID | 否 | String | 互联信息id | 655fbe9d-129f-11eb-9f1e-d4d2524fda7f | |
| fuserLastUpdated | 否 | String | 用户最近更新时间 | 2020-10-20 06:42:17 | |
| edgBrancheName | 否 | String | edge互联名称 | shanghai-edge-001 | |
| customerID | 否 | String | 客户id | bac_9eb5d50887d1442d9feae0b598c3297e | |
| dstDcName | 否 | String | 目的region名称 | guizhou6 | |
| dstDcID | 否 | String | 目的region id | 705fbe9d-129f-11eb-9f1e-d4d2524fda7f | |
| dstZone | 否 | String | 目的区域 | mainland | |
| dstEdgeID | 否 | String | 目的 edge id | 815fbe9d-129f-11eb-9f1e-d4d2524fda7f | |
| srcDcName | 否 | String | 源 region名称 | sdwan_1 | |
| srcDcID | 否 | String | 源 region id | 925fbe9d-129f-11eb-9f1e-d4d2524fda7f | |
| srcZone | 否 | String | 源区域 | shanghai_mainland | |
| srcEdgeID | 否 | String | 源 edge id | 455fbe9d-129f-11eb-9f1e-d4d2524fda7f | |
| sdwanID | 否 | String | sdwan id | 3a5644b2-e9c4-11eb-b46f-005056898fe0 |
请求示例
请求url
/v4/sdwan/edge-branch/list?sdwanID=3a5644b2-e9c4-11eb-b46f-005056898fe0
请求头header
无
请求体body
无
响应示例
{
"statusCode": 800,
"returnObj": {
"message": "",
"totalCount": 1,
"currentCount": 1,
"code": "200",
"result": [
{
"edgeBranchID": "655fbe9d-129f-11eb-9f1e-d4d2524fda7f",
"fuserLastUpdated": "2020-10-20 06:42:17",
"edgeBranchName": "edge-branch-001",
"customerID": "bac_9eb5d50887d1442d9feae0b598c3297e",
"dstDcName": "guizhou",
"dstDcID": "705fbe9d-129f-11eb-9f1e-d4d2524fda7f",
"dstZone": "mainland",
"dstEdgeID": "815fbe9d-129f-11eb-9f1e-d4d2524fda7f",
"srcDcName": "shanghai",
"srcDcID": "925fbe9d-129f-11eb-9f1e-d4d2524fda7f",
"srcZone": "east_mainland",
"srcEdgeID": "455fbe9d-129f-11eb-9f1e-d4d2524fda7f",
"sdwanID": "3a5644b2-e9c4-11eb-b46f-005056898fe0"
}
]
},
"errorCode": "",
"message": "",
"description": ""
}
状态码
| 状态码 | 含义 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 含义 |
|---|---|
| Openapi.PatternCheck.NotValid | 请求参数无效 |
