GET 产品列表
接口概览
| 项目 | 内容 |
|---|---|
| 文档类型 | 前台接口 |
| 请求方式 | GET |
| 接口地址 | /console/v1/idcsmart_common/host |
| 所属业务 | 模块 |
| 来源模块/系统 | 通用商品 |
| 认证方式 | Bearer Token（用户令牌） |
完整请求
请求
正在加载示例…失败请求
正在加载示例…接口说明
产品列表
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| m | query | integer(int32) | 否 | 菜单ID |
| client_id | query | integer(int32) | 否 | 客户ID |
| keywords | query | string | 否 | 关键字,搜索范围:产品ID,商品名称,标识 |
| status | query | string | 否 | 状态Unpaid未付款Pending开通中Active已开通Suspended已暂停Deleted已删除Failed开通失败 |
| tab | query | string | 否 | 状态using使用中expiring即将到期overdue已逾期deleted已删除 |
| page | query | integer(int32) | 否 | 页数 |
| limit | query | integer(int32) | 否 | 每页条数 |
| orderby | query | string | 否 | 排序 id,active_time,due_time |
| sort | query | string | 否 | 升/降序 asc,desc |
成功响应
正在加载示例…失败响应 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[].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 | 否 | — | — | 周期 |
| data.list[].status | string | 否 | — | — | 状态Unpaid未付款Pending开通中Active已开通Suspended已暂停Deleted已删除Failed开通失败 |
| data.list[].self_defined_field | object | 否 | — | — | 产品自定义字段，格式{"自定义字段ID":"値"} |
| data.list[].is_auto_renew | integer(int32) | 否 | — | — | 是否自动续费(0=否,1=是) |
| data.count | integer(int32) | 否 | — | — | 产品总数 |
| data.using_count | integer(int32) | 否 | — | — | 使用中产品数量 |
| data.expiring_count | integer(int32) | 否 | — | — | 即将到期产品数量 |
| data.overdue_count | integer(int32) | 否 | — | — | 已逾期产品数量 |
| data.deleted_count | integer(int32) | 否 | — | — | 已删除产品数量 |
| data.all_count | integer(int32) | 否 | — | — | 全部产品数量 |
| data.self_defined_field | [任意类型] | 否 | — | — | — |
失败状态码 400、401、403、404、500 共用以下结构：
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| status | integer(int32) | 是 | — | — | 错误状态码 |
| msg | string | 是 | — | — | 错误提示 |