GET 产品列表
接口概览
| 项目 | 内容 |
|---|---|
| 文档类型 | 后台接口 |
| 请求方式 | GET |
| 接口地址 | /DIR_ADMIN/v1/host |
| 所属业务 | 产品管理 |
| 来源模块/系统 | 产品管理 |
| 认证方式 | Bearer Token（管理员令牌） |
完整请求
请求
正在加载示例…失败请求
正在加载示例…接口说明
产品列表
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| keywords | query | string | 否 | 关键字 搜索范围:产品ID 商品名称 标识 用户名 邮箱 手机号 |
| billing_cycle | query | string | 否 | 付款周期 |
| client_id | query | integer(int32) | 否 | 用户ID |
| host_id | query | integer(int32) | 否 | 产品ID |
| status | query | string | 否 | 状态 Unpaid未付款 Pending开通中 Active已开通 Suspended已暂停 Deleted已删除 Failed开通失败 |
| due_time | query | string | 否 | 到期时间 today今天内 three最近三天 seven最近七天 month最近一个月 custom自定义 expired已到期 |
| start_time | query | integer(int32) | 否 | 开始时间 |
| end_time | query | integer(int32) | 否 | 结束时间 |
| product_id | query | integer(int32) | 否 | 商品ID |
| name | query | string | 否 | 标识 |
| username | query | string | 否 | 用户名 |
| query | string | 否 | 邮箱 | |
| phone | query | string | 否 | 手机号 |
| server_id | query | integer(int32) | 否 | 接口ID |
| first_payment_amount | query | string | 否 | 订购金额 |
| ip | query | string | 否 | IP |
| tab | query | string | 否 | 状态筛选 using使用中 expiring即将到期 overdue已逾期 deleted已删除 |
| view_id | query | integer(int32) | 否 | 视图ID |
| page | query | integer(int32) | 否 | 页数 |
| limit | query | integer(int32) | 否 | 每页条数 |
| orderby | query | string | 否 | 排序字段 id renew_amount due_time first_payment_amount active_time client_id reg_time |
| sort | query | string | 否 | 升降序 asc desc |
| module | query | string | 否 | 模块搜索 |
成功响应
正在加载示例…失败响应 400：请求参数或业务校验失败
正在加载示例…失败响应 401：未认证或登录已失效
正在加载示例…失败响应 403：无权执行当前操作
正在加载示例…失败响应 404：接口或业务资源不存在
正在加载示例…失败响应 500：服务器内部错误
正在加载示例…响应状态
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功响应 | 内联对象 |
| 400 | Bad Request | 请求参数或业务校验失败 | 内联对象 |
| 401 | Unauthorized | 未认证或登录已失效 | 内联对象 |
| 403 | Forbidden | 无权执行当前操作 | 内联对象 |
| 404 | Not Found | 接口或业务资源不存在 | 内联对象 |
| 500 | Internal Server Error | 服务器内部错误 | 内联对象 |
响应参数
状态码 200
| 名称 | 类型 | 必选 | 约束 | 说明 |
|---|---|---|---|---|
status | integer(int32) | 否 | — | 状态码 |
msg | string | 否 | — | 提示信息 |
data | object | 否 | — | — |
data.list | [object] | 否 | — | 产品列表 |
data.list[].id | integer(int32) | 否 | — | 产品ID |
data.list[].client_id | integer(int32) | 否 | — | 用户ID |
data.list[].client_name | integer(int32) | 否 | — | 用户名 |
data.list[].email | string | 否 | — | 邮箱 |
data.list[].phone_code | string | 否 | — | 国际电话区号 |
data.list[].phone | string | 否 | — | 手机号 |
data.list[].company | string | 否 | — | 公司 |
data.list[].product_id | integer(int32) | 否 | — | 商品ID |
data.list[].product_name | string | 否 | — | 商品名称 |
data.list[].name | string | 否 | — | 标识 |
data.list[].active_time | integer(int32) | 否 | — | 开通时间 |
data.list[].due_time | integer(int32) | 否 | — | 到期时间 |
data.list[].first_payment_amount | string | 否 | — | 金额 |
data.list[].billing_cycle | string | 否 | — | 计费方式 free免费 onetime一次 recurring_prepayment周期先付 recurring_postpaid周期后付 |
data.list[].billing_cycle_name | string | 否 | — | 周期 |
data.list[].status | string | 否 | — | 状态 Unpaid未付款 Pending开通中 Active已开通 Suspended已暂停 Deleted已删除 Failed开通失败 |
data.list[].renew_amount | string | 否 | — | 续费金额 |
data.list[].client_notes | string | 否 | — | 用户备注 |
data.list[].ip_num | integer(int32) | 否 | — | IP数量 |
data.list[].dedicate_ip | string | 否 | — | 主IP |
data.list[].assign_ip | string | 否 | — | 附加IP 英文逗号分隔 |
data.list[].server_name | string | 否 | — | 商品接口 |
data.list[].admin_notes | string | 否 | — | 管理员备注 |
data.list[].base_price | string | 否 | — | 当前周期原价 |
data.list[].client_status | integer(int32) | 否 | — | 用户是否启用 0禁用 1正常 |
data.list[].reg_time | integer(int32) | 否 | — | 用户注册时间 |
data.list[].country | string | 否 | — | 国家 |
data.list[].address | string | 否 | — | 地址 |
data.list[].language | string | 否 | — | 语言 |
data.list[].notes | string | 否 | — | 备注 |
data.list[].certification | boolean | 否 | — | 是否实名认识 true是 false否 显示字段有certification返回 |
data.list[].certification_type | string | 否 | — | 实名类型 person个人 company企业 显示字段有certification返回 |
data.list[].client_level | string | 否 | — | 用户等级 显示字段有client_level返回 |
data.list[].client_level_color | string | 否 | — | 用户等级颜色 显示字段有client_level返回 |
data.list[].sale | string | 否 | — | 销售 显示字段有sale返回 |
data.list[].addon_client_custom_field_[id] | string | 否 | — | 用户自定义字段 显示字段有addon_client_custom_field_[id]返回 [id]为用户自定义字段ID |
data.list[].self_defined_field_[id] | string | 否 | — | 商品自定义字段 显示字段有self_defined_field_[id]返回 [id]为商品自定义字段ID |
data.list[].base_info | string | 否 | — | 产品基础信息 |
data.count | integer(int32) | 否 | — | 产品总数 |
data.expiring_count | integer(int32) | 否 | — | 即将到期产品数量 |
data.total_renew_amount | string | 否 | — | 总续费金额 |
data.page_total_renew_amount | string | 否 | — | 当前页总续费金额 |
data.failed_action_count | integer(int32) | 否 | — | 手动处理产品数量 |
data.using_count | integer(int32) | 否 | — | — |
data.overdue_count | integer(int32) | 否 | — | — |
data.deleted_count | integer(int32) | 否 | — | — |
data.all_count | integer(int32) | 否 | — | — |
失败状态码 400、401、403、404、500 共用以下结构：
| 名称 | 类型 | 必选 | 约束 | 说明 |
|---|---|---|---|---|
status | integer(int32) | 是 | — | 错误状态码 |
msg | string | 是 | — | 错误提示 |