系统管理

June 24, 2022About 22 min

系统管理

SDK类名：/common/Settings;

----- 系统设置 -----

URL

/系统设置

Method

GET

Request

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

Response

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

系统设置-更新配置

SDK方法名：updateSetting;

发送键值对，更新记录；

仅发送当前需要改的参数；

URL

/sys/settings

Method

POST

Request

名称	类型	必选	简介	Mock初始值
cc_ips	Array	否	控制台地址
page_size	String	否	列表默认记录数（条）	10
refresh_interval	String	否	状态刷新间隔（秒）	10
log_save_time	String	否	日志保留时长（天）	30
email_switch	String	否	邮件，是否启用邮件通知，1是0否；	1
email_title	String	否	邮件，可选，邮件签名，没默认值
email_content	String	否	邮件，可选，邮件正文签名，没默认值
email_smtp_svr	String	否	邮件，SMTP的服务器地址	test
email_smtp_port	String	否	邮件，SMTP的服务器端口	25
email_smtp_auth	String	否	邮件，开启SMTP认证	1
email_account	String	否	邮件，邮箱帐号	test@info2soft.com
email_from	String	否	邮件，发件人邮箱，非必填，没填用account
email_pwd	String	否	邮件，邮箱密码（加密），获取此字段不会返回真实密码而是 *；修改时如给后端 *，后端不会修改；	123456
email_smtp_ssl	String	否	邮件，使用SSL连接服务器	0
sms_switch	String	否	短信，短信通知开关，1是0否；	1
sms_platform	String	否	短信，短信平台；阿里：ali；华为：hw；东方证券：df；企信王：esk；太平洋：tpy_oto；短信猫：dtu；国泰君安：gtja；国都证券：gdzq；医利捷 : ylj; 华发财务: hfcw, 玄武科技UMP：ump	ali
sms_app_key	String	否	短信，阿里，AppKey	AppKey
sms_secret_key	String	否	短信，阿里，SecretKey	SecretKey
sms_sign_name	String	否	短信，阿里，签名名称	SignName
sms_template_code	String	否	短信，阿里/华为/东方，短信模板ID	template
sms_server	String	否	短信，企信王/东方/太平洋/国泰君安/国都证券/华发财务，服务地址
sms_username	String	否	短信，企信王/华为/东方/太平洋/国泰君安/国都证券/玄武科技UMP，用户名
sms_password	String	否	短信，企信王/华为/东方/太平洋/国泰君安/国都证券/玄武科技UMP，密码
sms_domain_name	String	否	短信，华为，华为账户名
sms_region_name	String	否	短信，华为，所属区域
sms_topic_urn	String	否	短信，华为，主题的URN
dtu_serial_device	String	否	短信，短信猫，串口
dtu_baud_rate	String	否	短信，短信猫，波特率
notify_contact_biz	Object	否	通知中心，普通联系人，默认包含
phone	String	否	电话，逗号分隔	11111111111
email	String	否	邮件，逗号分隔	test@info2sost.com
notify_contact_chk	Object	否	通知中心，巡检联系人
phone	String	否	电话，逗号分隔	11111111111
email	String	否	邮件，逗号分隔	test@info2sost.com
policy	Object	否	通知策略
every	String	否	month / season	month
days	String	否	第几天，逗号分隔	5,6
notify_contact_status	Object	否	通知中心，状态联系人
phone	String	否	电话，逗号分隔	11111111111
email	String	否	邮件，逗号分隔	test@info2sost.com
policy	Object	否	通知策略
every	String	否	hour / day	hour
gap	String	否	间隔小时/天数	4
notify_limit	String	否	通知中心，通知次数上限；	10
node_latest_ver	String	否	特殊参数，在线升级，最新版本号
node_upgrade_server	String	否	特殊参数，在线升级，最新版本号
node_upgrade_path	String	否	特殊参数，在线升级，升级包存放路径
node_online_upgrade	String	否	特殊参数，在线升级，0关1开	0
mirr_skip	String	否	特殊参数，忽略镜像配置项，0关1开；	0
passwd_expire	String	否	安全设置，密码有效期（天）；	30
passwd_length	String	否	安全设置，密码长度；	8
passwd_strong	String	否	安全设置，限制密码复杂度；	1
login_attempt	String	否	安全设置，允许尝试登陆次数；	13
login_lock	String	否	安全设置，失败锁定时间（分）；	10
white_list	Array		按照设置，白名单，默认:[0.0.0.0]	[0.0.0.0]
client_lang	String	否	语言设置，如 english， zh_cn	zh_cn
offline_mode	Number	否	离线模式（禁止RPC）：0关1开；数据库迁移完了，自动进入离线模式，前端弹个浮窗上面加个按键“退出离线模式”，提示用户加许可后退出离线模式（用户不能手动进入离线模式）	0
product_title	Object	否	产品名称数组
title	String	否	系统名称：英方统一数据管理平台
title_logo	String	否	系统名称logo
favicon	String	否	系统图标
copyright	String	否	版权信息
copyright_logo	String	否	版权logo
login_background	String	否	登录页背景
login_logo	String	否	登录页logo
home_background	String	否	首页背景
home_logo	String	否	首页logo
ylj_channel_no	String	否	医利捷渠道编号	0001
ylj_system_no	String	否	医利捷系统编号	0001
log_path	String		日志存储目录
max_log_path_size	Number		日志目录大小上限: 只允许输入大于0的正整数, 默认值1024 ，单位MB
log_archive_path	String		日志转存目录，不能与日志存储目录相同
max_disk_occupancy	Number		磁盘占用上限，单位GB	0
wechat_switch	Number		微信开关	0
app_id	String		微信服务号appid
app_secret	String		微信服务号secret
aes_key	String		微信服务号aes_key
wechat_token	String		接口配置token
normal_notify_switch	Number		恢复正常通知开关	0
sms_id	String		短信模板id
wechat_id	String		微信消息模板id
maintenance_switch	Number		运维平台开关	0
maintenance_ip	String		运维平台接口地址
maintenance_source_id	String		（e海智维）运维平台sourceID
maintenance_default_ip	String		（e海智维）运维平台默认告警设备绑定地址
maintenance_user_id	String		（e海智维）运维平台告警需要额外通知的员工工号
maintenance_platform	String		htsec：e海智维 cscb：长沙银行综合监控告警系统
stop_alerts	Number		停止态是否告警： 0：否； 1：是；	1
etcd_urls	Array		【etcd配置信息】
name	String		配置名称，用于在节点和服务集群中显示
urls	Array		etcd服务器地址：【ip:port】
ip	String
port	String
uuid	String		etcd服务器地址绑定的唯一标识
has_node	Number		etcd服务器地址关联的资源数【节点+服务集群】
audio_alert_notify	Number		音频告警通知
single_alert_loop_broadcast_times	Number		单次告警循环播报次数
custom_audio	String		自定义音频
maintenance_username	String		（长沙银行）运维平台用户名
maintenance_password	String		（长沙银行）运维平台密码
maintenance_source_system_code	String		（长沙银行）事件来源系统编码
maintenance_source_system_name	String		（长沙银行）事件来源系统名
maintenance_event_system_name	String		（长沙银行）事件发生系统名
maintenance_event_system_code	String		（长沙银行）事件发生系统编码
snmp_switch	Number		SNMP消息推送开关： 0：关； 1：开；	0
snmp_version	String		SNMP版本： 2C、3C；
snmp_community	String		社区名称
snmp_ip	String		SNMP管理地址
snmp_port	Number		SNMP管理端口

Response

名称	类型	必选	简介	Mock初始值
msg	String	否
ret	Number	否	@mock=200	200
data	Object	否
message	String	否	@mock=success update to latest version	success update to latest version
code	Number	否	@mock=0	0

系统设置-获取配置

SDK方法名：listSysSetting;

内容同更新配置

URL

/sys/settings

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
keys	Array	否	要获取的字段

Response

名称	类型	必选	简介	Mock初始值
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
message	String	否		[0] 操作成功。
cc_ip	String	否		192.168.72.70
log_save_time	String	否		30
page_size	String	否		10
refresh_interval	String	否		10
email_smtp_svr	String	否		test
email_smtp_port	String	否		25
email_smtp_ssl	String	否		0
email_smtp_auth	String	否		1
email_account	String	否		test@info2soft.com
email_pwd	String	否		123456
email_switch	String	否		1
sms_switch	String	否		1
sms_platform	String	否		ali
sms_app_key	String	否		AppKey
sms_secret_key	String	否		SecretKey
sms_sign_name	String	否		SignName
sms_template_code	String	否		template
sms_server	String	否
sms_username	String	否
sms_password	String	否
sms_domain_name	String	否
sms_region_name	String	否
sms_topic_urn	String	否
notify_contact_biz	Object	否
phone	String	否		11111111111
email	String	否		test@info2sost.com
notify_contact_chk	Object	否
phone	String	否		11111111111
email	String	否		test@info2sost.com
policy	Object	否
every	String	否		1
days	String	否		5
notify_contact_status	Object	否
phone	String	否		11111111111
email	String	否		test@info2sost.com
policy	Object	否
every	String	否		3
gap	String	否		4
node_latest_ver	String	否
node_upgrade_server	String	否
node_upgrade_path	String	否
node_online_upgrade	String	否		0
mirr_skip	String	否		0
passwd_expire	String	否		180
passwd_length	String	否		8
passwd_strong	String	否		1
login_attempt	String	否		13
login_lock	String	否		10
notify_limit	String	否		10
client_lang	String	否		zh_cn
cc_ips	Array
ip	String			172.20.68.211
uuid	String			F9710F22-59F0-7C65-6DC2-88AE138EC71C
has_node	Number		1表示存在节点绑定，0表示无节点绑定可删除	1
maintenance_switch	Number		运维平台开关	0
maintenance_ip	String		运维平台接口地址
maintenance_source_id	String		运维平台sourceID
maintenance_default_ip	String		运维平台默认告警设备绑定地址
maintenance_user_id	String		运维平台告警需要额外通知的员工工号
product_title	Object	否
title	String	否
copyright	String	否
favicon	String	否
copyright_logo	String	否
login_background	String	否
login_logo	String	否
home_logo	String	否
home_background	String	否

系统设置-获取公开配置

SDK方法名：listPublicSettings;

URL

/sys/public_settings

Method

GET

Request

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

Response

名称	类型	必选	Mock初始值
ret	Number	否	200
msg	String	否
data	Object	否
code	Number	否	0
message	String	否	[0] 操作成功。
product_title	Object	否
title	String	否
title_logo	String	否
copyright	String	否
favicon	String	否
copyright_logo	String	否
login_background	String	否
login_logo	String	否
home_logo	String	否
home_background	String	否

系统设置-控制台主机IP

SDK方法名：describeCCip;

URL

/sys/settings/ips

Method

GET

Request

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

Response

名称	类型	必选	简介	Mock初始值
data	Object	否
code	Number	否	@mock=0	0
ips	Array	否
message	String	否	@mock=success update to latest version	success update to latest version
msg	String	否
ret	Number	否	@mock=200	200

----- 用户管理 -----

URL

/用户管理

Method

GET

Request

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

Response

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

用户管理(admin)-新增用户

SDK方法名：createUser;

URL

/user

Method

POST

Request

名称	类型	必选	简介	Mock初始值
username	String	否		test2
password	String	否	RSA加密	11111111
roles	Array	否	角色id数组，1-5：tenant_admin，sysadmin，admin，auditor，operator	["3"]
active	String	否		1
email	String	否		11@info2soft.com
mobile	String	否		12366666666
comment	String	否

Response

名称	类型	必选	Mock初始值
ret	Number	否	200
msg	String	否
data	Object	否
code	Number	否	0
message	String	否	[0] 操作成功。
uuid	String	否	773B582B-E6E9-7236-3465-EC4E3B889A8A
keys	Object	否
access_key	String	否	wUVIkvDcuRE75dJnj2LQANKpCMbTlF6i
secret_key	String	否	SLhGo6X5swUBCv0Z3HOyNAY9nmM1QupF42RVbceE
user_uuid	String	否	773B582B-E6E9-7236-3465-EC4E3B889A8A

用户管理(admin)-用户列表(admin)

SDK方法名：listUser

URL

/user

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
limit	Number	否		10
page	Number	否		1

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
message	String	否
users	Array	否			5
id	String	否		2
user_uuid	String	否		1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC
username	String	否		admin
email	String	否
mobile	String	否
active	String	否		1
first_name	String	否		Admin
last_name	String	否		default
address	String	否
comment	String	否
company	String	否
create_time	String	否		1539835353
builtin	String	否		1
roles	Array	否
id	String	否		3
user_id	String	否		2
role_id	String	否		3
name	String	否		admin
is_system	String	否		1
allow_new_user	String	否		1
display_name	String	否		Business Administrator
description	String	否		Admin User
dynamic_perms	String	否		0
total	Number	否		5
track_login_attempts	Boolean		是否限制登录失败次数	false

用户管理(admin)-获取用户

SDK方法名：describeUser

URL

/user/:id([0-9]+)

Method

GET

Request

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

Response

名称	类型	必选	Mock初始值
ret	Number	否	200
msg	String	否
data	Object	否
code	Number	否	0
message	String	否
id	String	否	2
user_uuid	String	否	1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC
username	String	否	admin
email	String	否
mobile	String	否
active	String	否	1
first_name	String	否	Admin
last_name	String	否	default
address	String	否
comment	String	否
company	String	否
create_time	String	否	1539835353
builtin	String	否	1

用户管理(admin)-删除账户

SDK方法名：deleteUser

URL

/user

Method

DELETE

Request

名称	类型	必选	简介	Mock初始值	Mock规则
ids	Array	否	id数组	["20"]

Response

名称	类型	必选	Mock初始值
ret	Number	否	200
msg	String	否
data	Object	否
code	Number	否	0
message	String	否	[0] 操作成功。

用户管理(admin)-修改用户信息

SDK方法名：modifyUser

URL

/user/:id([0-9]+)

Method

PUT

Request

名称	类型	必选	简介	Mock初始值
username	String	否		test
password	String	否	RSA加密	11111111
roles	Array	否		["3"]
active	String	否		1
email	String	否		123@info2soft.com
mobile	String	否		12332145248
comment	String	否
first_name	String	否
last_name	String	否

Response

名称	类型	必选	Mock初始值
ret	Number	否	200
msg	String	否
data	Object	否
code	Number	否	0
message	String	否	[0] 操作成功。

用户管理 - 解除用户登录锁定

URL

/user/:uuid([A-F0-9-]+)/clear_login_attempt

Method

POST

Request

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

Response

名称	类型	Mock初始值
ret	Number	200
msg	String
data	Object
code	Number	0
message	String	[0] 操作成功。

----- Profile -----

URL

/用户Profile

Method

GET

Request

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

Response

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

用户Profile(all user)-修改密码

SDK方法名：modifyUserPwd

URL

/user/password

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
old_password	String	否	RSA加密	Info1234
password	String	否	RSA加密	Info1234

Response

名称	类型	必选	Mock初始值
ret	Number	否	200
msg	String	否
data	Object	否
code	Number	否	0
message	String	否	[0] 操作成功。

用户Profile(all user)-获取用户Profile

SDK方法名：listProfile

URL

/user/profile

Method

GET

Request

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

Response

名称	类型	必选	简介	Mock初始值
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
message	String	否
profile	Object	否
user_uuid	String	否		1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC
username	String	否		admin
mobile	String	否		123412341234
email	String	否		a@qq.com
nickname	String	否		admin
company	String	否		公司
address	String	否		上海市闵行区
comment	String	否
pwd_change_time	String	否		1756863795
is_biz_admin	String	否	是否是业务管理员
main_role	String		用户首选角色，内置的有： tenant_admin 租户管理员， sysadmin 系统（用户）管理员, admin 业务管理员， auditor 审计， operator，操作员，普通用户；其他类型角色为自定义角色，属于“业务管理员”或 “操作员”中的一种	auditor
access_log	Array

用户Profile(all user)-修改Profile

SDK方法名：modifyProfile

URL

/user/profile

Method

PUT

Request

名称	类型	必选	Mock初始值
mobile	String	否	15354254585
email	String	否	test@info2soft.com
nickname	String	否	test
company	String	否	info2soft
address	String	否	test
comment	String	否

Response

名称	类型	必选	Mock初始值
data	Object	否
message	String	否
code	Number	否	0
ret	Number	否	200
msg	String	否

用户Profile(all user)-退出登录

SDK方法名：logout

URL

/user/logout

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
lock	Number		用户锁定时传1，代表锁定	1

Response

名称	类型	必选	简介	Mock初始值
data	Object	否
code	Number	否	@mock=0	0
message	String	否	@mock=logout successful	logout successful
msg	String	否
ret	Number	否	@mock=200	200

----- 密钥管理 -----

URL

/密钥

Method

GET

Request

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

Response

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

AccessKey列表

SDK方法名：listAk;

URL

/ak

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
type	Number		0-普通人机 1-机机

Response

名称	类型	必选	Mock初始值
ret	Number	否	200
msg	String	否
data	Object	否
code	Number	否	0
message	String	否
total	Number	否	1
keys	Array	否
username	String	否	admin
access_key	String	否	VqUyHS2YQkxnAEZBjFP38e9ht7IaJNlO
secret_key	String	否	Row3KUzQVGT5PB6a9mvYFu7kMhHnl8JsIepXryiC
status	Number	否	0
created_at	String	否	1553501446

AccessKey新建

SDK方法名：createAk;

URL

/ak

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
type	Number		0-普通人机 1-机机

Response

名称	类型	必选	Mock初始值
ret	Number	否	200
msg	String	否
data	Object	否
code	Number	否	0
message	String	否	[0] 操作成功。
secret_key	String

AccessKey更新

SDK方法名：modifyAk; 启用、禁用

URL

/ak

Method

PUT

Request

名称	类型	必选	简介	Mock初始值	Mock规则
access_key	String	否		pytDWihn3NscXewH8UYLIZq2gE7ufGoQ
status	Number	否	0 禁用； 1 启用	0

Response

名称	类型	必选	Mock初始值
ret	Number	否	200
msg	String	否
data	Object	否
code	Number	否	0
message	String	否	[0] 操作成功。

AccessKey删除

SDK方法名：deleteAk; 不支持批量删除

URL

/ak

Method

DELETE

Request

名称	类型	必选	简介	Mock初始值	Mock规则
access_key	String	否		pytDWihn3NscXewH8UYLIZq2gE7ufGoQ

Response

名称	类型	必选	Mock初始值
ret	Number	否	200
msg	String	否
data	Object	否
code	Number	否	0
message	String	否	[0] 操作成功。

----- 角色管理 -----

角色相关

URL

Method

GET

Request

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

Response

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

角色管理 - 角色列表

SDK方法名：listRole;

URL

/role

Method

GET

Request

名称	类型	必选	简介	Mock初始值
filter_value	String	否	不支持模糊匹配	operator
filter_type	String	否		name
page	String	否		1
limit	String	否		10

Response

名称	类型	必选	Mock初始值	Mock规则
ret	Number	否	200
msg	String	否
data	Object	否
code	Number	否	0
message	String	否
roles	Array	否		5
id	String	否	3
name	String	否	@name
is_system	String	否	1
allow_new_user	String	否	1
display_name	String	否	Business Administrator
description	String	否	Admin User
dynamic_perms	String	否	0
total	Number	否	6

------ 配置备份 ------

URL

/dash/cc_bak

Method

GET

Request

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

Response

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

npsvr列表

SDK方法名：listNpsvr;

URL

/cc/npsvr_list

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
page	Number		页数	1
limit	Number		条数	10

Response

名称	类型	简介	Mock初始值
ret	Number		200
msg	String
data	Object
code	Number		0
message	String
total	Number		1
info_list	Array
config_addr	String	管理地址	affdsfsafs
npsvr_uuid	String	uuid	adsfsafdsf
version	String	版本	dsgfadf

npsvr获取单个

SDK方法名：describeNpsvr

URL

/cc/npsvr

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
npsvr_uuid	String		npsvr_uuid	9C865EB7-6999-65D6-C029-0615735C137E

Response

名称	类型	简介	Mock初始值
ret	Number		200
msg	String
data	Object
code	Number		0
message	String		[0] 操作成功。
npsvr	Object
npsvr_uuid	String	npsvr_uuid	9C865EB7-6999-65D6-C029-0615735C137E
config_addr	String	npsvr管理地址	172.20.74.65
config_port	Number	npsvr管理端口	26823
version	String	npsvr版本号	7.1.69.20111209
bkup_switch	String	是否开启定时备份： 0，否；1，是	0
policy	Object	备份策略
limit	Number	保留数	30
bkup_type	Number	0：每隔；1：每天	0
time	String	每隔几小时；每天的几点	24
random_str	String	随机字符串	9C865EB7-6999-65D6-C029-0615735C137E

npsvr修改

SDK方法名：modifyNpsvr

URL

/cc/npsvr

Method

PUT

Request

名称	类型	Mock初始值
npsvr_uuid	String	9C865EB7-6999-65D6-C029-0615735C137E
bkup_switch	String	0
policy	Object
limit	String	30
bkup_type	String	0
time	String	24
random_str	String	9C865EB7-6999-65D6-C029-0615735C137E

Response

名称	类型	Mock初始值
ret	Number	200
msg	String
data	Object
code	Number	0
message	String	[0] 操作成功。

npsvr删除

SDK方法名：deleteNpsvr;

URL

/cc/npsvr

Method

DELETE

Request

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

Response

名称	类型	Mock初始值
ret	Number	200
msg	String
data	Object
code	Number	0
message	String	[0] 操作成功。

npsvr状态

获取备份规则的状态

SDK方法名：listNpsvrStatus

URL

/cc/npsvr_status

Method

GET

Request

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

Response

名称	类型	简介	Mock初始值
msg	String
data	Object
count	String		1
message	String
code	Number		0
status	Array
npsvr_uuid	String	uuid
version	String	版本号
status	String
ret	Number		200

npsvr 备份历史列表

SDK方法名：listNpsvrBakList;

URL

/cc/npsvr_bak_list

Method

GET

Request

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

Response

名称	类型	简介	Mock初始值
ret	Number		200
msg	String
data	Object
code	Number		0
message	String
total	Number		1
info_list	Array
id	String
bak_file	String	备份文件名称
npsvr_uuid	String	npsvr_uuid
create_time	String	备份时间
version	String	备份时的版本号

npsvr 备份历史操作

SDK方法名：

启动：npsvrBakRecovery;

停止：npsvrBakDelete;

URL

/cc/npsvr_operate

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
id	String		备份记录主键id
operate	String		删除：delete；恢复：recovery;

Response

名称	类型	Mock初始值
ret	Number	200
msg	String
data	Object
code	Number	0
message	String	[0] 操作成功。

配置备份 - 列表

SDK方法名：listBakConfig;

URL

/cc/bak_config_list

Method

GET

Request

名称	类型	简介	Mock初始值
page	Number	页数	1
limit	Number	条数	10
obj_type	String	备份配置的类型	dto

Response

名称	类型	简介	Mock初始值
ret	Number		200
msg	String
data	Object
code	Number		0
message	String
total	Number		1
info_list	Array
obj_uuid	String	uuid	fdsafsafd
version	String	版本	zsdfszcxz
config_addr	String	管理地址	小程序cxx

配置备份 - 单个

SDK方法名：describeBakConfig;

URL

/cc/bak_config

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
obj_uuid	String		备份配置UUID

Response

名称	类型	简介	Mock初始值
ret	Number		200
msg	String
data	Object
code	Number		0
message	String		[0] 操作成功。
bak_config	Object
obj_uuid	String	备份配置uuid	9C865EB7-6999-65D6-C029-0615735C137E
obj_type	String	备份配置类型	dto
config_addr	String	管理地址	172.20.74.65
config_port	Number	端口	26823
version	String	版本	7.1.69.20111209
bkup_switch	Number	是否开启定时备份：0-否 1-是	0
policy	Object	备份策略
limit	Number	保留数	30
bkup_type	Number	0-每隔 1-每天	0
time	Number	每隔几个小时或每天的几点	24
random_str	String	随机字符串	9C865EB7-6999-65D6-C029-0615735C137E

配置备份 - 修改

SDK方法名：modifyBakConfig;

URL

/cc/bak_config

Method

PUT

Request

名称	类型	Mock初始值
obj_uuid	String	9C865EB7-6999-65D6-C029-0615735C137E
bkup_switch	String	0
policy	Object
limit	Number	30
bkup_type	Number	0
time	Number	24
random_str	String	9C865EB7-6999-65D6-C029-0615735C137E

Response

名称	类型	Mock初始值
ret	Number	200
msg	String
data	Object
code	Number	0
message	String	[0] 操作成功。

配置备份 - 删除

SDK方法名：deleteBakConfig;

URL

/cc/bak_config

Method

DELETE

Request

名称	类型	必选	简介	Mock初始值	Mock规则
obj_uuid	String		备份配置uuid

Response

名称	类型	Mock初始值
ret	Number	200
msg	String
data	Object
code	Number	0
message	String	[0] 操作成功。

配置备份 - 状态

SDK方法名：listBakConfigStatus;

URL

/cc/bak_config_status

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
obj_uuids	Array		备份配置uuid

Response

名称	类型	Mock初始值
msg	String
data	Object
count	String	1
message	String
code	Number	0
status	Array
status	String
version	String
obj_uuid	String
ret	Number	200

配置备份 - 获取备份历史列表

SDK方法名：listBakHistory;

URL

/cc/bak_history_list

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
obj_uuid	String		备份配置uuid

Response

名称	类型	Mock初始值
ret	Number	200
msg	String
data	Object
code	Number	0
message	String
total	Number	1
info_list	Array
id	String
bak_file	String
obj_uuid	String
create_time	String
version	String

配置备份 - 备份历史操作

SDK方法名：

恢复：recoveryBakConfigInfo;

删除：deleteBakConfigInfo;

URL

/cc/bak_history_operate

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
id	Number
operate	String		删除：delete；恢复：recovery;

Response

名称	类型	Mock初始值
ret	Number	200
msg	String
data	Object
code	Number	0
message	String	[0] 操作成功。

上传音频文件

SDK方法名：uploadDownloadCustomAudio;

URL

/sys/settings/custom_audio

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
custom_audio	Object		音频

Response

名称	类型	Mock初始值
msg	String
ret	Number	200
data	Object
message	String
code	Number	0

下载音频文件

SDK方法名：downloadCustomAudio;

URL

/sys/settings/custom_audio

Method

GET

Request

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

Response

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

etcd有效性检查

SDK方法名：chkEtcdUrl;

URL

/sys/settings/etcd_url_chk

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
etcd_url_uuid	String		etcd_url uuid

Response

名称	类型	简介	Mock初始值
msg	String
data	Object
code	Number	0表示有效，非0表示无效	0
message	String
ret	Number		200

系统管理

# 系统管理

# ----- 系统设置 -----

# URL

# Method

# Request

# Response

# 系统设置-更新配置

# URL

# Method

# Request

# Response

# 系统设置-获取配置

# URL

# Method

# Request

# Response

# 系统设置-获取公开配置

# URL

# Method

# Request

# Response

# 系统设置-控制台主机IP

# URL

# Method

# Request

# Response

# ----- 用户管理 -----

# URL

# Method

# Request

# Response

# 用户管理(admin)-新增用户

# URL

# Method

# Request

# Response

# 用户管理(admin)-用户列表(admin)

# URL

# Method

# Request

# Response

# 用户管理(admin)-获取用户

# URL

# Method

# Request

# Response

# 用户管理(admin)-删除账户

# URL

# Method

# Request

# Response

# 用户管理(admin)-修改用户信息

# URL

# Method

# Request

# Response

# 用户管理 - 解除用户登录锁定

# URL

# Method

# Request

# Response

# ----- Profile -----

# URL

# Method

# Request

# Response

# 用户Profile(all user)-修改密码

# URL

# Method

# Request

# Response

# 用户Profile(all user)-获取用户Profile

# URL

# Method

# Request

# Response

# 用户Profile(all user)-修改Profile

# URL

# Method

系统管理

----- 系统设置 -----

URL

Method

Request

Response

系统设置-更新配置

URL

Method

Request

Response

系统设置-获取配置

URL

Method

Request

Response

系统设置-获取公开配置

URL

Method

Request

Response

系统设置-控制台主机IP

URL

Method

Request

Response

----- 用户管理 -----

URL

Method

Request

Response

用户管理(admin)-新增用户

URL

Method

Request

Response

用户管理(admin)-用户列表(admin)

URL

Method

Request

Response

用户管理(admin)-获取用户

URL

Method

Request

Response

用户管理(admin)-删除账户

URL

Method

Request

Response

用户管理(admin)-修改用户信息

URL

Method

Request

Response

用户管理 - 解除用户登录锁定

URL

Method

Request

Response

----- Profile -----

URL

Method

Request

Response

用户Profile(all user)-修改密码

URL

Method

Request

Response

用户Profile(all user)-获取用户Profile

URL

Method

Request

Response

用户Profile(all user)-修改Profile

URL

Method

Request