通用商品-商品配置信息(前台)

产品列表

项目	内容
接口描述	产品列表
接口地址	/console/v1/idcsmart_common/host
请求方式	GET
接口版本	v1

请求参数

name	type	default	validate	desc
m	int	-	validate:optional	desc:菜单ID
client_id	int	-	validate:optional	desc:客户ID
keywords	string	-	validate:optional	desc:关键字,搜索范围:产品ID,商品名称,标识
status	string	-	validate:optional	desc:状态Unpaid未付款Pending开通中Active已开通Suspended已暂停Deleted已删除Failed开通失败
tab	string	-	validate:optional	desc:状态using使用中expiring即将到期overdue已逾期deleted已删除
page	int	-	validate:optional	desc:页数
limit	int	-	validate:optional	desc:每页条数
orderby	string	-	id,active_time,due_timevalidate:optional	desc:排序
sort	string	-	asc,descvalidate:optional	desc:升/降序

响应参数

name	type	default	desc
list	array	-	desc:产品
list[].id	int	-	desc:产品ID
list[].product_id	int	-	desc:商品ID
list[].product_name	string	-	desc:商品名称
list[].name	string	-	desc:标识
list[].active_time	int	-	desc:开通时间
list[].due_time	int	-	desc:到期时间
list[].first_payment_amount	string	-	desc:金额
list[].billing_cycle	string	-	desc:周期
list[].status	string	-	desc:状态Unpaid未付款Pending开通中Active已开通Suspended已暂停Deleted已删除Failed开通失败
list[].self_defined_field	object	-	desc:产品自定义字段，格式
list[].is_auto_renew	int	-	desc:是否自动续费(0=否,1=是)
count	int	-	desc:产品总数
using_count	int	-	desc:使用中产品数量
expiring_count	int	-	desc:即将到期产品数量
overdue_count	int	-	desc:已逾期产品数量
deleted_count	int	-	desc:已删除产品数量
all_count	int	-	desc:全部产品数量

前台商品配置信息

项目	内容
接口描述	前台商品配置信息
接口地址	/console/v1/idcsmart_common/product/:product_id/configoption
请求方式	GET
接口版本	v1

请求参数

name	type	default	validate	desc
product_id	int	-	validate:required	desc:商品ID

响应参数

name	type	default	desc
common_product	object	-	desc:商品基础信息
common_product.name	string	-	desc:商品名称
common_product.order_page_description	string	-	desc:订购页面html
common_product.allow_qty	int	-	desc:是否允许选择数量:1是，0否默认
common_product.pay_type	string	-	desc:付款类型(免费free，一次onetime，周期先付recurring_prepayment,周期后付recurring_postpaid
configoptions	array	-	desc:配置项信息
configoptions[].id	int	-	desc:配置项ID
configoptions[].option_name	string	-	desc:配置项名称
configoptions[].option_type	string	-	desc:配置项类型：select下拉单选，multi_select下拉多选，radio点击单选，quantity数量输入，quantity_range数量拖动，yes_no是否，area区域，cascade级联
configoptions[].qty_min	int	-	desc:数量时最小值
configoptions[].qty_max	int	-	desc:数量时最大值
configoptions[].unit	string	-	desc:单位
configoptions[].allow_repeat	int	-	desc:数量类型时：是否允许重复:开启后,前台购买时，可通过点击添加按钮，自动创建一个新的配置项，取名如bw1
configoptions[].max_repeat	int	-	desc:最大允许重复数量
configoptions[].description	string	-	desc:说明
configoptions[].qty_change	int	-	desc:数量变化值
configoptions[].is_show	int	-	desc:是否展示配置项名称:1是，0否
configoptions[].subs	array	-	desc:子项信息
configoptions[].subs[].id	int	-	desc:子项ID
configoptions[].subs[].option_name	string	-	desc:子项名称
configoptions[].subs[].qty_min	int	-	desc:子项最小值
configoptions[].subs[].qty_max	int	-	desc:子项最大值
configoptions[].tree	array	-	desc:级联配置项的树形结构数据(仅当option_type为cascade时返回)
configoptions[].tree[].item_id	int	-	desc:级联项ID
configoptions[].tree[].item_name	string	-	desc:级联项名称
configoptions[].tree[].fee_type	string	-	desc:计费类型
configoptions[].tree[].group_id	int	-	desc:级联组ID
configoptions[].tree[].is_leaf	int	-	desc:是否为末端项:1是，0否
configoptions[].tree[].order	int	-	desc:排序
configoptions[].tree[].hidden	int	-	desc:是否隐藏:1是，0否
configoptions[].tree[].children	array	-	desc:子级联项(递归结构)
configoptions[].tree[].price	array	-	desc:价格信息(仅末端项有此字段)
configoptions[].cascade_group	array	-	desc:级联组信息(仅当option_type为cascade时返回)
configoptions[].cascade_group[].id	int	-	desc:级联组ID
configoptions[].cascade_group[].group_name	string	-	desc:级联组名称
cycles	object	-	desc:周期({"onetime":1.00})
custom_cycles	array	-	desc:自定义周期
custom_cycles[].id	int	-	desc:自定义周期ID
custom_cycles[].name	string	-	desc:自定义周期名称
custom_cycles[].cycle_time	int	-	desc:自定义周期时长
custom_cycles[].cycle_unit	string	-	desc:自定义周期单位
custom_cycles[].amount	float	-	desc:商品自定义周期金额
custom_cycles[].cycle_amount	float	-	desc:(商品+配置项)自定义周期金额
custom_cycles[].is_default	int	-	desc:是否默认:1是，0否

前台商品配置信息计算价格

项目	内容
接口描述	前台商品配置信息计算价格
接口地址	/console/v1/idcsmart_common/product/:product_id/configoption/calculate
请求方式	POST
接口版本	v1

请求参数

name	type	default	validate	desc
configoption	object	-	validate:required	desc:配置信息
cascade_configoption	object	-	validate:optional	desc:级联配置项信息{169:{item_id:12,quantity:2}}

响应参数

name	type	default	desc
cycles	object	-	desc:周期({"onetime":1.00})
custom_cycles	array	-	desc:自定义周期
custom_cycles[].id	int	-	desc:自定义周期ID
custom_cycles[].name	string	-	desc:自定义周期名称
custom_cycles[].cycle_time	int	-	desc:自定义周期时长
custom_cycles[].cycle_unit	string	-	desc:自定义周期单位
custom_cycles[].cycle_amount	float	-	desc:自定义周期金额
custom_cycles[].is_default	int	-	desc:是否默认:1是，0否

前台产品内页

项目	内容
接口描述	前台产品内页
接口地址	/console/v1/idcsmart_common/host/:host_id/configoption
请求方式	GET
接口版本	v1

请求参数

name	type	default	validate	desc
host_id	int	-	validate:required	desc:产品ID

响应参数

name	type	default	desc
host	object	-	desc:财务信息
host.create_time	int	-	desc:订购时间
host.due_time	int	-	desc:到期时间
host.billing_cycle	string	-	desc:计费方式
host.billing_cycle_name	string	-	desc:模块计费周期名称
host.billing_cycle_time	int	-	desc:模块计费周期时间,秒
host.renew_amount	float	-	desc:续费金额
host.first_payment_amount	float	-	desc:首付金额
host.dedicatedip	string	-	desc:独立ip
host.username	string	-	desc:用户名
host.password	string	-	desc:密码
host.os	string	-	desc:操作系统
host.assignedips	string	-	desc:分配ip，逗号分隔
host.bwlimit	int	-	desc:流量限制
host.bwusage	float	-	desc:流量使用
configoptions	array	-	desc:配置项信息
configoptions[].id	int	-	desc:配置项ID
configoptions[].option_name	string	-	desc:配置项名称
configoptions[].option_type	string	-	desc:配置项类型
configoptions[].unit	string	-	desc:单位
configoptions[].subs	array	-	desc:子项
configoptions[].subs[].option_name	string	-	desc:子项名称
configoptions[].qty	int	-	desc:数量(当类型为数量时,显示此值)
chart	array	-	desc:图表tab
chart[].title	string	-	desc:标题
chart[].type	string	-	desc:类型
chart[].select	array	-	desc:下拉选择
chart[].select[].name	string	-	desc:名称
chart[].select[].value	string	-	desc:值
client_area	array	-	desc:客户自定义tab区域
client_area[].key	string	-	desc:键
client_area[].name	string	-	desc:名称标题
client_button	array	-	desc:管理按钮区域
client_button.console	array	-	desc:控制台
client_button.console[].func	string	-	desc:模块
client_button.console[].name	string	-	desc:模块名称
client_button.console[].type	string	-	desc:类型
client_button.control	array	-	desc:下拉管理
client_button.control[].func	string	-	desc:模块
client_button.control[].name	string	-	desc:模块名称
client_button.control[].type	string	-	desc:类型
os	array	-	desc:操作系统
os[].id	int	-	desc:配置项ID
os[].option_name	string	-	desc:配置项名称
os[].option_type	string	-	desc:配置项类型
os[].subs	array	-	desc:子项
os[].subs[].os	string	-	desc:操作系统
os[].subs[].version	array	-	desc:操作系统详细版本
os[].subs[].version[].id	int	-	desc:子项ID
os[].subs[].version[].option_name	string	-	desc:名称

前台产品内页自定义页面输出

项目	内容
接口描述	前台产品内页自定义页面输出
接口地址	/console/v1/idcsmart_common/host/:host_id/configoption/area
请求方式	GET
接口版本	v1

请求参数

name	type	default	validate	desc
host_id	int	-	validate:required	desc:产品ID
key	string	-	validate:required	desc:snapshot快照等
api_url	string	-	validate:optional	desc:替换原来模板内的接口地址

响应参数

无

前台产品内页图表页面

项目	内容
接口描述	前台产品内页图表页面
接口地址	/console/v1/idcsmart_common/host/:host_id/configoption/chart
请求方式	GET
接口版本	v1

请求参数

name	type	default	validate	desc
host_id	int	-	validate:required	desc:产品ID
chart	array	-	validate:required	desc:图表数据
chart[].start	int	-	validate:required	desc:开始时间
chart[].type	string	-	validate:required	desc:类型：cpu/disk/flow
chart[].select	string	-	validate:required	desc:select的value值

响应参数

无

执行子模块方法

项目	内容
接口描述	执行子模块方法
接口地址	/console/v1/idcsmart_common/host/:host_id/provision/:func
请求方式	POST
接口版本	v1

请求参数

name	type	default	validate	desc
host_id	int	-	validate:required	desc:产品ID
func	string	-	validate:required	desc:模块方法:如on开机/off关机等

响应参数

无

执行子模块方法(解决操作密码不好统一处理的问题)

项目	内容
接口描述	执行子模块方法
接口地址	/console/v1/idcsmart_common/host/:host_id/provision/status
请求方式	POST
接口版本	v1

请求参数

name	type	default	validate	desc
host_id	int	-	validate:required	desc:产品ID
func	string	-	validate:required	desc:模块方法:如on开机/off关机等

响应参数

无

执行子模块自定义方法

项目	内容
接口描述	执行子模块自定义方法
接口地址	/console/v1/idcsmart_common/host/:host_id/custom/provision
请求方式	POST
接口版本	v1

请求参数

name	type	default	validate	desc
host_id	int	-	validate:required	desc:产品ID
func	string	-	validate:required	desc:模块方法:如on开机/off关机等
custom_fields	array	-	validate:optional	desc:自定义字段

响应参数

无

产品升降级页面

项目	内容
接口描述	产品升降级页面
接口地址	/console/v1/idcsmart_common/host/:host_id/upgrade
请求方式	GET
接口版本	v1

请求参数

name	type	default	validate	desc
host_id	int	-	validate:required	desc:产品ID

响应参数

name	type	default	desc
host	object	-	desc:产品信息
host.product_id	int	-	desc:商品ID
host.name	string	-	desc:名称
host.first_payment_amount	float	-	desc:金额
host.billing_cycle_name	string	-	desc:周期
configoptions	array	-	desc:配置
configoptions[].option_type	string	-	desc:配置类型
configoptions[].option_name	string	-	desc:名称
configoptions[].sub_name	string	-	desc:子项名称
configoptions[].qty	int	-	desc:数量(类型为数量时,显示此值)
configoptions[].configoption_sub_id	int	-	desc:子项ID
configoptions[].current_cascade_item_id	int	-	desc:当前选择的级联项ID(仅当option_type为cascade时返回)
son_host	array	-	desc:子产品
son_host[].id	int	-	desc:子产品ID
son_host[].name	string	-	desc:名称
son_host[].first_payment_amount	float	-	desc:金额
son_host[].billing_cycle_name	string	-	desc:周期
upgrade	array	-	desc:可升降级商品(参考购物车配置那块数据)

产品升降级异步获取升降级价格

项目	内容
接口描述	产品升降级异步获取升降级价格
接口地址	/console/v1/idcsmart_common/host/:host_id/sync_upgrade_price
请求方式	POST
接口版本	v1

请求参数

name	type	default	validate	desc
host_id	int	-	validate:required	desc:产品ID
configoption	object	-	validate:optional	desc:配置项信息
cascade_configoption	object	-	validate:optional	desc:级联配置项信息{"169":{"item_id":12,"quantity":2}}
cycle	string	-	validate:optional	desc:周期
product_id	int	-	validate:optional	desc:商品ID

响应参数

无

产品升降级

项目	内容
接口描述	产品升降级
接口地址	/console/v1/idcsmart_common/host/:host_id/upgrade
请求方式	POST
接口版本	v1

请求参数

name	type	default	validate	desc
host_id	int	-	validate:required	desc:产品ID
product_id	int	-	validate:required	desc:商品ID
config_options	object	-	validate:required	desc:与购物车结算的配置项信息:{"configoption":{"1"：2,"2":3,"4":[1,2,3]},"cascade_configoption":{"169":{"item_id":12,"quantity":2}},"cycle":"monthly","product_id":104,son:

响应参数

无

产品配置升降级页面

项目	内容
接口描述	产品配置升降级页面
接口地址	/console/v1/idcsmart_common/host/:host_id/upgrade_config
请求方式	GET
接口版本	v1

请求参数

name	type	default	validate	desc
host_id	int	-	validate:required	desc:产品ID

响应参数

name	type	default	desc
host	object	-	desc:产品信息
host.product_id	int	-	desc:商品ID
host.name	string	-	desc:名称
host.first_payment_amount	float	-	desc:金额
host.billing_cycle_name	string	-	desc:周期
configoptions	array	-	desc:配置
configoptions[].option_type	string	-	desc:配置类型
configoptions[].option_name	string	-	desc:名称
configoptions[].sub_name	string	-	desc:子项名称
configoptions[].qty	int	-	desc:数量(类型为数量时,显示此值)
son_host	array	-	desc:子产品
son_host[].id	int	-	desc:子产品ID
son_host[].name	string	-	desc:名称
son_host[].first_payment_amount	float	-	desc:金额
son_host[].billing_cycle_name	string	-	desc:周期
upgrade_configoptions	array	-	desc:可升降级配置项
upgrade_configoptions[].id	int	-	desc:配置项ID
upgrade_configoptions[].option_type	string	-	desc:配置项类型
upgrade_configoptions[].option_name	string	-	desc:配置项名称
upgrade_configoptions[].is_show	int	-	desc:是否展示配置项名称:1是，0否
upgrade_configoptions[].subs	array	-	desc:配置子项数据
upgrade_configoptions[].tree	array	-	desc:级联配置项的树形结构数据(仅当option_type为cascade时返回)
upgrade_configoptions[].tree[].item_id	int	-	desc:级联项ID
upgrade_configoptions[].tree[].item_name	string	-	desc:级联项名称
upgrade_configoptions[].tree[].fee_type	string	-	desc:计费类型
upgrade_configoptions[].tree[].group_id	int	-	desc:级联组ID
upgrade_configoptions[].tree[].is_leaf	int	-	desc:是否为末端项:1是，0否
upgrade_configoptions[].tree[].order	int	-	desc:排序
upgrade_configoptions[].tree[].hidden	int	-	desc:是否隐藏:1是，0否
upgrade_configoptions[].tree[].children	array	-	desc:子级联项(递归结构)
upgrade_configoptions[].tree[].price	array	-	desc:价格信息(仅末端项有此字段)
upgrade_configoptions[].cascade_group	array	-	desc:级联组信息(仅当option_type为cascade时返回)
upgrade_configoptions[].cascade_group[].id	int	-	desc:级联组ID
upgrade_configoptions[].cascade_group[].group_name	string	-	desc:级联组名称

产品配置升降级异步获取升降级价格

项目	内容
接口描述	产品配置升降级异步获取升降级价格
接口地址	/console/v1/idcsmart_common/host/:host_id/sync_upgrade_config_price
请求方式	POST
接口版本	v1

请求参数

name	type	default	validate	desc
host_id	int	-	validate:required	desc:产品ID
configoption	object	-	validate:optional	desc:配置项信息
cascade_configoption	object	-	validate:optional	desc:级联配置项信息{169:{item_id:12,quantity:2}}

响应参数

name	type	default	desc
data.price	string	-	desc:价格

产品配置升降级

项目	内容
接口描述	产品配置升降级
接口地址	/console/v1/idcsmart_common/host/:host_id/upgrade_config
请求方式	POST
接口版本	v1

请求参数

name	type	default	validate	desc
host_id	int	-	validate:required	desc:产品ID
configoption	object	-	validate:optional	desc:配置项信息
cascade_configoption	object	-	validate:optional	desc:级联配置项参数{"1":{"item_id":123,"quantity":2}}

响应参数

name	type	default	desc
id	int	-	desc:订单ID

日志

项目	内容
接口描述	日志
接口地址	/console/v1/idcsmart_common/:id/log
请求方式	GET
接口版本	v1

请求参数

name	type	default	validate	desc
id	int	-	validate:required	desc:产品ID
keywords	string	-	validate:optional	desc:关键字
page	int	-	validate:optional	desc:页数
limit	int	-	validate:optional	desc:每页条数
orderby	string	-	id,description,create_time,ipvalidate:optional	desc:排序
sort	string	-	asc,descvalidate:optional	desc:升/降序

响应参数

name	type	default	desc
list	array	-	desc:系统日志
list[].id	int	-	desc:系统日志ID
list[].description	string	-	desc:描述
list[].create_time	string	-	desc:时间
list[].ip	string	-	desc:IP
count	int	-	desc:系统日志总数

批量操作

项目	内容
接口描述	批量操作
接口地址	/console/v1/idcsmart_common/batch_operate
请求方式	POST
接口版本	v1

请求参数

name	type	default	validate	desc
id	array	-	validate:required	desc:产品ID数组
action	string	-	validate:required	desc:动作：on开机off关机reboot重启hard_off强制关机hard_reboot强制重启crack_pass重置密码reinstall重装系统
client_operate_password	string	-	validate:optional	desc:操作密码,需要验证时传
password	string	-	validate:optional	desc:密码，动作为crack_pass时需要传此字段
reinstall	object	-	validate:optional	desc:动作为reinstall时的重装系统参数{"产品ID":{"os":"操作系统ID（option_param）","os_name":"操作系统名称(option_name)","option_id":"配置项ID(option_id)","sub_id":"配置子项ID(sub_id)"}}

响应参数

无

批量重装系统页面

项目	内容
接口描述	批量重装系统页面
接口地址	/console/v1/idcsmart_common/batch_reinstall
请求方式	GET
接口版本	v1

请求参数

name	type	default	validate	desc
ids	array	-	validate:required	desc:产品ID数组

响应参数

name	type	default	desc
配置	object	-	desc:配置："/console/v1/idcsmart_common/host/:host_id/configoption此接口返回参数"拼接的数组