智简魔方文档

GET 产品列表

接口概览

项目内容
文档类型前台接口
请求方式GET
接口地址/console/v1/remf_finance_common
所属业务模块
来源模块/系统V10代理魔方财务通用商品
认证方式Bearer Token(用户令牌)

完整请求

请求

bash
正在加载示例…

失败请求

bash
正在加载示例…

接口说明

产品列表

请求参数

名称位置类型必选说明
pagequeryinteger(int32)页数
limitqueryinteger(int32)每页条数
orderbyquerystring排序(id,due_time,status)
sortquerystring升/降序
keywordsquerystring关键字搜索,搜索套餐名称/主机名/IP
statusquerystring产品状态(Unpaid=未付款,Pending=开通中,Active=已开通,Suspended=已暂停,Deleted=已删除)
tabquerystring状态using使用中expiring即将到期overdue已逾期deleted已删除
mqueryinteger(int32)菜单ID

成功响应

json
正在加载示例…

失败响应 400:请求参数或业务校验失败

json
正在加载示例…

失败响应 401:未认证或登录已失效

json
正在加载示例…

失败响应 403:无权执行当前操作

json
正在加载示例…

失败响应 404:接口或业务资源不存在

json
正在加载示例…

失败响应 500:服务器内部错误

json
正在加载示例…

响应状态

状态码状态码含义说明数据模型
200OK成功响应内联对象
400Bad Request请求参数或业务校验失败内联对象
401Unauthorized未认证或登录已失效内联对象
403Forbidden无权执行当前操作内联对象
404Not Found接口或业务资源不存在内联对象
500Internal Server Error服务器内部错误内联对象

响应参数

状态码 200

名称类型必选约束中文名说明
statusinteger(int32)状态码
msgstring提示信息
dataobject
data.list[object]
data.list[].idinteger(int32)产品ID
data.list[].namestring产品标识
data.list[].statusstring产品状态(Unpaid=未付款,Pending=开通中,Active=已开通,Suspended=已暂停,Deleted=已删除)
data.list[].due_timeinteger(int32)到期时间
data.list[].active_timeinteger(int32)开通时间
data.list[].product_namestring商品名称
data.list[].is_auto_renewinteger(int32)是否自动续费(0=否,1=是)
data.countinteger(int32)总条数
data.using_countinteger(int32)使用中产品数量
data.expiring_countinteger(int32)即将到期产品数量
data.overdue_countinteger(int32)已逾期产品数量
data.deleted_countinteger(int32)已删除产品数量
data.all_countinteger(int32)全部产品数量
data.self_defined_field[object]
data.self_defined_field[].idinteger(int32)自定义字段ID
data.self_defined_field[].field_namestring自定义字段名称
data.self_defined_field[].field_typestring字段类型(text=文本框,link=链接,password=密码,dropdown=下拉,tickbox=勾选框,textarea=文本区)

失败状态码 400、401、403、404、500 共用以下结构:

名称类型必选约束中文名说明
statusinteger(int32)错误状态码
msgstring错误提示