hillstone_toi_restapi接口扩展和标准化

1、目录 概述 原理 使用 备注2 | Hillstone Confidential概述StoneOS的5.5发布版本中提供了REST接口，但用户在使用时遇到了很多问题，比如字段类型不统一，uri不统一等。因此，本FR对REST接口进行了优化和完善， 并提供给用户一份使用说明文档，以便用户通过REST 接口对设备进行配置和管理。3 | Hillstone Confidential目录 概述 原理 使用 备注4 | Hillstone Confidential原理北向接口（NBI）

2、是对外公开的接口，供第三方调用。Device Schema用来描述数据，包括名称、类型、长度、取值，设备会根据Schema对第三方发送的数据进行校验5 | Hillstone Confidential原理REST（Representational State Transfer），客户端对服务器上的资源进行操作，让服务器端发生状态转化具体来说，就是通过POST（增）、DELETE（删） 、PUT（改）、GET（查）来修改、查看的配置6 | Hillstone Confidential请求类型对应操作说明GET查询查询

3、数据的操作POST增加增加数据的操作PUT修改修改数据的操作DELETE删除删除数据的操作目录 概述 原理 使用 备注7 | Hillstone Confidential使用第三方在访问REST-API前，要进行身份认证，发送用户名、等信息，系统验证通过后会返回一个token，之后通过API发送请求时，都要将HTTP的header添加一个用于身份验证的X-Auth-Token属性，Token有固定的时效，过期需要重新申请。认证登录后，第三方通过REST-API向NBI发送JSON消息，可以进行StoneOS配置操作CRUD（C-Create， R-Ret

4、rieve， U-Update，D-Delete），同时还可以获取监控，告警，日志，系统，及其他StoneOS提供的各种数据。8 | Hillstone Confidential使用这里以Postman（一款REST测试插件）进行操作演示：9 | Hillstone Confidential使用测试步骤：1. 在chrome一个选项卡登录被测设备，认证通过后以便Postman共享cookie2. 登录成功后，新选项卡打开Postman，在URL栏输入设备管理地址+目录，具体模块的URL需要参考API参考文档（文档请

5、联系乔鹏），该文档是根据Schema生成3. 选择方法：增（POST）删（DELETE）改（PUT）查（GET），再输入正确的JSON语句（参考文档），点击Send按钮即可向被测设备的NBI发送JSON消息4. 查看下方的返回值和状态码来判断配置下发是否与预期相符10 | Hillstone Confidential使用输入JSON语句：方法：返回值：11 | Hillstone Confidential目录 概述 原理 使用 备注12 | Hillstone Confidential备注 目前只有文档上给出的模块支持通过REST-API进行配置和查看 目前只支持文档上给定的参数，输入其他参数不会下发配置 可以在设备