获取配置列表 - Admin.Config.GetList - APIUSB

接口地址：https://api.apiusb.com/api/admin?s=Admin.Config.GetList

接口描述：获取配置列表，同时支持搜索功能。

HTTP/HTTPS

请求协议

GET/POST

请求方式

UTF-8

编码格式

JSON

返回格式

接口参数

参数名字	类型	是否必须	默认值	其他	说明
access_token	字符串	可选			访问令牌，仅当开启签名验证时需要传递，生成令牌可使用App.Auth.ApplyToken接口
config_name	字符串	可选	-	最大：500	待搜索的配置名称，精确匹配
config_desc	字符串	可选	-		待搜索的配置描述说明，模糊匹配
page	整型	可选	1	最小：1	第几页
perpage	整型	可选	10	最小：1；最大：5000	分页数量

返回字段

返回结果	类型	说明
ret	整型	状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务器错误
data	对象或混合类型	业务数据，由各自接口指定，通常为对象
data.total	整型	总数
data.items[].id	整型	ID
data.items[].config_name	字符串	配置名称
data.items[].config_desc	字符串	配置描述
data.items[].config_value	字符串	配置值
data.items[].add_time	字符串	添加时间
msg	字符串	提示信息，失败时的错误提示

在线测试

参数	是否必须	值
service	必须
access_token	可选
config_name	可选
config_desc	可选
page	可选
perpage	可选

客户端请求示例

{
    "ret": 200,
    "data": {
        "total": 2,
        "items": [
            {
                "id": 3,
                "config_name": "config_year2",
                "config_desc": "测试配置2",
                "config_value": "202022",
                "add_time": "2020-01-18 14:49:24"
            },
            {
                "id": 2,
                "config_name": "config_year",
                "config_desc": "测试配置",
                "config_value": "2020",
                "add_time": "2020-01-18 14:49:18"
            }
        ],
        "page": 1,
        "perpage": 3
    },
    "msg": ""
}

错误列表

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

本文档生成时间：2024-04-26 05:08:23