Skip to content

接口描述

平台方节点接入

调用 api 之前需要在节点上运行一个脚本,等待几分钟之后再进行接口调用

请求路径

POST /v1/platform/migrate

请求参数

名称类型位置必须描述
Authorizationstringheader鉴权 token
Content-Typestringheader数据类型 application/json
nodeIDstringbody如果节点获取不到oldNodeId时,可以使用该字段(/etc/machine-id)
oldNodeIDstringbody初始化脚本中 machineid 参数的值
customerIDs[]MigrateCustomerbody当前部署的业务方
nominalInfoMigrateNominalInfobody上报数据
dialAccounts[]MigrateDialAccountbody拨号信息,当 nominalInfo.dialType 为「staticNetCouple」、「serverDial」时必传,且数组长度需要和nominalInfo的bwNum一致
isReinstallboolbody是否为重装节点,默认:false
passwordstringbodyroot 密码,非存量迁移且密码为空,触发自动改密任务
createAtintbody创建时间,时间戳:毫秒

MigrateCustomer

名称类型位置必须描述
customerIDintbody业务方
  • 16501:短视频A
  • 16502:长视频B
  • 16503:长视频A
  • 16504:长视频T
  • 16505:短视频S
  • 16506:短视频Q
  • 16507:长视频Z
  • 16508:短视频Z
  • 16509:短视频D
  • 16510:长视频C
  • 16511:短视频T
  • 16512:短视频E
  • 16513:短视频B
  • 16514:短视频C
  • 16515:长视频D
  • 16516:短视频X
  • 16517:长视频W
  • 16521:短视频Y
  • 16522:长视频B1
  • 16612:短视频H2
  • 16613:长视频Q1
  • 16614:短视频Z1
  • 16615:长视频B2
  • 16616:短视频A1
  • 16633:业务H
  • 16625:长视频Y3
businessIDstringbody业务 ID,同 machineid

MigrateNominalInfo

名称类型位置必须描述
provincestringbody省,格式:浙江
citystringbody市,格式:宁波
ispstringbody运营商
  • 电信
  • 联通
  • 移动
usbwfloatbody单条上行带宽,单位:Mbps
bwNumintbody线路条数,必须大于 0
natTypestringbody网络类型
  • public:公网
  • full:Nat1
dialTypestringbody拨号类型
  • staticNetSingle:固定公网单 IP
  • staticNetCouple:固定公网多 IP
  • serverDial:服务器拨号
  • virtualRoute:软路由
managerInterfacestringbody管理网卡名,拨号、汇聚节点传参

MigrateDialAccount

名称类型位置必须描述
netDevNamestringbody拨号物理网卡名
accountstringbody拨号账号,服务器拨号必传
passwordstringbody拨号密码,服务器拨号必传
brasstringbodybras 参数,服务器拨号参数,选传
vlanIdintbodyvlan id
iPstringbodyIp,公网多 IP 必传
iPv6stringbodyIpv6,公网多 IP 参数,选传
gatewaystringbody网关,公网多 IP 必传
iPv6GatewaystringbodyIpv6 网关,公网多 IP 参数,选传
maskstringbody子网掩码,公网多 IP 必传

返回值

名称类型描述
nodeIDstring节点 ID
stagestring节点业务阶段
  • bound:待提交
  • waitAudit:交付中
  • auditFailed:验收未通过
  • inService:服务中
  • offline:已下线
  • repelled:已清退

请求示例

json
{
  "nodeID": "",
  "oldNodeID": "dhjksljalls",
  "isReinstall": false,
  "password": "rootpwd",
  "customerIDs": [
    {
      "customerID": 16504,
      "businessID": "dhjksljalls"
    }
  ],
  "nominalInfo": {
    "province": "江苏",
    "city": "南京",
    "isp": "电信",
    "usbw": 100,
    "bwNum": 1,
    "natType": "public",
    "dialType": "serverDial",
    "managerInterface": "eth0"
  },
  "createAt": 1654069027546
}

返回值示例

json
正常请求:
  http code 200 OK
异常请求:
  http code 4xx/5xx

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

错误码列表

错误码描述
401鉴权失败
4000001参数有误, 描述中会包含详细信息
4000002节点未查找到
4000005节点状态异常
4000009流程动作非法
4006017提交线路比实际的要少
4006018实际线路比提交的要少

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