APIUSB / 后台接口 / 修改配置

修改配置

接口描述: 以最新的配置覆盖原来的配置。

HTTP/HTTPS
请求协议
GET/POST
请求方式
UTF-8
编码格式
JSON
返回格式

接口参数

参数名字类型是否必须默认值其他说明
access_token字符串可选访问令牌,仅当开启签名验证时需要传递,生成令牌可使用App.Auth.ApplyToken接口
config_name字符串必须-最大:500配置名称,如:config_switch
config_value字符串必须-待更新的配置值,可以是数字、字符串、文本等
config_desc字符串可选配置描述说明,不为空时进行更新

返回字段

返回结果类型说明
ret整型状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务器错误
data对象或混合类型业务数据,由各自接口指定,通常为对象
data.is_edit布尔型是否更新成功,true为更新成功,false无更新,或配置不存在
msg字符串提示信息,失败时的错误提示

在线测试   

参数是否必须
service 必须
access_token 可选
config_name 必须
config_value 必须
config_desc 可选

客户端请求示例

# 暂无示例,可添加示例文件:./src/view/docs/demos/Admin.Config.EditConfig.json

错误列表

错误状态码错误描述信息
400ret=400,客户端参数错误或非法请求
404表示接口服务不存在
406ret=406,access_token令牌校验不通过
407ret=407,app_key权限不足,或未知应用
408ret=408,当前用户禁止使用,或用户未登录
500表示服务端内部错误

本文档生成时间:2024-04-27 03:28:09