Skip to content

通用代理(自定义配置)-前台 ​

产品列表 ​

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

请求参数

nametypedefaultvalidatedesc
pageint1-页数
limitint--每页条数
orderbystring--排序(id,due_time,status)
sortstring--升/降序
keywordsstring--关键字搜索主机名
statusstring--产品状态(Unpaid=未付款,Pending=开通中,Active=已开通,Suspended=已暂停,Deleted=已删除)
tabstring--状态using使用中expiring即将到期overdue已逾期deleted已删除
mint--菜单ID

响应参数

nametypedefaultdesc
list[].idint-产品ID
list[].product_idint-商品ID
list[].namestring-产品标识
list[].statusstring-产品状态(Unpaid=未付款,Pending=开通中,Active=已开通,Suspended=已暂停,Deleted=已删除)
list[].active_timeint-开通时间
list[].due_timeint-到期时间
list[].first_payment_amountstring-首付金额
list[].renew_amountstring-续费金额
list[].billing_cyclestring-计费方式
list[].billing_cycle_namestring-周期名称
list[].product_namestring-商品名称
list[].client_notesstring-备注
list[].self_defined_fieldobject-自定义字段值(键是自定义字段ID,值是填的内容)
list[].is_auto_renewint-是否自动续费(0=否,1=是)
countint-总条数
using_countint-使用中产品数量
expiring_countint-即将到期产品数量
overdue_countint-已逾期产品数量
deleted_countint-已删除产品数量
all_countint-全部产品数量
self_defined_field[].idint-自定义字段ID
self_defined_field[].field_namestring-自定义字段名称
self_defined_field[].field_typestring-字段类型(text=文本框,link=链接,password=密码,dropdown=下拉,tickbox=勾选框,textarea=文本区)

前台商品配置信息 ​

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

请求参数

nametypedefaultvalidatedesc
product_idint-require商品ID

响应参数

nametypedefaultdesc
common_productobject-商品基础信息
common_product.namestring-商品名称
common_product.order_page_descriptionstring-订购页面html
common_product.allow_qtystring-是否允许选择数量:1是,0否默认
common_product.pay_typestring-付款类型(免费free,一次onetime,周期先付recurring_prepayment,周期后付recurring_postpaid
common_product.product_idint--
configoptionsarray-配置项信息
configoptions[].idint-配置项ID
configoptions[].product_idint-商品ID
configoptions[].option_namestring-配置项名称
configoptions[].option_typestring-配置项类型:select下拉单选,multi_select下拉多选,radio点击单选,quantity数量输入,quantity_range数量拖动,yes_no是否,area区域,cascade级联
configoptions[].qty_minint-数量时最小值
configoptions[].qty_maxint-数量时最大值
configoptions[].unitstring-单位
configoptions[].allow_repeatint-数量类型时:是否允许重复:开启后,前台购买时,可通过点击添加按钮,自动创建一个新的配置项,取名如bw1
configoptions[].max_repeatint-最大允许重复数量
configoptions[].descriptionstring-说明
configoptions[].qty_changeint-数量变化值
configoptions[].subsarray-子项信息
configoptions[].subs[].idint-子项ID
configoptions[].subs[].option_namestring-子项名称
configoptions[].subs[].qty_minint-子项最小值
configoptions[].subs[].qty_maxint-子项最大值
configoptions[].treearray-级联配置项的树形结构数据(仅当option_type为cascade时返回)
configoptions[].tree[].item_idint-级联项ID
configoptions[].tree[].item_namestring-级联项名称
configoptions[].tree[].fee_typestring-计费类型
configoptions[].tree[].group_idint-级联组ID
configoptions[].tree[].is_leafint-是否为末端项:1是,0否
configoptions[].tree[].orderint-排序
configoptions[].tree[].hiddenint-是否隐藏:1是,0否
configoptions[].tree[].childrenarray-子级联项(递归结构)
configoptions[].tree[].pricearray-价格信息(仅末端项有此字段)
configoptions[].cascade_grouparray-级联组信息(仅当option_type为cascade时返回)
configoptions[].cascade_group[].idint-级联组ID
configoptions[].cascade_group[].group_namestring-级联组名称
cyclesobject-周期({"onetime":1.00})
custom_cyclesarray-自定义周期
custom_cycles[].idint-自定义周期ID
custom_cycles[].namestring-自定义周期名称
custom_cycles.cycle_timeint-自定义周期时长
custom_cycles[].cycle_unitstring-自定义周期单位
custom_cycles[].amountstring-商品自定义周期金额
custom_cycles[].cycle_amountstring-(商品+配置项)自定义周期金额
custom_cycles[].amount_client_level_discountstring-商品自定义周期金额等级折扣
custom_cycles[].cycle_amount_client_level_discountstring-(商品+配置项)自定义周期金额等级折扣

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

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

请求参数

nametypedefaultvalidatedesc
configoptionobject-require配置信息
cascade_configoptionobject-optional级联配置项信息{169:{item_id:12,quantity:2}}

响应参数

nametypedefaultdesc
cyclesobject-周期({"onetime":1.00})
custom_cyclesarray-自定义周期
custom_cycles[].idint-自定义周期ID
custom_cycles[].namestring-自定义周期名称
custom_cycles[].cycle_timeint-自定义周期时长
custom_cycles[].cycle_unitstring-自定义周期单位
custom_cycles[].amountstring-商品自定义周期金额
custom_cycles[].cycle_amountstring-(商品+配置项)自定义周期金额
custom_cycles[].amount_client_level_discountstring-商品自定义周期金额等级折扣
custom_cycles[].cycle_amount_client_level_discountstring-(商品+配置项)自定义周期金额等级折扣

前台产品内页 ​

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

请求参数

nametypedefaultvalidatedesc
host_idint-require产品ID

响应参数

nametypedefaultdesc
hostobject-财务信息
host.idint-产品ID
host.order_idint-订单ID
host.product_idint-商品ID
host.create_timeint-订购时间
host.due_timeint-到期时间
host.billing_cyclestring-计费方式:计费周期免费free,一次onetime,周期先付recurring_prepayment,周期后付recurring_postpaid
host.billing_cycle_namestring-模块计费周期名称
host.billing_cycle_timeint-模块计费周期时间,秒
host.renew_amountstring-续费金额
host.first_payment_amountstring-首付金额
host.namestring-商品名称
host.statusstring-产品状态
host.host_namestring-产品标识
host.client_notesstring-用户备注
host.dedicatedipstring-独立ip
host.assignedipsstring-分配ip,逗号分隔
host.usernamestring-用户名
host.passwordstring-密码
host.bwlimitint-流量限制
host.osstring-操作系统,后台未配置时显示远程操作系统模板ID
host.bwusagestring-流量使用
configoptionsarray-配置项信息
configoptions[].idint-配置项ID
configoptions[].option_namestring-配置项名称
configoptions[].option_typestring-配置项类型:select下拉单选,multi_select下拉多选,radio点击单选,quantity数量输入,quantity_range数量拖动,yes_no是否,area区域,os操作系统
configoptions[].unitstring-单位
configoptions[].qtyint-数量(当类型为数量时,显示此值)
configoptions[].repeatint--
configoptions[].subsarray--
configoptions[].subs[].option_namestring-子项名称
configoptions[].subs[].countrystring-子项名称
chartarray-图表tab
chart[].typestring-类型
chart[].titlestring-标题
chart[].selectarray-下拉选择
chart[].select[].namestring-名称
chart[].select[].valuestring-值
client_areaarray-客户自定义tab区域
client_area[].keystring-键
client_area[].namestring-名称标题
client_buttonarray-管理按钮区域(默认模块操作)
client_button.consolearray-控制台
client_button.console[].funcstring-模块(调模块动作传此值)
client_button.console[].namestring-操作名称
client_button.console[].typestring-类型
client_button.controlarray-下拉管理
client_button.control[].funcstring-模块(调模块动作传此值)
client_button.control[].namestring-操作名称
client_button.control[].typestring-类型
osobject-操作系统
os.idint-配置项ID
os.option_namestring-配置项名称
os.option_typestring-配置项类型
os.subsarray-子项
os.subs[].osstring-操作系统
os.subs[].versionarray-操作系统详细版本
os.subs[].version[].idint-子项ID
os.subs[].version[].option_namestring-名称
os.subs[].version[].option_paramstring--

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

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

请求参数

nametypedefaultvalidatedesc
host_idint-require产品ID
keystring-requiresnapshot快照等
api_urlstring--替换原来模板内的接口地址

响应参数

无

前台产品内页图表页面 ​

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

请求参数

nametypedefaultvalidatedesc
host_idint-require产品ID
chartobject-require图表数据
chart.startint-require开始时间
chart.typestring-require类型:cpu/disk/flow
chart.selectstring-requireselect的value值

响应参数

nametypedefaultdesc
unitstring-单位
chart_typestring-图表类型(line=折线图)
listarray-每条线的数据
list[][].timestring-时间(YYYY-MM-DD
list[][].valuestring-数值
labelarray-图表label

执行子模块方法 ​

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

请求参数

nametypedefaultvalidatedesc
host_idint-require产品ID
funcstring-require模块方法:on=开机,off=关机,reboot=重启,hard_off=硬关机,hard_reboot=硬重启,crack_pass=重置密码
passwordstring-requireIf,func=crack_pass密码

响应参数

无

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

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

请求参数

nametypedefaultvalidatedesc
host_idint-require产品ID
funcstring-require模块方法:on=开机,off=关机,reboot=重启,hard_off=硬关机,hard_reboot=硬重启,crack_pass=重置密码
passwordstring-requireIf,func=crack_pass密码

响应参数

无

执行子模块自定义方法 ​

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

请求参数

nametypedefaultvalidatedesc
host_idint-require产品ID
funcstring-require自定义方法
custom_fieldsarray--自定义字段

响应参数

无

产品配置升降级页面 ​

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

请求参数

nametypedefaultvalidatedesc
host_idint-require产品ID

响应参数

nametypedefaultdesc
hostobject-产品信息
host.idint-产品ID
host.product_idint-商品ID
host.namestring-商品名称
host.first_payment_amountstring-金额
host.billing_cycle_namestring-周期
configoptionsarray-配置
configoptions[].idint-配置ID
configoptions[].option_typestring-配置类型
configoptions[].option_namestring-名称
configoptions[].sub_namestring-子项名称
configoptions[].qtyint-数量(类型为数量时,显示此值)
configoptions[].configoption_sub_idint-子项ID
configoptions[].treearray-级联配置项的树形结构数据(仅当option_type为cascade时返回)
configoptions[].tree[].item_idint-级联项ID
configoptions[].tree[].item_namestring-级联项名称
configoptions[].tree[].fee_typestring-计费类型
configoptions[].tree[].group_idint-级联组ID
configoptions[].tree[].is_leafint-是否为末端项:1是,0否
configoptions[].tree[].orderint-排序
configoptions[].tree[].hiddenint-是否隐藏:1是,0否
configoptions[].tree[].childrenarray-子级联项(递归结构)
configoptions[].tree[].pricearray-价格信息(仅末端项有此字段)
configoptions[].cascade_grouparray-级联组信息(仅当option_type为cascade时返回)
configoptions[].cascade_group[].idint-级联组ID
configoptions[].cascade_group[].group_namestring-级联组名称
configoptions[].current_cascade_item_idint-当前选择的级联项ID(仅当option_type为cascade时返回)
upgrade_configoptionsarray-可升降级配置项
upgrade_configoptions[].idint-配置项ID
upgrade_configoptions[].option_namestring-配置项名称
upgrade_configoptions[].option_typestring-配置类型:select下拉单选,multi_select下拉多选,radio点击单选,quantity数量输入,quantity_range数量拖动,yes_no是否,area区域,cascade级联
upgrade_configoptions[].option_paramstring-配置参数
upgrade_configoptions[].qty_minint-数量时最小值
upgrade_configoptions[].qty_maxint-数量时最大值
upgrade_configoptions[].orderint-排序
upgrade_configoptions[].unitstring-单位
upgrade_configoptions[].allow_repeatint-数量类型时:是否允许重复:开启后,前台购买时,可通过点击添加按钮,自动创建一个新的配置项,取名如bw1
upgrade_configoptions[].max_repeatint-最大允许重复数量
upgrade_configoptions[].fee_typestring-计费类型
upgrade_configoptions[].descriptionstring-说明
upgrade_configoptions[].subsarray-配置子项数据
upgrade_configoptions[].subs[].idint-子项ID
upgrade_configoptions[].subs[].product_configoption_idint-配置项ID
upgrade_configoptions[].subs[].option_namestring-子项名称
upgrade_configoptions[].subs[].option_paramstring-子项参数
upgrade_configoptions[].subs[].qty_minint-数量时最小值
upgrade_configoptions[].subs[].qty_maxint-数量时最大值
upgrade_configoptions[].subs[].orderint-排序
upgrade_configoptions[].subs[].hiddenint-是否隐藏
upgrade_configoptions[].subs[].countrystring-国家代码
upgrade_configoptions[].subs[].qty_changeint-数量变化值
upgrade_configoptions[].treearray-级联配置项的树形结构数据(仅当option_type为cascade时返回)
upgrade_configoptions[].tree[].item_idint-级联项ID
upgrade_configoptions[].tree[].item_namestring-级联项名称
upgrade_configoptions[].tree[].fee_typestring-计费类型
upgrade_configoptions[].tree[].group_idint-级联组ID
upgrade_configoptions[].tree[].is_leafint-是否为末端项:1是,0否
upgrade_configoptions[].tree[].orderint-排序
upgrade_configoptions[].tree[].hiddenint-是否隐藏:1是,0否
upgrade_configoptions[].tree[].childrenarray-子级联项(递归结构)
upgrade_configoptions[].tree[].pricearray-价格信息(仅末端项有此字段)
upgrade_configoptions[].cascade_grouparray-级联组信息(仅当option_type为cascade时返回)
upgrade_configoptions[].cascade_group[].idint-级联组ID
upgrade_configoptions[].cascade_group[].group_namestring-级联组名称

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

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

请求参数

nametypedefaultvalidatedesc
host_idint-require产品ID
configoptionobject--"configoption":
cascade_configoptionobject-optional级联配置项信息{169:{item_id:12,quantity:2}}

响应参数

nametypedefaultdesc
pricestring-价格
descriptionstring-描述
price_differencestring-差价
renew_price_differencestring-续费差价
base_pricestring-基础价格
price_client_level_discountstring-价格等级折扣
price_difference_client_level_discountstring-差价等级折扣
renew_price_difference_client_level_discountstring-续费差价等级折扣

产品配置升降级 ​

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

请求参数

nametypedefaultvalidatedesc
host_idint-require产品ID
configoptionobject-require"configoption":
cascade_configoptionobject-optional级联配置项信息{169:{item_id:12,quantity:2}}
customfieldobject--自定义参数

响应参数

nametypedefaultdesc
idint-订单ID

日志 ​

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

请求参数

nametypedefaultvalidatedesc
idint--产品ID
keywordsstring--关键字
pageint--页数
limitint--每页条数
orderbystring-id,description,create_time,ip排序
sortstring-asc,desc升/降序

响应参数

nametypedefaultdesc
listarray-系统日志
list[].idint-系统日志ID
list[].descriptionstring-描述
list[].create_timestring-时间
list[].ipint-IP
countint-系统日志总数