接口功能介绍
查询sdwan，云间高速console调用，查询当前租户所有的sdwan列表
接口约束
无
URI
GET /v4/ec/sdwan/list
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| sdwanID | 否 | String | sdwan ID | 212e45d0-d2ce-11ed-b8e1-005056892474 | |
| pageNo | 否 | Integer | 查询的当前页，用于分页查询 | 1 | |
| pageSize | 否 | Integer | 分页查询页数 | 10 |
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 否 | Integer | 返回状态码 取值范围: 800:成功 900:失败 |
800 | |
| errorCode | 否 | String | 业务细分码，为product.module.code三段式码 | ||
| message | 否 | String | 失败时的错误描述，一般为英文描述 | ||
| description | 否 | String | 失败时的错误描述，一般为中文描述 | ||
| traceID | 否 | String | 链路追踪ID | 74cb2e66-1f95-45da-aac5-ee013470fd96 | |
| returnObj | 否 | Object | 返回参数 | returnObj |
表returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| currentCount | 否 | Integer | 当前页记录数 | 3 | |
| totalPage | 否 | Integer | 查询的当前页，用于分页查询 | 1 | |
| totalCount | 否 | Integer | 查询的总记录数 | 3 | |
| results | 否 | Array of Objects | 返回查询结果，Json数组 | results |
表results
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| sdwanID | 否 | String | sdwan ID | 212e45d0-d2ce-11ed-b8e1-005056892474 | |
| sdwanName | 否 | String | sdwan名称 | sdwan-111 | |
| ecID | 否 | String | sdwan已经加入的云间高速ID | 212e45d0-d2ce-11ed-b8e1-005056892474 |
请求示例
请求url
/v4/ec/sdwan/list?sdwanID=6949e4e6-8f92-4b05-8cae-b3977914f15b
请求头header
无
请求体body
无
响应示例
{
"description": "",
"errorCode": "",
"message": "",
"statusCode": 800,
"traceID": "2062f2ab-6722-4273-9850-997b4398ddb5",
"returnObj": {
"totalCount": 1,
"totalPage": 1,
"currentCount": 1,
"results": [{
"sdwanID": "212e45d0-d2ce-11ed-b8e1-005056892474",
"sdwanName": "test111",
"ecID": "44f33b3f-b802-4eed-912e-8aa76141ec54"
}]
}
}
状态码
| 状态码 | 含义 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 含义 |
|---|---|
| Openapi.PatternCheck.NotValid | 请求参数无效 |
| Openapi.SdwanListEc.AccessFailed | 内部错误，请重试。如果多次尝试失败，请提交工单 |
