果果云 / 后台接口 / 获取配置列表

获取配置列表

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

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": ""
}

错误列表

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

本文档生成时间:2020-07-02 19:41:00