主题
接口描述
获取节点汇聚状态
请求路径
GET
/v1/nodes/<nodeID>/dialconverge/status
请求参数
名称 | 类型 | 位置 | 必须 | 描述 |
---|---|---|---|---|
Authorization | string | header | 是 | 鉴权 token |
nodeID | string | path | 是 | 节点 ID |
返回值
名称 | 类型 | 描述 |
---|---|---|
convergeStatus | string | 节点拨号状态
|
total | int | 汇聚线路总数 |
connectSucceed | int | 已联网数 |
detail | []ConvergeDetail | 详情 |
ConvergeDetail
名称 | 类型 | 描述 |
---|---|---|
netDevName | string | 网卡名 |
ip | string | ip 地址 |
mac | string | mac 地址 |
speed | string | 速率 |
type | string | 网卡类型
|
total | int | 汇聚线路总数 |
connectSucceed | int | 已联网数 |
convergeStatusInfo | []StatusInfo | 单条线路汇聚状态信息 |
StatusInfo
名称 | 类型 | 描述 |
---|---|---|
netDevName | string | 网卡名 |
vlanId | int | vlanId |
mac | string | mac 地址 |
ip | string | ip 地址 |
gateway | string | 网关 |
ipv6 | string | ipv6 地址 |
ipv6Gateway | string | ipv6网关 |
mask | string | 子网掩码 |
connectStatus | string | 连接状态
|
ipv6ConnectStatus | string | IPV6连接状态
|
convergeError | string | 汇聚失败详情 (只有在 DialStatus 为 failed 时才会出现) |
detectedNatType | string | 探测的nat类型 |
detectedProvince | string | 探测的省份 |
detectedCity | string | 探测的城市 |
detectedIsp | string | 探测的运营商 |
请求示例
json
返回值示例
json
正常请求:
http code 200
{
"convergeStatus": "idle",
"total": 10,
"connectSucceed": 5,
"detail": [
{
"netDevName": "eth0",
"ip": "172.0.0.1",
"mac": "ff:dd:cc:bb:aa",
"speed": "1Gbit/s",
"type": "traffic",
"total": 10,
"connectSucceed": 5,
"convergeStatusInfo": [
{
"netDevName": "eth0",
"vlanId": 110,
"mac": "ff:dd:cc:bb:aa",
"ip": "172.0.0.2",
"gateway": "172.0.0.1",
"ipv6":"fe80::d6ae:52ff:fe6c:b36e",
"ipv6Gateway":"fe80::d6ae:52ff:fe6c:b36e",
"mask": "255.255.255.0",
"connectStatus": "success",
"ipv6ConnectStatus": "success",
"convergeError": "xxxx"
}
]
}
]
}
异常请求:
http code 4xx/5xx
{
"code": 4000001,
"desc": ""
}
错误码列表
错误码 | 描述 |
---|---|
401 | 鉴权失败 |
4000002 | 节点未查找到 |
4000100 | 未查到网卡信息 |
如接口返回错误码未列举,可在错误码总览中查找