主题
接口描述
获取节点拨号状态
请求路径
GET
/v1/ant/<nodeID>/dial/status
请求参数
名称 | 类型 | 位置 | 必须 | 描述 |
---|---|---|---|---|
Authorization | string | header | 是 | 鉴权 token |
nodeID | string | path | 是 | 节点 ID |
返回值
名称 | 类型 | 描述 |
---|---|---|
dialStatus | string | 节点拨号状态
|
detail | []DailDetail | 详情 |
multiDial | bool | 单账号多拨开启状态,true表示存在多拨,false表示不存在 |
DailDetail
名称 | 类型 | 描述 |
---|---|---|
netDevName | string | 网卡名 |
ip | string | ip 地址 |
speed | string | 速率 |
type | string | 网卡类型
|
dialStatusInfo | []StatusInfo | 单条线路拨号状态信息 |
StatusInfo
名称 | 类型 | 描述 |
---|---|---|
account | string | 拨号账户 |
password | string | 密码 |
vlanId | int | vlanId |
adslNum | int | adsl 序列号 |
ip | string | ip 地址 |
dialStatus | string | 拨号状态
|
connectStatus | string | 连接状态
|
ipv6 | string | ipv6 地址 |
ipv6ConnectStatus | string | ipv6 连接状态
|
bras | string | bras拨号参数 |
mac | string | 拨号线路的mac地址 |
dialLog | string | 拨号日志 |
dialLogAnalysis | DialLogAnalysis | 拨号日志分析 |
DialLogAnalysis
名称 | 类型 | 描述 |
---|---|---|
lastDialAt | int64 | 最近一次拨号时间戳, 单位: ms |
latestConclusion | string | 最新拨号失败的结论 |
latestSuggestion | string | 最新拨号失败的处理建议 |
logs | []PPPDLog | 最新的日志信息,失败时可能为空,因为日志收集偶发失败 |
PPPDLog
名称 | 类型 | 描述 |
---|---|---|
start | int64 | pppd开始时间 |
end | int64 | pppd结束时间 |
originalLog | string | 原始拨号失败日志 |
请求示例
json
返回值示例
json
正常请求:
http code 200
{
"dialStatus": "idle",
"multiDial": false,
"detail": [
{
"netDevName": "eth0",
"ip": "172.0.0.1",
"speed": "1Gbit/s",
"type": "traffic",
"dialStatusInfo": [
{
"account": "05120001110",
"ip": "120.110.111.112",
"ipv6": "fe80::d6ae:52ff:fe6c:b36e",
"ipv6ConnectStatus": "succeed",
"password": "12345",
"adslNum": 10,
"vlanId": 201,
"dialStatus": "failed",
"connectStatus": "failed",
"dialError": "xxxx"
}
]
}
]
}
异常请求:
http code 4xx/5xx
{
"code": 4000001,
"desc": ""
}
错误码列表
错误码 | 描述 |
---|---|
401 | 鉴权失败 |
4000002 | 节点未查找到 |
4000100 | 未查到网卡信息 |
如接口返回错误码未列举,可在错误码总览中查找