ros api 中文说明

《ros api 中文说明》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、ROSAPI中文说明前言：ROS是一个比较流行的软路由系统，它的强大在于它的高度定制性，它提供了应用程序编程使用的API接口，是它应用更加灵活，我们可以自己开发软件或WEB程序来操控ROS，比较实用的例子就是当用ROS管理小区网络时，我们用自己写的软件来管理上网账号，安全又方便，总之好处多多，本文基于官方API文档：http://wiki.mikrotik.com/wiki/API翻译而成，结合了作者的理解，水平有限，难免有错漏的地方，望大家批评指正，谢谢！正文：目录1简介2通讯协议2.1API词2.1.1

2、命令词2.1.2属性词2.1.3API属性词2.1.4查询语句2.1.5回复语句2.2API特定命令说明3初始登录4标签(.Tags)5API命令说明5.1查询词说明5.2OID6API命令例子6.1/system/package/getall6.2/user/active/listen6.3/cancel,simultaneouscommands7客户端程序例子8参考8.1APIexamplesintheWiki8.2APIexamplesontheMikroTikForum8.3APIexmaplese

3、lsewhere简介：应用程序编程接口（API），允许用户创建定制的软件解决方案与RouterOS的沟通，收集信息，调整配置和管理路由器。API紧随命令行界面（CLI）的语法。它可以用来创建转换或自定义的配置工具，以帮助管理使用RouterOS的路由器。使用API需要RouterOS版本3.x或更高的版本。默认情况下，API使用端口8728，默认服务是禁用的。通讯服务的名称是API，请在IP-SERVER里开启，服务管理的详细信息，请参阅相应的手册部分。通讯协议：应用程序与路由器的通信是通过发送和接收路由器

4、的一个或多个编码的句子来完成的。一个句子是以零字符结尾的单词序列。词是句子以某种方式编码-（编码长度是数据的一部分），路由器发送和接收回复并发送这些句子。每个句子发送到路由器使用API没有特定的顺序，每个命令字是以零字符标记结束的。当路由器接收到完整的句子（命令字，或多个属性的话，零字符结束），它就开始执行命令，并将结果返回给应用程序。API语句：词是句子的一部分。每个词长都用某种方式编码-词长编码跟随词的内容就是一个句子。词的长度应为将要发送的字节计数（不包括词长编码）。词长编码如下：Valueoflen

5、gth#ofbytesEncoding0<=Len<=0x7F1Len,lowestbyte词长度0x80<=Len<=0x3FFF2Len

6、0x8000,twolowerbytes0x4000<=Len<=0x1FFFFF3Len

7、0xC00000,threelowerbytes0x200000<=Len<=0xFFFFFFF4Len

8、0xE0000000Len>=0x1000000050xF0andLenasfourbytes对应的10进制：长度字节数词长编码0<=长度<=1271长度低位128<=长度

9、<=163832位或（长度，32768）取低2位16384<=长度<=20971513位或（长度，12582912）取低3位2097152<=长度<=2684354554位或（长度，3758096384）长度>=2684354565{240}+到字节集(长度)v每个词的编码长度，然后紧接着许多字节的词内容（词长编码+词内容）；v字组合成句子，以零字符结束；v最高长度可以达到0x7FFFFFFFFF,最高占用4字节；v词长编码字节（Len）总是在最前面（网络顺序）；v如果单词的第一个字节是>=0xF8，那么它

10、是一个保留的控制字节。未知的控制字节API客户端接收后无法继续，因为它不知道如何解释以下字节；v目前，控制字节不使用；v句子一般情况是这样的：<词长编码><词的内容>，主要有5种类型：命令语句，属性语句，API属性语句，查询语句，回复语句；命令语句（Commandword）在句子的第一个字是由名字（属性）和零长度的词终止字的命令。命令字的名称应以'/'开始。命令中的名字，与命令行界面输入的一样，要注意的API中的命令不能有空格，需要用以'/'替换，比如查看网卡信息"/intpri"在API里就必须这样"/i

11、nt/pri"，不然无法识别；注意：发送的命令必须严格按照这样的顺序：Ø编码长度Ø内容前缀"/"Ø命令行的转换命令(空格用"/"替换)API特定的命令：getalllogincancel命令连接例子：/login/ip/address/getall/user/active/listen/interface/vlan/remove/system/reboot2.1.2属性语句（Attributeword）每个命令都