管理服务器NPSVR

February 26, 2024About 4 min

管理服务器NPSVR

SDK类名:/resource/Npsvr;

npsvr - 新建

SDK方法名:createNpsvr

URL

/vp/npsvr

Method

POST

Request

名称类型必选简介Mock初始值Mock规则
npsvr_nameString
config_addrString
config_portString
usernameString
passwordString
maintenanceString
commentString
cc_ipString

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageStringsuccess

npsvr - 认证

SDK方法名:authNpsvr

URL

/vp/npsvr/auth

Method

POST

Request

名称类型必选简介Mock初始值Mock规则
config_addrString
config_portString
usernameString
passwordString

Response

名称类型必选简介Mock初始值Mock规则
retString200
msgString
dataObject
  codeString0
  messageStringsuccess

npsvr - 列表

SDK方法名:listNpsvr

URL

/vp/npsvr

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
search_valueString
search_fieldString
limitString
pageString
order_byString

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  info_listArray2-8
    npsvr_uuidString@guid
    npsvr_nameString@first
    config_addrString@ip
    config_portNumber@natural(1,60000)
    maintenanceNumber0-1
    can_upNumber1
    can_delNumber1
    can_opNumber1
  countNumber10
  codeNumber0
  messageString[0] 操作成功。

npsvr - 修改

SDK方法名:modifyNpsvr

URL

/vp/npsvr/:uuid([A-F0-9-]+)

Method

PUT

Request

名称类型必选简介Mock初始值Mock规则
npsvr_nameString
config_addrString
config_portString
usernameString
passwordString
maintenanceString
commentString
cc_ipString

Response

名称类型必选简介Mock初始值Mock规则
retString
msgString
dataObject
  codeString
  messageString

npsvr - 删除

SDK方法名:deleteNpsvr

URL

/vp/npsvr

Method

DELETE

Request

名称类型必选简介Mock初始值Mock规则
npsvr_uuidsArray
forceNumber强制删除,0:关,1:开

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0-1
  messageString
  success_listArray5
    codeString0
    messageString@word
    npsvr_nameString@word
    npsvr_uuidString@guid
  fail_listArray5
    codeString-1
    messageString@word
    npsvr_nameString@word
    npsvr_uuidString@guid
  all_listArray10
    codeString0
    messageString@word
    npsvr_nameString@word
    npsvr_uuidString@guid

npsvr - 状态

SDK方法名:getNpsvrStatus

URL

/vp/npsvr/status

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
npsvr_uuidsArray

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString[0] 操作成功
  statusArray
    statusString@pick('unknown','online','offline','error')
    versionString版本7.1.7@natural(10000,99999)
    timeStringnpsvr时间戳

npsvr - 操作

SDK方法名:npsvrOperate

URL

/vp/npsvr/operate

Method

POST

Request

名称类型必选简介Mock初始值Mock规则
npsvr_uuidsArraynpsvr uuid数组
operateStringmaintain:开关维护模式
renew_key:更新公钥
maintain
switchNumber维护模式 0关,1开0

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageStringsuccess

npsvr - 获取配置列表

SDK方法名:listConfigItems;

URL

/vp/npsvr/:uuid([A-F0-9-]+)/list_config_items

Method

GET

Request

名称类型必选简介Mock初始值Mock规则

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageStringsuccess
  listArray1-4
    nameString配置项名称key@word
    valueString配置项默认值
    display_nameString配置项名称翻译@cname
    value_typeNumber配置项类型:
1:整型;
2:布尔型;
3:字符串;
1-3
    unitString配置项单位:
pieces:个;

hours:时;
minutes:分;
seconds:秒;

times:次;

KB:KB;
MB:MB;
GB:GB;
@pick(pieces, seconds, hours)
    rangeObject取值范围
      minString最小值0
      maxString最大值150
    need_restartBoolean是否重启生效
    tipString?号说明
    descriptionString鼠标悬浮说明

npsvr - 更新配置列表

SDK方法名:updateConfigItems;

URL

/vp/npsvr/:uuid([A-F0-9-]+)/update_config_items

Method

PUT

Request

名称类型必选简介Mock初始值Mock规则
config_itemsArray
  nameString配置项key
  valueString配置项值

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageStringsuccess
Last update: 2/26/2024, 5:49:44 PM
Contributors: ganl