智简魔方文档

GET 产品列表

接口概览

项目内容
文档类型后台接口
请求方式GET
接口地址/DIR_ADMIN/v1/upstream/host
所属业务上下游
来源模块/系统上下游产品
认证方式Bearer Token(管理员令牌)

完整请求

请求

bash
正在加载示例…

失败请求

bash
正在加载示例…

接口说明

产品列表

请求参数

名称位置类型必选说明
keywordsquerystring否关键字 搜索范围:ID 用户名称 邮箱 手机号 商品名称 产品标识
supplier_idqueryinteger(int32)否供应商 ID
billing_cyclequerystring否付款周期
statusquerystring否状态 Unpaid未付款 Pending开通中 Active已开通 Suspended已暂停 Deleted已删除 Failed开通失败
start_timequeryinteger(int32)否开始时间
end_timequeryinteger(int32)否结束时间
pagequeryinteger(int32)否页数
limitqueryinteger(int32)否每页条数
orderbyquerystring否排序 id
sortquerystring否升/降序 asc desc

成功响应

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[].product_namestring否—商品名称
data.list[].statusstring否—状态 Unpaid未付款 Pending开通中 Active已开通 Suspended已暂停 Deleted已删除 Failed开通失败
data.list[].first_payment_amountstring否—金额
data.list[].renew_amountstring否—续费金额
data.list[].billing_cyclestring否—周期
data.list[].due_timestring | integer(int32)否—到期时间
data.list[].client_idstring | integer(int32)否—用户 ID
data.list[].usernamestring否—用户名
data.list[].companystring否—公司
data.list[].emailstring否—邮箱
data.list[].phone_codestring | integer(int32)否—国际电话区号
data.list[].phonestring否—手机号
data.list[].ip_numinteger(int32)否—IP 数量
data.list[].base_infostring否—产品基础信息
data.countinteger(int32)否—产品总数

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

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