管理服务器NPSVR
February 26, 2024About 4 min
管理服务器NPSVR
SDK类名:/resource/Npsvr;
npsvr - 新建
SDK方法名:createNpsvr
URL
/vp/npsvr
Method
POST
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
npsvr_name | String | ||||
config_addr | String | ||||
config_port | String | ||||
username | String | ||||
password | String | ||||
maintenance | String | ||||
comment | String | ||||
cc_ip | String |
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
ret | Number | 200 | |||
msg | String | ||||
data | Object | ||||
code | Number | 0 | |||
message | String | success |
npsvr - 认证
SDK方法名:authNpsvr
URL
/vp/npsvr/auth
Method
POST
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
config_addr | String | ||||
config_port | String | ||||
username | String | ||||
password | String |
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
ret | String | 200 | |||
msg | String | ||||
data | Object | ||||
code | String | 0 | |||
message | String | success |
npsvr - 列表
SDK方法名:listNpsvr
URL
/vp/npsvr
Method
GET
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
search_field | String | 模糊搜索字段: 名称:npsvr_name; 管理地址:config_addr; | |||
search_value | String | ||||
limit | String | ||||
page | String | ||||
order_by | String |
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
ret | Number | 200 | |||
msg | String | ||||
data | Object | ||||
info_list | Array | 2-8 | |||
npsvr_uuid | String | @guid | |||
npsvr_name | String | @first | |||
config_addr | String | @ip | |||
config_port | Number | @natural(1,60000) | |||
maintenance | Number | 0-1 | |||
can_up | Number | 1 | |||
can_del | Number | 1 | |||
can_op | Number | 1 | |||
count | Number | 10 | |||
code | Number | 0 | |||
message | String | [0] 操作成功。 |
npsvr - 修改
SDK方法名:modifyNpsvr
URL
/vp/npsvr/:uuid([A-F0-9-]+)
Method
PUT
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
npsvr_name | String | ||||
config_addr | String | ||||
config_port | String | ||||
username | String | ||||
password | String | ||||
maintenance | String | ||||
comment | String | ||||
cc_ip | String |
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
ret | String | ||||
msg | String | ||||
data | Object | ||||
code | String | ||||
message | String |
npsvr - 删除
SDK方法名:deleteNpsvr
URL
/vp/npsvr
Method
DELETE
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
npsvr_uuids | Array | ||||
force | Number | 强制删除,0:关,1:开 |
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
ret | Number | 200 | |||
msg | String | ||||
data | Object | ||||
code | Number | 0-1 | |||
message | String | ||||
success_list | Array | 5 | |||
code | String | 0 | |||
message | String | @word | |||
npsvr_name | String | @word | |||
npsvr_uuid | String | @guid | |||
fail_list | Array | 5 | |||
code | String | -1 | |||
message | String | @word | |||
npsvr_name | String | @word | |||
npsvr_uuid | String | @guid | |||
all_list | Array | 10 | |||
code | String | 0 | |||
message | String | @word | |||
npsvr_name | String | @word | |||
npsvr_uuid | String | @guid |
npsvr - 状态
SDK方法名:getNpsvrStatus
URL
/vp/npsvr/status
Method
GET
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
npsvr_uuids | Array |
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
ret | Number | 200 | |||
msg | String | ||||
data | Object | ||||
code | Number | 0 | |||
message | String | [0] 操作成功 | |||
status | Array | ||||
status | String | @pick('unknown','online','offline','error') | |||
version | String | 版本 | 7.1.7@natural(10000,99999) | ||
time | String | npsvr时间戳 |
npsvr - 操作
SDK方法名:npsvrOperate
URL
/vp/npsvr/operate
Method
POST
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
npsvr_uuids | Array | npsvr uuid数组 | |||
operate | String | maintain:开关维护模式 renew_key:更新公钥 | maintain | ||
switch | Number | 维护模式 0关,1开 | 0 |
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
ret | Number | 200 | |||
msg | String | ||||
data | Object | ||||
code | Number | 0 | |||
message | String | success |
npsvr - 获取配置列表
SDK方法名:listConfigItems;
URL
/vp/npsvr/:uuid([A-F0-9-]+)/list_config_items
Method
GET
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
ret | Number | 200 | |||
msg | String | ||||
data | Object | ||||
code | Number | 0 | |||
message | String | success | |||
list | Array | 1-4 | |||
name | String | 配置项名称key | @word | ||
value | String | 配置项默认值 | |||
display_name | String | 配置项名称翻译 | @cname | ||
value_type | Number | 配置项类型: 1:整型; 2:布尔型; 3:字符串; | 1-3 | ||
unit | String | 配置项单位: pieces:个; hours:时; minutes:分; seconds:秒; times:次; KB:KB; MB:MB; GB:GB; | @pick(pieces, seconds, hours) | ||
range | Object | 取值范围 | |||
min | String | 最小值 | 0 | ||
max | String | 最大值 | 150 | ||
need_restart | Boolean | 是否重启生效 | |||
tip | String | ?号说明 | |||
description | String | 鼠标悬浮说明 |
npsvr - 更新配置列表
SDK方法名:updateConfigItems;
URL
/vp/npsvr/:uuid([A-F0-9-]+)/update_config_items
Method
PUT
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
config_items | Array | ||||
name | String | 配置项key | |||
value | String | 配置项值 |
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
ret | Number | 200 | |||
msg | String | ||||
data | Object | ||||
code | Number | 0 | |||
message | String | success |