产品管理
产品列表
版本: v1
接口信息
- 请求方式:
GET - 请求地址:
/console/v1/host
请求参数
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| keywords | string | 否 | - | 关键字,搜索范围:产品ID,商品名称,标识 |
| status | string | 否 | - | 状态Unpaid未付款Pending开通中Active已开通Suspended已暂停Deleted已删除 |
| tab | string | 否 | - | 状态using使用中expiring即将到期overdue已逾期deleted已删除 |
| page | int | 否 | - | 页数 |
| limit | int | 否 | - | 每页条数 |
| orderby | string | 否 | - | 排序 |
| sort | string | 否 | - | 升/降序 |
返回参数
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| list | array | 否 | - | 产品 |
| list[].id | int | 否 | - | 产品ID |
| list[].product_id | int | 否 | - | 商品ID |
| list[].product_name | string | 否 | - | 商品名称 |
| list[].name | string | 否 | - | 标识 |
| list[].active_time | int | 否 | - | 开通时间 |
| list[].due_time | int | 否 | - | 到期时间 |
| list[].first_payment_amount | string | 否 | - | 金额 |
| list[].billing_cycle | string | 否 | - | 周期 |
| list[].status | string | 否 | - | 状态Unpaid未付款Pending开通中Active已开通Suspended已暂停Deleted已删除 |
| list[].renew_amount | string | 否 | - | 续费金额 |
| list[].client_notes | string | 否 | - | 用户备注 |
| list[].ip_num | int | 否 | - | 金额 |
| count | int | 否 | - | 产品总数 |
会员中心已订购产品列表
版本: v1
接口信息
- 请求方式:
GET - 请求地址:
/console/v1/client/host
请求参数
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| keywords | string | 否 | - | 关键字搜索:商品名称/产品名称/IP |
| status | string | 否 | - | 产品状态(Unpaid=未付款,Pending=开通中,Active=已开通,Suspended=已暂停,Deleted=已删除) |
| tab | string | 否 | - | 状态using使用中expiring即将到期overdue已逾期deleted已删除 |
| page | int | 否 | - | 页数 |
| limit | int | 否 | - | 每页条数 |
返回参数
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| list | array | 否 | - | 产品 |
| list[].id | int | 否 | - | 产品ID |
| list[].product_id | int | 否 | - | 商品ID |
| list[].product_name | string | 否 | - | 商品名称 |
| list[].name | string | 否 | - | 标识 |
| list[].create_time | int | 否 | - | 订购时间 |
| list[].due_time | int | 否 | - | 到期时间 |
| list[].status | string | 否 | - | 状态Unpaid未付款Pending开通中Active已开通Suspended已暂停Deleted已删除Failed开通失败 |
| list[].client_notes | string | 否 | - | 用户备注 |
| list[].type | string | 否 | - | 类型 |
| list[].ip | string | 否 | - | IP |
| count | int | 否 | - | 产品总数 |
| using_count | int | 否 | - | 使用中产品数量 |
| expiring_count | int | 否 | - | 即将到期产品数量 |
| overdue_count | int | 否 | - | 已逾期产品数量 |
| deleted_count | int | 否 | - | 已删除产品数量 |
| all_count | int | 否 | - | 全部产品数量 |
自定义导航产品列表
版本: v1
接口信息
- 请求方式:
GET - 请求地址:
/console/v1/menu/:id/host
请求参数
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| id | int | 否 | - | 导航ID |
返回参数
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| data.content | string | 否 | - | 模块输出内容 |
产品详情
版本: v1
接口信息
- 请求方式:
GET - 请求地址:
/console/v1/host/:id
请求参数
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| id | int | 是 | - | 产品ID |
返回参数
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| host | object | 否 | - | 产品 |
| host.id | int | 否 | - | 产品ID |
| host.order_id | int | 否 | - | 订单ID |
| host.product_id | int | 否 | - | 商品ID |
| host.name | string | 否 | - | 标识 |
| notes | string | 否 | - | 备注 |
| host.first_payment_amount | string | 否 | - | 订购金额 |
| host.renew_amount | string | 否 | - | 续费金额 |
| host.billing_cycle | string | 否 | - | 计费周期 |
| host.billing_cycle_name | string | 否 | - | 模块计费周期名称 |
| host.billing_cycle_time | string | 否 | - | 模块计费周期时间,秒 |
| host.active_time | int | 否 | - | 开通时间 |
| host.due_time | int | 否 | - | 到期时间 |
| host.status | string | 否 | - | 状态Unpaid未付款Pending开通中Active已开通Suspended已暂停Deleted已删除Failed开通失败 |
| host.suspend_type | string | 否 | - | 暂停类型,overdue到期暂停,overtraffic超流暂停,certification_not_complete实名未完成,other其他 |
| host.suspend_reason | string | 否 | - | 暂停原因 |
| host.ratio_renew | int | 否 | - | 是否开启比例续费:0否,1是 |
| host.base_price | string | 否 | - | 购买周期原价 |
| host.product_name | string | 否 | - | 商品名称 |
| host.agent | int | 否 | - | 代理产品0否1是 |
| host.upstream_host_id | string | 否 | - | 上游产品ID |
| host.base_info | string | 否 | - | 产品基础信息 |
| host.auto_release_time | int | 否 | - | 自动释放时间(0=未设置过) |
| host.keep_time_price | string | 否 | - | 保留期价格 |
| host.on_demand_flow_price | string | 否 | - | 按需流量价格 |
| host.on_demand_billing_cycle_unit | string | 否 | - | 出账周期单位(hour=每小时,day=每天,month=每月) |
| host.on_demand_billing_cycle_day | int | 否 | - | 出账周期号数 |
| host.on_demand_billing_cycle_point | string | 否 | - | 出账周期时间点(如00:00) |
| host.change_billing_cycle_id | int | 否 | - | 是否申请了到期转按需(0=否,>0是,申请了不能执行续费/升降级操作) |
| host.addition.country_id | int | 否 | - | 国家ID |
| host.addition.city | string | 否 | - | 城市 |
| host.addition.area | string | 否 | - | 区域 |
| host.addition.image_icon | string | 否 | - | 镜像图标(Windows,CentOS,Ubuntu,Debian,ESXi,XenServer,FreeBSD,Fedora,ArchLinux,Rocky,AlmaLinux,OpenEuler,RedHat,其他) |
| host.addition.image_name | string | 否 | - | 镜像名称 |
| host.addition.username | string | 否 | - | 实例用户名 |
| host.addition.password | string | 否 | - | 实例密码 |
| host.addition.port | int | 否 | - | 端口 |
| host.product_on_demand.client_auto_delete | int | 否 | - | 允许用户设置自动释放(0=否,1=是) |
| host.product_on_demand.on_demand_to_duration | int | 否 | - | 允许按需转包年包月(0=否,1=是) |
| host.product_on_demand.duration_to_on_demand | int | 否 | - | 允许包年包月/试用转按需(0=否,1=是) |
| self_defined_field[].id | int | 否 | - | 自定义字段ID |
| self_defined_field[].field_name | string | 否 | - | 字段名称 |
| self_defined_field[].field_type | string | 否 | - | 字段类型(text=文本框,link=链接,password=密码,dropdown=下拉,checkbox=勾选框,textarea=文本区) |
| self_defined_field[].value | string | 否 | - | 当前值 |
获取产品内页
版本: v1
接口信息
- 请求方式:
GET - 请求地址:
/console/v1/host/:id/view
请求参数
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| id | int | 是 | - | 产品ID |
返回参数
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| content | string | 否 | - | 模块输出内容 |
修改产品备注
版本: v1
接口信息
- 请求方式:
put - 请求地址:
/console/v1/host/:id/notes
请求参数
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| id | int | 是 | - | 产品ID |
| notes | string | 否 | - | 备注 |
获取用户所有产品
版本: v1
接口信息
- 请求方式:
GET - 请求地址:
/console/v1/host/all
返回参数
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| list | array | 否 | - | 产品 |
| list[].id | int | 否 | - | 产品ID |
| list[].product_id | int | 否 | - | 商品ID |
| list[].product_name | string | 否 | - | 商品名称 |
| list[].name | string | 否 | - | 标识 |
| list[].status | string | 否 | - | 状态Unpaid未付款Pending开通中Active已开通Suspended已暂停Deleted已删除Failed开通失败Cancelled已取消 |
| count | int | 否 | - | 产品总数 |
模块暂停
版本: v1
接口信息
- 请求方式:
POST - 请求地址:
/console/v1/host/:id/module/suspend
请求参数
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| id | int | 是 | - | 产品ID |
| suspend_type | string | 是 | - | 暂停类型(overdue=到期暂停,overtraffic=超流暂停,certification_not_complete=实名未完成,other=其他) |
| suspend_reason | string | 否 | - | 暂停原因 |
模块解除暂停
版本: v1
接口信息
- 请求方式:
POST - 请求地址:
/console/v1/host/:id/module/unsuspend
请求参数
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| id | int | 是 | - | 产品ID |
产品IP详情
产品IP详情
作者: hh
版本: v1
接口信息
- 请求方式:
GET - 请求地址:
/console/v1/host/:id/ip
请求参数
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| id | int | 是 | - | 产品ID |
返回参数
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| dedicate_ip | string | 否 | - | 主IP |
| assign_ip | string | 否 | - | 附加IP(英文逗号分隔) |
| ip_num | int | 否 | - | IP数量 |
获取产品具体信息
获取产品具体信息,目前用于续费开关
更新时间: 2024-12-09
版本: v1
接口信息
- 请求方式:
GET - 请求地址:
/console/v1/host/:id/specific_info
请求参数
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| id | int | 否 | - | 产品ID |
返回参数
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| id | int | 否 | - | 产品ID |
| name | string | 否 | - | 产品标识 |
| renew_amount | string | 否 | - | 续费金额 |
| billing_cycle_name | string | 否 | - | 模块计费周期名称 |
| due_time | int | 否 | - | 到期时间 |
| ip_num | int | 否 | - | IP数量 |
| dedicate_ip | string | 否 | - | 主IP |
| assign_ip | string | 否 | - | 附加IP(英文逗号分隔) |
| country | string | 否 | - | 国家 |
| country_code | string | 否 | - | 国家代码 |
| country_id | int | 否 | - | 国家ID |
| city | string | 否 | - | 城市 |
| area | string | 否 | - | 区域 |
修改自动释放时间
版本: v1
接口信息
- 请求方式:
PUT - 请求地址:
/console/v1/host/:id/auto_release_time
请求参数
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| id | int | 是 | - | 产品ID |
| auto_release_time | int | 是 | - | 自动释放时间戳 |
获取产品按需转包年包月周期价格
版本: v1
接口信息
- 请求方式:
GET - 请求地址:
/console/v1/host/:id/on_demand_to_recurring_prepayment
请求参数
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| id | int | 是 | - | 产品ID |
返回参数
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| duration[].id | int | 否 | - | 周期ID |
| duration[].price | string | 否 | - | 周期价格 |
| duration[].name_show | string | 否 | - | 周期显示名称 |
产品按需转包年包月
版本: v1
接口信息
- 请求方式:
POST - 请求地址:
/console/v1/host/:id/on_demand_to_recurring_prepayment
请求参数
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| id | int | 是 | - | 产品ID |
| duration_id | int | 是 | - | 周期ID |
返回参数
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| id | string | 否 | - | 订单ID |
| amount | string | 否 | - | 金额 |
获取产品包年包月转按需价格
版本: v1
接口信息
- 请求方式:
GET - 请求地址:
/console/v1/host/:id/recurring_prepayment_to_on_demand
请求参数
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| id | int | 是 | - | 产品ID |
返回参数
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| on_demand_price | string | 否 | - | 按需出账价格,可能已经折扣了 |
| base_renew_price | string | 否 | - | 按需出账原价 |
| keep_time_price | string | 否 | - | 保留期价格 |
| billing_cycle_name | string | 否 | - | 周期名称 |
产品包年包月转按需
版本: v1
接口信息
- 请求方式:
POST - 请求地址:
/console/v1/host/:id/recurring_prepayment_to_on_demand
请求参数
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| id | int | 是 | - | 产品ID |
取消产品包年包月转按需
版本: v1
接口信息
- 请求方式:
DELETE - 请求地址:
/console/v1/host/:id/recurring_prepayment_to_on_demand
请求参数
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| id | int | 是 | - | 产品ID |