天融信虚拟防火墙RESTFUL API文档v6.1(1).docVIP

天融信虚拟防火墙API 文档版本v6.1 TOS防火墙当前仅3.3.020.083.1_D14437支持rest api。 登录系统API 1. Token认证登录 接口名称：获取token认证信息 请求类型：post 请求URL:/auth/token-auth 描述:获取token认证信息 请求参数列表 名称 自定义字段 数据类型 备注 用户名 username（必填） string 登录虚拟防火墙的用户名 密码 password（必填） string 用户密码 响应参数列表 返回结果 备注 {token:token} token认证成功,返回token信息 {success:False,msg:… } token认证失败,报错信息详见msg 响应结果json示例{token:eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6InN1cGVybWFuIiwiaWF0IjoxNDczMTI3NjY1LCJpcGFkZHIiOiIxOTIuMTY4LjE4LjE2MiIsInVpZCI6IiJ9.OMtqI3AVu_f-DpZ-p9mK6uHGsS4g2-4GpeCqZPZkbZ4} 说明:因为每次请求都需要携带token信息，因此认证成功后，需要将token信息附加到HTTP请求头headers的字段Authorization中，并在Authorization中的token值中增加前缀Bearer 。 比如认证之后token值为sdfsakfaskdfhsakdhfskd， 则headers中字段Authorization的值为 Bearer sdfsakfaskdfhsakdhfskd 2. Token刷新 接口名称：token刷新 请求类型：get 请求URL: /auth/token-refresh 描述: token的默认有效期为1小时，过期后将需要重新登录才可继续访问API接口。如果想避免重新登录，需要在token过期之前通过该接口刷新token值。 请求参数列表 名称 自定义字段 数据类型 备注 token值 token（必填） string 正在使用的旧token值 响应参数列表 返回结果 备注 {token:token} token更新成功,返回新token信息 {success:False,msg:… } token更新失败,报错信息详见msg 返回HTTP返回码 401 3. 注销 接口名称：注销登录 请求类型：get 请求URL: /auth/logout 描述: 注销用户登录，从系统登出 请求完成之后，HTTP返回码为 200 4. API调试登录 接口名称：获取调试认证信息 请求类型：get 请求URL:/auth/api-debug 描述: 这个接口的使用，需要在调试模式下，用户名默认为superman、密码默认talent，根据用户名、密码、ip地址获取cli对象，返回调试用户数据（cli、plugin、success、msg），根据返回的用户数据进行认证，获取认证结果，认证成功，返回调试认证信息。 响应参数列表 返回结果 备注 success 认证成功 failed 认证失败 说明：认证成功后，可以调用相关接口进行API验证。 网卡IP/通行协议API 1.配置网卡IP 1.1 获取所有接口信息 接口名称：获取所有接口信息 请求类型：get 请求URL:/api/v1/network/interface 描述:得到所有接口信息（物理接口，vlan等） 响应参数列表 名称 自定义字段 数据类型 接口信息列表 ret dict 响应结果json示例: { success: true, ret: { veth1.01: { mode-set: ips, bandwidth: 0Bps, shutdown: yes, speed: auto, mss-adjust: off, reverse-path: off, switchport: { access: {}, switchport: no, trunk: {} }, duplex: auto, vrid: 0, vsid: 0, mtu: 1500,