接口描述

节点查询可提交的需求 位置信息 参考

请求路径

GET /v1/vendorclaimablebw

请求参数

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

返回值

名称 类型 描述
customerClaimInfoItems []customerClaimInfoItems 可提交的需求列表

customerClaimInfoItems

名称 类型 描述
customerId int 可提交的需求 ID
externalName string 可提交的需求名称
status int 可提交的需求状态(除禁止上机外均可上机)
  • -1：禁止上机
  • 0：推荐上机
  • 1：可以上机
statusStr string 可提交的需求状态描述

请求示例

http://niulinkcloud-example/v1/vendorclaimablebw?province=浙江&isp=电信&usbw=100&bwNum=10&natType=public&dialType=serverDial

返回值示例

正常请求：
  http code 200 OK

{
    "customerClaimInfoItems": [
      {
            "customerId": 16502,
            "externalName": "长视频B",
            "status": 1,
            "statusStr": "可以上机"
        },
        {
            "customerId": 16501,
            "externalName": "短视频A",
            "status": 0,
            "statusStr": "推荐上机"
        },
        {
            "customerId": 16606,
            "externalName": "短视频H",
            "status": -1,
            "statusStr": "禁止上机"
        }
}

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

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

错误码列表

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

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

results matching ""

    No results matching ""