主题
接口描述
平台方节点接入
调用 api 之前需要在节点上运行一个脚本,等待几分钟之后再进行接口调用
请求路径
POST
/v1/platform/migrate
请求参数
名称 | 类型 | 位置 | 必须 | 描述 |
---|---|---|---|---|
Authorization | string | header | 是 | 鉴权 token |
Content-Type | string | header | 是 | 数据类型 application/json |
nodeID | string | body | 否 | 如果节点获取不到oldNodeId时,可以使用该字段(/etc/machine-id) |
oldNodeID | string | body | 否 | 初始化脚本中 machineid 参数的值 |
customerIDs | []MigrateCustomer | body | 是 | 当前部署的业务方 |
nominalInfo | MigrateNominalInfo | body | 是 | 上报数据 |
dialAccounts | []MigrateDialAccount | body | 否 | 拨号信息,当 nominalInfo.dialType 为「staticNetCouple」、「serverDial」时必传,且数组长度需要和nominalInfo的bwNum一致 |
isReinstall | bool | body | 否 | 是否为重装节点,默认:false |
password | string | body | 否 | root 密码,非存量迁移且密码为空,触发自动改密任务 |
createAt | int | body | 是 | 创建时间,时间戳:毫秒 |
MigrateCustomer
名称 | 类型 | 位置 | 必须 | 描述 |
---|---|---|---|---|
customerID | int | body | 是 | 业务方
|
businessID | string | body | 是 | 业务 ID,同 machineid |
MigrateNominalInfo
名称 | 类型 | 位置 | 必须 | 描述 |
---|---|---|---|---|
province | string | body | 是 | 省,格式:浙江 |
city | string | body | 是 | 市,格式:宁波 |
isp | string | body | 是 | 运营商
|
usbw | float | body | 是 | 单条上行带宽,单位:Mbps |
bwNum | int | body | 是 | 线路条数,必须大于 0 |
natType | string | body | 是 | 网络类型
|
dialType | string | body | 是 | 拨号类型
|
managerInterface | string | body | 否 | 管理网卡名,拨号、汇聚节点传参 |
MigrateDialAccount
名称 | 类型 | 位置 | 必须 | 描述 |
---|---|---|---|---|
netDevName | string | body | 是 | 拨号物理网卡名 |
account | string | body | 否 | 拨号账号,服务器拨号必传 |
password | string | body | 否 | 拨号密码,服务器拨号必传 |
bras | string | body | 否 | bras 参数,服务器拨号参数,选传 |
vlanId | int | body | 是 | vlan id |
iP | string | body | 否 | Ip,公网多 IP 必传 |
iPv6 | string | body | 否 | Ipv6,公网多 IP 参数,选传 |
gateway | string | body | 否 | 网关,公网多 IP 必传 |
iPv6Gateway | string | body | 否 | Ipv6 网关,公网多 IP 参数,选传 |
mask | string | body | 否 | 子网掩码,公网多 IP 必传 |
返回值
名称 | 类型 | 描述 |
---|---|---|
nodeID | string | 节点 ID |
stage | string | 节点业务阶段
|
请求示例
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 | 实际线路比提交的要少 |
如接口返回错误码未列举,可在错误码总览中查找