接口描述

节点列表查询

请求路径

GET /v1/ant/info/list

请求参数

名称 类型 位置 必须 描述
Authorization string header 是 鉴权 token
query string form 否 模糊搜索内容，当前填具体的节点ID，有多个节点ID用“,”分隔
queryType string form 否 模糊搜索类型，当前只能填 nodeId
vendorIds string form 否 供应商ID，多个ID则用“,”分割，如果是查自己名下的节点可不传
status string form 否 节点网络状态
  • online：在线
  • outline：离线
stage string form 否 节点业务阶段
  • bound：待审核
  • waitAudit：交付中
  • auditFailed：验收未通过
  • inService：服务中
  • offline：已下线
  • repelled：已清退
page int form 否 第几页， 从 1 开始，默认为1
size int form 否 每页数量，默认为100

返回值

名称 类型 描述
items []PublicNodeBriefInfo 节点数据列表

PublicNodeBriefInfo

名称 类型 描述
nodeID string 节点ID
vendorID int 供应商ID
stage string 节点业务阶段
  • bound：待审核
  • waitAudit：交付中
  • auditFailed：验收未通过
  • inService：服务中
  • offline：已下线
  • repelled：已清退
nominalInfo NominalInfo 供应商上报基础信息
nodeInfo NodeInfo 节点动态收集信息

NominalInfo

名称 类型 描述
province string 省，格式：浙江
city string 市，格式：宁波
isp string 运营商
  • 电信
  • 联通
  • 移动
usbw float 单条上行带宽，单位：Mbps
bwNum int 线路条数，必须大于 0
natType string 网络类型
  • public：公网
  • full：Nat1
  • restric：Nat2
  • restricPort：Nat3
  • symmetric：Nat4
dialType string 拨号类型
  • staticNetSingle：固定公网单 IP
  • staticNetCouple：固定公网多 IP
  • serverDial：服务器拨号
  • dhcpNetSingle：DHCP单 IP
  • dhcpNetCouple：DHCP多 IP
  • virtualRoute：软路由
isTransProv bool 是否允许跨省 true ：允许，false ：不允许
transProvRate float 跨省比例 例: 跨省比例为80% transProvRate 值为80

NodeInfo

名称 类型 描述
arch string CPU架构
sn string 节点SN
status string 节点网络状态
  • online：在线
  • outline：离线
host string 主机名

请求示例

http://niulinkcloud-example/v1/ant/info/list?query=hjsfkjhsfh5637587&queryType=nodeId&status=online&stage=bound

返回值示例

正常请求：
  http code 200 OK
{
    "items": [
        {
            "nodeID": "ant153175188d886a81f42f671641b93",
            "vendorID": 1,
            "stage": "submitted",
            "nodeInfo": {
                "arch": "amd64",
                "sn": "2P7R4X1",
                "status": "online",
                "host": "Sparrow64.site"
            },
            "nominalInfo": {
                "province": "上海",
                "city": "上海",
                "isp": "电信",
                "natType": "symmetric",
                "dialType": "dhcpNetSingle",
                "bwNum": 1,
                "isTransProv": true,
                "transProvRate": 100
            }
        }
    ],
    "count": 1
}

异常请求:
  http code 4xx/5xx

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

错误码列表

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

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

results matching ""

    No results matching ""