接口功能介绍
查询智能网关专线配置
接口约束
输入参数名称类长度不超过64位，描述类长度不超过128位
URI
GET /v4/sdwan/edge-special-line/list
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| edgeID | 是 | String | 智能网关ID | 2893f150-19b5-11eb-8e79-824da1059800 |
请求参数
请求头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
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| userWay | 否 | String | 设备分类 | 主用设备 | |
| serialNumber | 否 | String | 盒子SN | CTCC21168210800yzh8 | |
| lineType | 否 | String | 本参数表示专线类型 取值范围： dhcp:DHCP static:静态 |
static | |
| lineStatus | 否 | String | 本参数表示链路状态 取值范围： processing:使用中 completed:已完成 |
processing | |
| IPAddress | 否 | String | ip地址,带子网格式，最后一个网段不能为0 | 192.168.0.1/24 |
请求示例
请求url
/v4/sdwan/edge-special-line/list?edgeID=2893f150-19b5-11eb-8e79-824da1059800
请求头header
无
请求体body
无
响应示例
{
"statusCode": 800,
"returnObj": {
"result": [
{
"userWay": "主用设备",
"serialNumber": "CTCC21168210800yzh8",
"lineType": "static",
"lineStatus": "completed",
"IPAddress": "192.168.0.1/24"
}
],
"totalCount": 1,
"currentCount": 1
}
}
状态码
| 状态码 | 含义 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 含义 |
|---|---|
| Openapi.PatternCheck.NotValid | 请求参数无效 |
| EdgeInfo.SdwanSdwan.AccessFailed | 内部错误，请重试。如果多次尝试失败，请提交工单 |
