NiuLink 帮助中心

主题

接口描述 ​

节点信息查询

请求路径 ​

GET /v1/ant/:nodeID/info

请求参数 ​

名称类型位置必须描述
Authorizationstringheader是鉴权 token
Content-Typestringheader是数据类型 application/json
nodeIDstringpath是节点 ID

返回值 ​

名称类型位置必须描述
provincestringbody是省，格式：浙江
citystringbody是市，格式：宁波
ispstringbody是运营商
  • 电信
  • 联通
  • 移动
usbwfloatbody是单条上行带宽，单位：Mbps
bwNumintbody是线路条数，必须大于 0
natTypestringbody是网络类型
  • public：公网
  • full：Nat1
  • restric：Nat2
  • restricPort：Nat3
  • symmetric：Nat4
dialTypestringbody是拨号类型
  • staticNetSingle：固定公网单 IP
  • staticNetCouple：固定公网多 IP
  • serverDial：服务器拨号
  • dhcpNetSingle：DHCP单 IP
  • dhcpNetCouple：DHCP多 IP
  • virtualRoute：软路由
isMultiLineboolbody是是否为多线路拨号，true表示是，false表示否
isTransProvboolbody否是否允许跨省 true ：允许 false ：不允许
transProvRatefloatbody否跨省比例 例: 跨省比例为80% transProvRate 值为80
remarkstringbody否备注
combinedDataCombinedDatabody否上报聚合数据
profileAlerts[]stringbody否质量数据诊断结果
qualityProfileQualityProfilebody否质量数据详情

QualityProfile ​

名称类型描述
onlineInfoOnlineQuality在线质量数据
natNatQualitynat质量数据
neworkConfigNetworkConfig网络配置质量数据
netPressureNetPressure压测质量数据
eveningNetQualityEveningNetQuality晚高峰质量数据
ipv6StatusIpv6Statusipv6状态数据
transProvStatusTransProvStatus跨省质量数据
cpuCpuQualitycpu质量数据
memMemQuality内存质量数据
diskDiskQuality磁盘质量数据

DataLevelMsg ​

名称类型描述
datastring数据
levelstring提示信等级(alert/notice)
msgstring提示信息

AlertMessage ​

名称类型描述
levelstring提示信息等级 level(alert/notice)
messagestring提示信息
helpstring帮助信息

NatQuality ​

名称类型描述
tcpNatDataLevelMsgtcp nat 质量数据
udpNatDataLevelMsgudp nat 质量数据
alertMessages[]AlertMessagealert/notice 提示信息

NetworkConfig ​

名称类型描述
configDialWideInfo网络配置信息
alertMessages[]AlertMessagealert/notice 提示信息

DialWideInfo ​

名称类型描述
totalint总共线路数
dialSucceedint拨号成功线路数
connectSucceedintipv4已联网数
IPv6ConnectSucceedintipv6已联网数
ipv6Enableboolipv6是否开启

NetPressure ​

名称类型描述
dataDataLevelMsg网络压力数据
alertMessages[]AlertMessagealert/notice 提示信息

EveningNetQuality ​

名称类型描述
pingLossDataLevelMsg晚高丢包质量数据峰数据
reTransDataLevelMsg晚高重传质量数据
rttDataLevelMsg晚高rtt质量数据
alertMessages[]AlertMessagealert/notice 提示信息

Ipv6Status ​

名称类型描述
statusDataLevelMsgipv6状态数据
alertMessages[]AlertMessagealert/notice 提示信息

TransProvStatus ​

名称类型描述
statusDataLevelMsg跨省质量数据
alertMessages[]AlertMessagealert/notice 提示信息

CpuQuality ​

名称类型描述
coreSizeint核数
cpuUtilflkoat64cpu使用率(单位:%)
alertMessages[]AlertMessagealert/notice 提示信息

MemQuality ​

名称类型描述
memSizeint64内存大小(单位:KB)
memUtilflkoat64内存使用率(单位:%)
alertMessages[]AlertMessagealert/notice 提示信息

DiskQuality ​

名称类型描述
data[]DiskData磁盘质量数据
alertMessages[]AlertMessagealert/notice 提示信息

DiskData ​

名称类型描述
namestring盘符
rotastring媒体类型
serialstring序列号
sizestring容量(500G)
usedstring已使用(格式同size)
summaryDataLevelMsg磁盘质量数据

CombinedData ​

名称类型描述
upnpErrDetailstringupnp报错详情
upnpAddResultstringupnp开启状态，success 表示开启成功；failure 表示开启失败
upnpExternalIpstringupnp外网ip

返回值示例 ​

json
正常请求：
  http code 200 OK
{
  "nodeID": "hjsfkjhsfh5637587",
  "province": "江苏",
  "city": "南京",
  "isp": "电信",
  "usbw": 100,
  "bwNum": 10,
  "natType": "public",
  "dialType": "serverDial",
  "isMultiLine": true,
  "isTransProv": true,
  "transProvRate": 80,
  "remark": "remark",
  "combinedData": {
    "upnpErrDetail": "no upnp server",
    "upnpAddResult": "failure"
  },
  "profileAlerts": [
    "晚高峰丢包率高"
  ],
  "qualityProfile": {
    "onlineInfo": {
      "todayOnlineDuration": {
        "data": "14.83h",
        "level": "",
        "msg": ""
      },
      "todayEveningOnlineDuration": {
        "data": "",
        "level": "",
        "msg": ""
      },
      "yesterdayOnlineDuration": {
        "data": "24.00h",
        "level": "",
        "msg": ""
      },
      "yesterdayEveningOnlineDuration": {
        "data": "6.00h",
        "level": "",
        "msg": ""
      },
      "alertMessages": null
    },
    "nat": {
      "tcpNat": {
        "data": "对称型锥型NAT(Nat4)",
        "level": "alert",
        "msg": "很差"
      },
      "udpNat": {
        "data": "完全锥型NAT(Nat1)",
        "level": "",
        "msg": ""
      },
      "alertMessages": null
    },
    "neworkConfig": {
      "config": {
        "total": 1,
        "dialSucceed": 0,
        "connectSucceed": 1,
        "ipv6ConnectSucceed": 0,
        "ipv6Enable": true
      },
      "alertMessages": null
    },
    "netPressure": {
      "data": {
        "data": "78.8%",
        "level": "notice",
        "msg": "带宽不足"
      },
      "alertMessages": [
        {
          "level": "notice",
          "message": "您的带宽丢包压测满意度低，带宽压测无法达到预期，请改善网络，降低其他设备对带宽的占用",
          "help": ""
        }
      ]
    },
    "eveningNetQuality": {
      "pingLoss": {
        "data": "25.8%",
        "level": "alert",
        "msg": "异常"
      },
      "reTrans": {
        "data": "3.2%",
        "level": "",
        "msg": ""
      },
      "rtt": {
        "data": "39.6ms",
        "level": "",
        "msg": ""
      },
      "alertMessages": [
        {
          "level": "alert",
          "message": "您的设备丢包率过高",
          "help": "https://help.niulinkcloud.com/issue/tcpretrans.html"
        }
      ]
    },
    "ipv6Status": {
      "status": {
        "data": "未联通",
        "level": "notice",
        "msg": ""
      },
      "alertMessages": [
        {
          "level": "notice",
          "message": "开启IPv6并保持联通，可提升收益",
          "help": "https://help.niulinkcloud.com/os/ipv6.html"
        }
      ]
    },
    "transProvStatus": {
      "status": {
        "data": "",
        "level": "",
        "msg": ""
      },
      "alertMessages": null
    },
    "cpu": {
      "coreSize": 4,
      "cpuUtil": 17,
      "alertMessages": null
    },
    "mem": {
      "memSize": 12147076,
      "memUtil": 24.95,
      "alertMessages": null
    },
    "disk": {
      "disks": [
        {
          "name": "sda",
          "rota": "SSD",
          "size": "477G",
          "used": "355.52G",
          "summary": {
            "data": "0.61ms/3.38ms",
            "level": "",
            "msg": ""
          }
        }
      ],
      "alertMessages": null
    }
  }
}
异常请求:
  http code 4xx/5xx

{
  "code": 4000001,
  "desc": ""
}

错误码列表 ​

错误码描述
401鉴权失败
4000001参数有误, 描述中会包含详细信息
4000002节点未查找到
4000005节点状态异常
4000009流程动作非法

如接口返回错误码未列举，可在错误码总览中查找