主题
接口描述
节点信息查询
请求路径
GET/v1/nodes/:nodeID/info
请求参数
| 名称 | 类型 | 位置 | 必须 | 描述 |
|---|---|---|---|---|
| Authorization | string | header | 是 | 鉴权 token |
| Content-Type | string | header | 是 | 数据类型 application/json |
| nodeID | string | path | 是 | 节点 ID |
返回值
| 名称 | 类型 | 位置 | 必须 | 描述 |
|---|---|---|---|---|
| province | string | body | 是 | 省,格式:浙江 |
| city | string | body | 是 | 市,格式:宁波 |
| isp | string | body | 是 | 运营商
|
| usbw | float | body | 是 | 单条上行带宽,单位:Mbps |
| bwNum | int | body | 是 | 线路条数,必须大于 0 |
| natType | string | body | 是 | 网络类型
|
| dialType | string | body | 是 | 拨号类型
|
| isTransProv | bool | body | 否 | 是否允许跨省 true :允许 false :不允许 |
| transProvRate | float | body | 否 | 跨省比例 例: 跨省比例为80% transProvRate 值为80 |
| remark | string | body | 否 | 备注 |
| tcpNatType | string | body | 否 | tcp nat类型 |
| scheduleISPs | []string | 调度运营商 | ||
| vendorSuggestOpenIDs | []uint32 | body | 否 | 期望业务id |
| vendorSuggestCustomerNames | []string | body | 否 | 期望业务名称 |
| netSchedule | NetSchedule | body | 否 | 网络调度 |
| qosThrottling | bool | body | 否 | 当前是否开启板卡限速 |
| resourceType | string | body | 否 | 资源类型 dedicated(专线)/aggregation(汇聚) |
NetSchedule
| 名称 | 类型 | 描述 |
|---|---|---|
| type | string | 网络调度模式
|
| timeRangeExperience | NetScheduleTimeRangeExperience | 分时段体验优先的时间范围 |
NetScheduleTimeRangeExperience
| 名称 | 类型 | 描述 |
|---|---|---|
| timeRanges | []NetScheduleTimeRange | 时间范围 |
NetScheduleTimeRange
| 名称 | 类型 | 描述 |
|---|---|---|
| startElapsedSecs | int | 开始限制时间,距离0点过去的秒数 |
| endElapsedSecs | int | 结束限制时间,距离0点过去的秒数 |
返回值示例
json
正常请求:
http code 200 OK
{
"nodeID": "hjsfkjhsfh5637587",
"province": "江苏",
"city": "南京",
"isp": "电信",
"usbw": 100,
"bwNum": 10,
"natType": "public",
"dialType": "serverDial",
"remark": "remark",
"tcpNatType": "NAT1",
"vendorSuggestOpenIDs": [1001,1002],
"vendorSuggestCustomerNames": ["短视频A","短视频B"],
"netSchedule": {
"type": "timeRangeExperience",
"timeRangeExperience": {
"timeRanges": [
{
"startElapsedSecs": 0,
"endElapsedSecs": 64800
},
{
"startElapsedSecs": 64800,
"endElapsedSecs": 86400
}
]
}
}
}
异常请求:
http code 4xx/5xx
{
"code": 4000001,
"desc": ""
}错误码列表
| 错误码 | 描述 |
|---|---|
| 401 | 鉴权失败 |
| 4000001 | 参数有误, 描述中会包含详细信息 |
| 4000002 | 节点未查找到 |
| 4000005 | 节点状态异常 |
| 4000009 | 流程动作非法 |
如接口返回错误码未列举,可在错误码总览中查找