http api - newzai/snmp_doc GitHub Wiki

1. common

  • userinfo
{
    "userid":int
    "usertype":int  -- 1 管理员， 2 普通用户
    "username": ""
    "password": ""  -- md5之后的值
    zoneinfo:
    {
        "zoneid": int   -- top(root) zone
        "zonename": ""  -- top(root) zone name
        "zonepath": ""  
    }
}
  • iteminfo
{
    
    "itemid":int
    "parent":int
    "itemname":""
    "itempath":""
    "itemtype":int 
    "status": int  -- for itemtype == 2
    "dev_type":"" -- 设备类型 for itemtype == 2
            
}

2. login

  • POST
  • URL v1/login
  • Body
{
    "username":"",
    "password":md5("")
}
  • Response
{
    "result": 0         -- or other, 0 is ok
    "message": "OK"     -- or other error message
    "data":             -- if result == 0
    {
        "token":""      --登录成功后分配的token值，后续请求都需要
        "userinfo": userinfo
    }
}
  • Test

curl -X POST -H 'content-type: application/json' -d '{"username":"admin", "password":"123456"}' http://118.126.91.183:9192/v1/login

3. logout

  • POST
  • URL v1/logout
  • Body
{
    "token":""     -- login 返回的token
}
  • Response
{
    "result": 0         -- or other, 0 is ok
    "message": "OK"     -- or other error message
}

4. getitem

curl -X POST -H 'content-type: application/json' -d '{"token":"111-222-333-4444", "data":{"itemid":1, "itemtype":1}}' http://127.0.0.1:9192/v1/getitem

  • POST
  • URL v1/getitem
  • Body
{
    "token":""
    "data":
    {
        "itemid": int  -- zoneid or devid or userid
        "itemtype": int -- 1 zone, 2 dev , 3 user
    }
}
  • Response
{
    "result": 0         -- or other, 0 is ok, if ok has data
    "message": "OK"     -- or other error message
    "data":
    {
        "items":
        [
            iteminfo_1,
            iteminfo_2,
            ...
            iteminfo_i
        ]
    }
}
  • Test

curl -X POST -H 'content-type: application/json' -d '{"token":"111-222-333-4444", "data":{"itemid":1, "itemtype":1}}' http://118.126.91.183:9192/v1/getitem

5. SNMP 配置

  • POST
  • URL v1/snmp
  • Body
{
    "token":""
    "data":
    {
        "snmp_type": ""  -- value is "get" or "set"
        "itemid":int     --  要操作的设备id 
        "index" : int    --- 一般填写0， 操作snmp table 填写索引值
        "oids":
        {
            一下成员，动态，根据具体页面设置即可, 对于get int填写0， string 填写 "" 
            "oid1": int or str
            "oid2" :int or str
            ....
            "oidi": int or str
        }
    }
}
  • Response
{
    "result": 0         -- or other, 0 is ok, if ok has data
    "message": "OK"     -- or other error message
    "data":             -- only for snmp_type is get 
    {
        "oids":
        {
            "oid1": int or str
            "oid2" :int or str
            ....
            "oidi": int or str
        }
    }
}
  • Test

curl -X POST -H 'content-type: application/json' -d '{"token":"111-222-333-4444", "data":{"snmp_type":"get", "itemid":4,"index":1,"oids":{"software_version":"","wan_link_status":0,"lan_link_status":0}}}' http://118.126.91.183:9192/v1/snmp

5.1. 获取配置文件

  • SNMP 配置更新之前，可以获取配置文件列表
  • POST
  • URL v1/get_config_file
  • Body
{
    "token":""
    "data":
    {
        "itemid": 5
    }
}
  • Response
{
    "result": 0         -- or other, 0 is ok, if ok has data
    "message": "OK"     -- or other error message
    "data":
    {
        "files":{
            file1,
            file2,
            ...,
            fileN
        }
    }
}
  • 把获取到的files的 任意一个文件名称放到 oids的字段 usl_ftp_restore_cfg_file_name 即可

6. SNMP 批量配置

  • 说明，只能批量配置，归属自己的设备
  • POST
  • URL v1/snmp_batch
  • Body
{
    "token":""
    "data":
    {
        "dev_type": "" --要批量配置的设备类型
        "itempath": "" -- 指定 zone path ，在该path下面的所有指定设备会被批量处理
        "oids":
        {
            "oid1": int or str
            "oid2" :int or str
            ....
            "oidi": int or str
        }
    }
}
  • Response
{
    "result": 0         -- or other, 0 is ok, if ok has data
    "message": "OK"     -- or other error message
    "data":
    {
        "ok_items":   --所谓的成功是直snmp命令发送成功， 如果用于固件 ftp升级，不代表固件ftp升级成功，只能说是把升级命令发送到了设备
        [
            {
                "itemid":int,
                "itemname":""
            }
        ]
        "error_items":
        [
           {
               "itemid":int
               "itemname":""
               "error":""
           }
        ],

    }
}

6.1. 批量FTP升级

包含ftp升级相关参数

{
    "oids":
    {
        "usl_ftp_server_ip":"118.126.91.183",
        "usl_ftp_server_port":21,
        "usl_ftp_user_name":"uftp",
        "usl_ftp_user_passwd":"123456789",
        "usl_ftp_file_size":"380605",
        "usl_ftp_soft_file_name":"klph-40b19.tar"
    }
}

6.2. 批量重启

{
    "oids":
    {
        "usl_reboot_device":"reboot"
    }
}

6.3. 批量恢复出厂设置

{
    "oids":
    {
        "usl_set_default":"default"
    }
}

6.4. 批量备份配置文件

{
    "oids":
    {
        "usl_ftp_server_ip":"118.126.91.183",
        "usl_ftp_server_port":21,
        "usl_ftp_user_name":"uftp",
        "usl_ftp_user_passwd":"123456789",
        "usl_ftp_save_cfg_file_name":"default"
    }
}

usl_ftp_save_cfg_file_name 名称随意给即可，服务器会统一文件名称为 设备的ntid_YYmmDD_HHMMSS.cfg

6.5. 批量配置

以下列出的字段支持批量配置，可以出现在 请求消息 的oids参数中；

名称 jsonKey 默认值 说明
语言模式 k518_language_mode 缺省：0 //中文
http模式 k518_http_mode 缺省：0 //http模式
http端口 k518_http_port 缺省：80
telnet端口 k518_telnet_port 缺省：23
sip本地端口 k518_sip_local_port 缺省：5060
二次拨号模式 k518_dtmf_relay_mode 缺省：0 //2833模式
语音算法列表 k518_codec_type_list 缺省："3 1 0 4 2"
热线使能开关 k518_hotline_enable 缺省：0 //关闭
热线号码 k518_hotline_number 缺省："690"
热线账号 k518_hotline_account 缺省：0
麦克风音量 k518_microphone_volume 缺省：6
扬声器音量 k518_speaker_volume 缺省：4
挂机等待时间 k518_hookon_wait_time 缺省：10
铃声类型 k518_ring_style 缺省：0
振铃音量 k518_ring_volume 缺省：7

7. modify_password 修改自己的用户名和密码

  • POST
  • URL v1/modify_password
  • Body
{
    "token":""
    "data":
    {
        "userid": int -- user for modify
        "old_password":""  -- md5
        "new_password": "" -- md5
    }
}
  • Response
{
    "result": 0         -- or other, 0 is ok, if ok has data
    "message": "OK"     -- or other error message
}

8. getusers -- for admin

  • POST
  • URL v1/getusers
  • Body
{
    "token":""
    "data":
    {
        "zoneid": int 
    }
}
  • Response
{
    "result": 0         -- or other, 0 is ok, if ok has data
    "message": "OK"     -- or other error message
    "data":
    {
        "users":[
        userinfo_1,
        userinfo_2,
        ...
        userinfo_i
        ]
    }
}

9. create_user -- for admin

  • POST
  • URL v1/create_user
  • Body
{
    "token":"",
    "data":
    {
        "username":""
        "password": "" -- md5
        "usertype": int
        "zoneid":int -- parent zone id 
    }
}
  • Response
{
    "result": 0         -- or other, 0 is ok, if ok has data
    "message": "OK"     -- or other error message
}

10. delete_user -- for admin

  • POST
  • URL v1/delete_user
  • Body
{
    "token":"",
    "data":
    {
        "userid":int -- 要删除的用户id
    }
}
  • Response
{
    "result": 0         -- or other, 0 is ok, if ok has data
    "message": "OK"     -- or other error message
}

11. modify_user -- for admin

  • POST
  • URL v1/modify_user
  • Body
{
    "token":"",
    "data":
    {
        "userid": int  -- for modify user id 
        "usertype": int  --如果要修改用户类型，包含该字段
        "password": "" -- md5  如果要修改 密码，包含该字段
        "zoneid": int  -- 如果要修改管理的区域，包含该字段
    }
}
  • Response
{
    "result": 0         -- or other, 0 is ok, if ok has data
    "message": "OK"     -- or other error message
}

12. 固件管理 -- for admin

12.1. 固件查询

  • POST
  • URL v1/get_all_hardware
  • Body
{
    "token":""
    "data":{
        "dev_type":"KN518"| "KN519"
    }
}
  • Response
{
    "result": 0         -- or other, 0 is ok, if ok has data
    "message": "OK"     -- or other error message
    "data":
    {
        "files":
        [
            filename1,
            filename2,
            ....
            filenameN
        ]
    }
}

12.2. 固件上传

通过 From 表单上传

13. FTP 固件升级

13.1. ftp 升级

  • 使用 snmp set命令，参考 snmp接口；需要包含以下字段 usl_ftp_server_ip
    usl_ftp_server_port
    usl_ftp_user_name
    usl_ftp_user_passwd
    usl_ftp_file_size
    usl_ftp_soft_file_name
  • URL v1/snmp
{
	"token":"111-222-333-4444",
	"data":
	{
		"snmp_type":"set",
		"itemid":5,
		"index":0,
		"oids":
		{
			"usl_ftp_server_ip":"118.126.91.183",
			"usl_ftp_server_port":21,
			"usl_ftp_user_name":"uftp",
			"usl_ftp_user_passwd":"123456789",
			"usl_ftp_file_size":"380605",
			"usl_ftp_soft_file_name":"klph-40b19.tar"
		}
	}
}

13.2. ftp 升级状态查询

  • POST
  • URL /v1/ftp_upgrade_status
  • Body
{
    "token":
    "data:"
    {
        itemid: int  -- 查询单个设备
        itempath: string --查询批量ftp升级
        dev_type: string --查询批量ftp升级
    }
}
  • Response
{
    "result": 0         -- or other, 0 is ok, if ok has data
    "message": "OK"     -- or other error message
    "data":
    {
       "upgrades": [ftp_upgrade_info...]
    }
}
  • ftp_upgrade_info
{
    itemid: int 
    itemname: string
    itempath: string
    dev_type: string
    result :
}
⚠️ **GitHub.com Fallback** ⚠️