主题
魔方云代理(自定义配置)-前台
获取订购页面配置
| 项目 | 内容 |
|---|---|
| 接口描述 | 获取订购页面配置 |
| 接口地址 | /console/v1/product/:id/remf_cloud/order_page |
| 请求方式 | GET |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | require | 商品ID |
| scene | string | custom | - | 场景(recommend=套餐,custom=自定义) |
响应参数
| name | type | default | desc |
|---|---|---|---|
| data_center[].id | int | - | 国家ID |
| data_center[].iso | string | - | 图标 |
| data_center[].name | string | - | 名称 |
| data_center[].city[].name | string | - | 城市 |
| data_center[].city[].area[].id | int | - | 数据中心ID |
| data_center[].city[].area[].name | string | - | 区域 |
| data_center[].city[].area[].reommend_config[].id | int | - | 推荐配置ID |
| data_center[].city[].area[].reommend_config[].name | string | - | 推荐配置名称 |
| data_center[].city[].area[].reommend_config[].description | string | - | 推荐配置描述 |
| data_center[].city[].area[].reommend_config[].line_id | int | - | 线路ID |
| data_center[].city[].area[].reommend_config[].cpu | int | - | CPU |
| data_center[].city[].area[].reommend_config[].memory | int | - | 内存 |
| data_center[].city[].area[].reommend_config[].system_disk_size | int | - | 系统盘 |
| data_center[].city[].area[].reommend_config[].system_disk_type | string | - | 系统盘类型 |
| data_center[].city[].area[].reommend_config[].data_disk_size | int | - | 数据盘 |
| data_center[].city[].area[].reommend_config[].data_disk_type | string | - | 数据盘类型 |
| data_center[].city[].area[].reommend_config[].network_type | string | - | 网络类型(normal=经典网络,vpc=vpc网络) |
| data_center[].city[].area[].reommend_config[].bw | int | - | 带宽 |
| data_center[].city[].area[].reommend_config[].flow | int | - | 流量 |
| data_center[].city[].area[].reommend_config[].peak_defence | int | - | 防护峰值 |
| data_center[].city[].area[].reommend_config[].ip_num | int | - | IP数量 |
| data_center[].city[].area[].reommend_config[].upgrade_range | int | - | 升降级范围(0=不可升降级,1=全部,2=自选) |
| data_center[].city[].area[].reommend_config[].gpu_num | int | - | GPU数量 |
| data_center[].city[].area[].reommend_config[].gpu_name | int | - | GPU型号 |
| data_center[].city[].area[].line[].id | int | - | 线路ID |
| data_center[].city[].area[].line[].name | string | - | 线路名称 |
| data_center[].city[].area[].line[].data_center_id | int | - | 数据中心ID |
| data_center[].city[].area[].line[].bill_type | string | - | 计费类型(bw=带宽计费,flow=流量计费) |
| cpu | array | - | CPU配置 |
| cpu[].id | int | - | 配置ID |
| cpu[].value | int | - | 核心数 |
| memory[].id | int | - | 配置ID |
| memory- | array | 内存配置 | - |
| memory[].type | string | - | 配置类型(radio=单选,step=阶梯,total=完整) |
| memory[].value | int | - | 配置值 |
| memory[].min_value | int | - | 最小值 |
| memory[].max_value | int | - | 最大值 |
| memory[].step | int | - | 最小变化值 |
| system_disk | array | - | 系统盘配置 |
| system_disk[].id | int | - | 配置ID |
| system_disk[].type | string | - | 配置类型(radio=单选,step=阶梯,total=完整) |
| system_disk[].value | int | - | 配置值 |
| system_disk[].min_value | int | - | 最小值 |
| system_disk[].max_value | int | - | 最大值 |
| system_disk[].step | int | - | 最小变化值 |
| system_disk[].other_config.disk_type | string | - | 磁盘类型 |
| system_disk[].other_config.store_id | string | - | 储存ID |
| system_disk[].customfield.multi_language.other_config.disk_type | string | - | 多语言磁盘类型(有就替换) |
| data_disk | array | - | 数据盘配置 |
| data_disk[].id | int | - | 配置ID |
| data_disk[].type | string | - | 配置类型(radio=单选,step=阶梯,total=完整) |
| data_disk[].value | int | - | 配置值 |
| data_disk[].min_value | int | - | 最小值 |
| data_disk[].max_value | int | - | 最大值 |
| data_disk[].step | int | - | 最小变化值 |
| data_disk[].other_config.disk_type | string | - | 磁盘类型 |
| data_disk[].other_config.store_id | string | - | 储存ID |
| data_disk[].customfield.multi_language.other_config.disk_type | string | - | 多语言磁盘类型(有就替换) |
| config.type | string | - | 实例类型(host=KVM加强版,lightHost=KVM轻量版,hyperv=Hyper-V) |
| config.support_ssh_key | int | - | 是否支持SSH密钥(0=不支持,1=支持) |
| config.support_normal_network | int | - | 是否支持经典网络(0=不支持,1=支持) |
| config.support_vpc_network | int | - | 是否支持VPC网络(0=不支持,1=支持) |
| config.support_public_ip | int | - | 是否允许公网IP(0=不支持,1=支持) |
| config.backup_enable | int | - | 是否启用备份(0=不支持,1=支持) |
| config.snap_enable | int | - | 是否启用快照(0=不支持,1=支持) |
| config.memory_unit | string | - | 内存单位(GB,MB) |
| config.disk_limit_num | int | - | 数据盘数量限制 |
| config.free_disk_switch | int | - | 免费数据盘开关(0=关闭,1=开启) |
| config.free_disk_size | int | - | 免费数据盘大小(GB) |
| config.only_sale_recommend_config | int | - | 仅售卖套餐(0=关闭,1=开启) |
| config.no_upgrade_tip_show | int | - | 不可升降级时订购页提示(0=关闭,1=开启) |
| config.default_nat_acl | int | - | 默认NAT转发(0=关闭,1=开启) |
| config.default_nat_web | int | - | 默认NAT建站(0=关闭,1=开启) |
| config.ip_mac_bind_enable | int | - | 是否启用嵌套虚拟化(0=关闭,1=开启) |
| config.nat_acl_limit_enable | int | - | 是否启用NAT转发(0=关闭,1=开启) |
| config.nat_web_limit_enable | int | - | 是否启用NAT建站(0=关闭,1=开启) |
| config.ipv6_num_enable | int | - | 是否启用IPv6(0=关闭,1=开启) |
| backup_config[].id | int | - | 备份配置ID |
| backup_config[].num | int | - | 备份数量 |
| backup_config[].price | string | - | 备份价格 |
| backup_config[].price_client_level_discount | string | - | 用户等级折扣 |
| snap_config[].id | int | - | 快照ID |
| snap_config[].num | int | - | 快照数量 |
| snap_config[].price | string | - | 快照价格 |
| snap_config[].price_client_level_discount | string | - | 用户等级折扣 |
| config_limit[].type | string | - | 配置限制类型(cpu=CPU与内存限制,data_center=数据中心与计算限制,line=带宽与计算限制) |
| config_limit[].data_center_id | int | - | 数据中心ID |
| config_limit[].line_id | int | - | 线路ID |
| config_limit[].min_bw | int | - | 最小带宽 |
| config_limit[].max_bw | int | - | 最大带宽 |
| config_limit[].cpu | string | - | cpu(英文逗号分隔) |
| config_limit[].memory | string | - | 内存(英文逗号分隔) |
| config_limit[].min_memory | int | - | 最小内存 |
| config_limit[].max_memory | int | - | 最大内存 |
| resource_package[].id | int | - | 资源包ID |
| resource_package[].name | string | - | 资源包名称 |
获取操作系统列表
| 项目 | 内容 |
|---|---|
| 接口描述 | 获取操作系统列表 |
| 接口地址 | /console/v1/product/:id/remf_cloud/image |
| 请求方式 | GET |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | require | 商品ID |
响应参数
| name | type | default | desc |
|---|---|---|---|
| list[].id | int | - | 操作系统分类ID |
| list[].name | string | - | 操作系统分类名称 |
| list[].icon | string | - | 操作系统分类图标 |
| list[].image[].id | int | - | 操作系统ID |
| list[].image[].image_group_id | int | - | 操作系统分类ID |
| list[].image[].name | string | - | 操作系统名称 |
| list[].image[].charge | int | - | 是否收费(0=否,1=是) |
| list[].image[].price | string | - | 价格 |
| list[].image[].price_client_level_discount | string | - | 用户等级折扣 |
获取商品配置所有周期价格
| 项目 | 内容 |
|---|---|
| 接口描述 | 获取商品配置所有周期价格 |
| 接口地址 | /console/v1/product/:id/remf_cloud/duration |
| 请求方式 | POST |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | require | 商品ID |
| recommend_config_id | int | - | - | 套餐ID |
| cpu | int | - | - | CPU |
| memory | int | - | - | 内存 |
| system_disk.size | int | - | - | 系统盘大小 |
| system_disk.disk_type | string | - | - | 系统盘类型 |
| data_disk[].size | int | - | - | 数据盘大小 |
| data_disk[].disk_type | string | - | - | 系统盘类型 |
| line_id | int | - | - | 线路ID |
| bw | int | - | - | 带宽 |
| flow | int | - | - | 流量 |
| peak_defence | int | - | - | 防御峰值(G) |
| ip_num | int | - | - | 附加IP数量 |
| gpu_num | int | - | - | 显卡数量 |
| image_id | int | 0 | - | 镜像ID |
| backup_num | int | 0 | - | 备份数量 |
| snap_num | int | 0 | - | 快照数量 |
响应参数
| name | type | default | desc |
|---|---|---|---|
| [].id | int | - | 周期ID |
| [].name | string | - | 周期名称 |
| [].name_show | string | - | 周期名称多语言替换 |
| [].price | string | - | 周期总价 |
| [].discount | float | - | 折扣(0=没有折扣) |
| [].num | int | - | 周期时长 |
| [].unit | string | - | 单位(hour=小时,day=天,month=月) |
| [].price_client_level_discount | string | - | 用户等级折扣 |
获取配置限制规则
| 项目 | 内容 |
|---|---|
| 接口描述 | 获取配置限制规则 |
| 接口地址 | /console/v1/product/:id/remf_cloud/config_limit |
| 请求方式 | GET |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | require | 商品ID |
响应参数
| name | type | default | desc |
|---|---|---|---|
| [].type | string | - | 类型(cpu=CPU与内存限制,data_center=数据中心与计算限制) |
| [].data_center_id | int | - | 数据中心ID |
| [].cpu | array | - | CPU |
| [].memory | array | - | 内存 |
| [].min_memory | int | - | 最小内存 |
| [].max_memory | int | - | 最大内存 |
获取可用VPC网络
| 项目 | 内容 |
|---|---|
| 接口描述 | 获取可用VPC网络 |
| 接口地址 | /console/v1/product/:id/remf_cloud/vpc_network/search |
| 请求方式 | GET |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | require | 商品ID |
| data_center_id | int | - | - | 数据中心ID |
响应参数
| name | type | default | desc |
|---|---|---|---|
| list[].id | int | - | VPC网络ID |
| list[].name | string | - | VPC网络名称 |
产品列表
| 项目 | 内容 |
|---|---|
| 接口描述 | 产品列表 |
| 接口地址 | /console/v1/remf_cloud |
| 请求方式 | GET |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| page | int | 1 | - | 页数 |
| limit | int | - | - | 每页条数 |
| orderby | string | - | - | 排序(id,due_time,status) |
| sort | string | - | - | 升/降序 |
| keywords | string | - | - | 关键字搜索:商品名称/产品名称/IP |
| country_id | int | - | - | 搜索:国家ID |
| city | string | - | - | 搜索:城市 |
| area | string | - | - | 搜索:区域 |
| status | string | - | - | 产品状态(Unpaid=未付款,Pending=开通中,Active=已开通,Suspended=已暂停,Deleted=已删除) |
| tab | string | - | - | 状态using使用中expiring即将到期overdue已逾期deleted已删除 |
响应参数
| name | type | default | desc |
|---|---|---|---|
| list | array | - | 列表数据 |
| list[].id | int | - | 产品ID |
| list[].product_id | int | - | 商品ID |
| list[].name | string | - | 产品标识 |
| list[].status | string | - | 产品状态(Unpaid=未付款,Pending=开通中,Active=已开通,Suspended=已暂停,Deleted=已删除) |
| list[].active_time | int | - | 开通时间 |
| list[].due_time | int | - | 到期时间 |
| list[].client_notes | string | - | 用户备注 |
| list[].product_name | string | - | 商品名称 |
| list[].country | string | - | 国家 |
| list[].country_code | string | - | 国家代码 |
| list[].country_id | int | - | 国家ID |
| list[].city | string | - | 城市 |
| list[].area | string | - | 区域 |
| list[].power_status | string | - | 电源状态(on=开机,off=关机,operating=操作中,fault=故障) |
| list[].image_name | string | - | 镜像名称 |
| list[].image_icon | string | - | 镜像图标(Windows,CentOS,Ubuntu,Debian,ESXi,XenServer,FreeBSD,Fedora,ArchLinux,Rocky,AlmaLinux,OpenEuler,RedHat,其他) |
| list[].ip_num | int | - | IP数量 |
| list[].dedicate_ip | string | - | 主IP |
| list[].assign_ip | string | - | 附加IP(英文逗号分隔) |
| list[].self_defined_field | object | - | 自定义字段值(键是自定义字段ID,值是填的内容) |
| list[].is_auto_renew | int | - | 是否自动续费(0=否,1=是) |
| count | int | - | 总条数 |
| using_count | int | - | 使用中产品数量 |
| expiring_count | int | - | 即将到期产品数量 |
| overdue_count | int | - | 已逾期产品数量 |
| deleted_count | int | - | 已删除产品数量 |
| all_count | int | - | 全部产品数量 |
| data_center[].country_id | int | - | 国家ID |
| data_center[].city | string | - | 城市 |
| data_center[].area | string | - | 区域 |
| data_center[].country_name | string | - | 国家 |
| data_center[].country_code | string | - | 国家代码 |
| self_defined_field[].id | int | - | 自定义字段ID |
| self_defined_field[].field_name | string | - | 自定义字段名称 |
| self_defined_field[].field_type | string | - | 字段类型(text=文本框,link=链接,password=密码,dropdown=下拉,tickbox=勾选框,textarea=文本区) |
获取实例详情
| 项目 | 内容 |
|---|---|
| 接口描述 | 获取实例详情 |
| 接口地址 | /console/v1/remf_cloud/:id |
| 请求方式 | GET |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | - | 产品ID |
响应参数
| name | type | default | desc |
|---|---|---|---|
| type | string | - | 类型(host=KVM加强版,lightHost=KVM轻量版,hyperv=Hyper-V) |
| order_id | int | - | 订单ID |
| ip | string | - | IP地址 |
| ip_num | int | - | 附加IP数量 |
| backup_num | int | - | 允许备份数量 |
| snap_num | int | - | 允许快照数量 |
| power_status | string | - | 电源状态(on=开机,off=关机,operating=操作中,fault=故障) |
| cpu | string | - | CPU |
| memory | int | - | 内存 |
| system_disk.size | int | - | 系统盘大小(G) |
| system_disk.type | string | - | 系统盘类型 |
| line.id | int | - | 线路ID |
| line.name | string | - | 线路名称 |
| line.bill_type | string | - | 计费类型(bw=带宽计费,flow=流量计费) |
| bw | int | - | 带宽 |
| peak_defence | int | - | 防御峰值(G) |
| network_type | string | - | 网络类型(normal=经典网络,vpc=VPC网络) |
| gpu | string | - | 显卡 |
| username | string | - | 用户名 |
| password | string | - | 密码 |
| data_center.id | int | - | 数据中心ID |
| data_center.city | string | - | 城市 |
| data_center.area | string | - | 区域 |
| data_center.country | string | - | 国家 |
| data_center.iso | string | - | 图标 |
| image.id | int | - | 镜像ID |
| image.name | string | - | 镜像名称 |
| image.image_group_name | string | - | 镜像分组 |
| image.icon | string | - | 图标 |
| ssh_key.id | int | - | SSH密钥ID |
| ssh_key.name | string | - | SSH密钥名称 |
| nat_acl_limit | int | - | NAT转发数量 |
| nat_web_limit | int | - | NAT建站数量 |
| config.reinstall_sms_verify | int | - | 重装短信验证(0=不启用,1=启用) |
| config.reset_password_sms_verify | int | - | 重置密码短信验证(0=不启用,1=启用) |
| security_group.id | int | - | 关联的安全组ID(0=没关联) |
| security_group.name | string | - | 关联的安全组名称 |
| recommend_config.id | int | - | 套餐ID(有表示是套餐) |
| recommend_config.product_id | int | - | 商品ID |
| recommend_config.name | string | - | 套餐名称 |
| recommend_config.description | string | - | 套餐描述 |
| recommend_config.order | int | - | 排序 |
| recommend_config.data_center_id | int | - | 数据中心ID |
| recommend_config.cpu | int | - | CPU |
| recommend_config.memory | int | - | 内存(GB) |
| recommend_config.system_disk_size | int | - | 系统盘大小(G) |
| recommend_config.data_disk_size | int | - | 数据盘大小(G) |
| recommend_config.bw | int | - | 带宽 |
| recommend_config.peak_defence | int | - | 防御峰值(G) |
| recommend_config.system_disk_type | string | - | 系统盘类型 |
| recommend_config.data_disk_type | string | - | 数据盘类型 |
| recommend_config.flow | int | - | 流量 |
| recommend_config.line_id | int | - | 线路ID |
| recommend_config.create_time | int | - | 创建时间 |
| recommend_config.ip_num | int | - | IP数量 |
| recommend_config.upgrade_range | int | - | 升降级范围(0=不可升降级,1=全部,2=自选) |
| recommend_config.hidden | int | - | 是否隐藏(0=否,1=是) |
| recommend_config.gpu_num | int | - | 显卡数量 |
获取部分详情
| 项目 | 内容 |
|---|---|
| 接口描述 | 获取部分详情 |
| 接口地址 | /console/v1/remf_cloud/:id/part |
| 请求方式 | GET |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | require | 产品ID |
响应参数
| name | type | default | desc |
|---|---|---|---|
| data_center.id | int | - | 数据中心ID |
| data_center.city | string | - | 城市 |
| data_center.area | string | - | 区域 |
| data_center.country | string | - | 国家 |
| data_center.iso | string | - | 图标 |
| ip | string | - | IP地址 |
| power_status | string | - | 电源状态(on=开机,off=关机,operating=操作中,fault=故障) |
| image.id | int | - | 镜像ID |
| image.name | string | - | 镜像名称 |
| image.image_group_name | string | - | 镜像分类 |
| image.icon | string | - | 图标 |
开机
| 项目 | 内容 |
|---|---|
| 接口描述 | 开机 |
| 接口地址 | /console/v1/remf_cloud/:id/on |
| 请求方式 | POST |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | require | 产品ID |
| client_operate_password | string | - | - | 操作密码,需要验证时传 |
响应参数
无
关机
| 项目 | 内容 |
|---|---|
| 接口描述 | 关机 |
| 接口地址 | /console/v1/remf_cloud/:id/off |
| 请求方式 | POST |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | require | 产品ID |
| client_operate_password | string | - | - | 操作密码,需要验证时传 |
响应参数
无
重启
| 项目 | 内容 |
|---|---|
| 接口描述 | 重启 |
| 接口地址 | /console/v1/remf_cloud/:id/reboot |
| 请求方式 | POST |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | require | 产品ID |
| client_operate_password | string | - | - | 操作密码,需要验证时传 |
响应参数
无
强制关机
| 项目 | 内容 |
|---|---|
| 接口描述 | 强制关机 |
| 接口地址 | /console/v1/remf_cloud/:id/hard_off |
| 请求方式 | POST |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | require | 产品ID |
| client_operate_password | string | - | - | 操作密码,需要验证时传 |
响应参数
无
强制重启
| 项目 | 内容 |
|---|---|
| 接口描述 | 强制重启 |
| 接口地址 | /console/v1/remf_cloud/:id/hard_reboot |
| 请求方式 | POST |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | require | 产品ID |
| client_operate_password | string | - | - | 操作密码,需要验证时传 |
响应参数
无
批量操作
| 项目 | 内容 |
|---|---|
| 接口描述 | 批量操作 |
| 接口地址 | /console/v1/remf_cloud/batch_operate |
| 请求方式 | POST |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | array | - | require | 产品ID |
| action | string | - | require | 动作on开机off关机reboot重启hard_off强制关机hard_reboot强制重启 |
| client_operate_password | string | - | - | 操作密码,需要验证时传 |
响应参数
无
获取控制台地址
| 项目 | 内容 |
|---|---|
| 接口描述 | 获取控制台地址 |
| 接口地址 | /console/v1/remf_cloud/:id/vnc |
| 请求方式 | POST |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | require | 产品ID |
| more | int | 0 | - | 是否获取更多返回(0=否,1=是) |
| client_operate_password | string | - | - | 操作密码,需要验证时传 |
响应参数
| name | type | default | desc |
|---|---|---|---|
| url | string | - | 控制台地址 |
| vnc_url | string | - | vncwebsocket地址(more=1返回) |
| vnc_pass | string | - | VNC密码(more=1返回) |
| password | string | - | 实例密码(more=1返回) |
| token | string | - | 临时令牌(more=1返回) |
控制台页面
| 项目 | 内容 |
|---|---|
| 接口描述 | 控制台页面 |
| 接口地址 | /console/v1/remf_cloud/:id/vnc |
| 请求方式 | GET |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | require | 产品ID |
| temp_token | string | - | require | 临时令牌 |
响应参数
无
获取实例状态
| 项目 | 内容 |
|---|---|
| 接口描述 | 获取实例状态 |
| 接口地址 | /console/v1/remf_cloud/:id/status |
| 请求方式 | GET |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | require | 产品ID |
响应参数
| name | type | default | desc |
|---|---|---|---|
| data.status | string | - | 实例状态(pending=开通中,on=开机,off=关机,suspend=暂停,operating=操作中,fault=故障) |
| data.desc | string | - | 实例状态描述 |
重置密码
| 项目 | 内容 |
|---|---|
| 接口描述 | 重置密码 |
| 接口地址 | /console/v1/remf_cloud/:id/reset_password |
| 请求方式 | POST |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | require | 产品ID |
| password | string | - | require | 新密码 |
| client_operate_password | string | - | - | 操作密码,需要验证时传 |
响应参数
无
救援模式
| 项目 | 内容 |
|---|---|
| 接口描述 | 救援模式 |
| 接口地址 | /console/v1/remf_cloud/:id/rescue |
| 请求方式 | POST |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | require | 产品ID |
| type | int | - | require | 指定救援系统类型(1=windows,2=linux) |
| password | string | - | require | 救援系统临时密码 |
| client_operate_password | string | - | - | 操作密码,需要验证时传 |
响应参数
无
退出救援模式
| 项目 | 内容 |
|---|---|
| 接口描述 | 退出救援模式 |
| 接口地址 | /console/v1/remf_cloud/:id/rescue/exit |
| 请求方式 | POST |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | require | 产品ID |
| client_operate_password | string | - | - | 操作密码,需要验证时传 |
响应参数
无
重装系统
| 项目 | 内容 |
|---|---|
| 接口描述 | 重装系统 |
| 接口地址 | /console/v1/remf_cloud/:id/reinstall |
| 请求方式 | POST |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | require | 产品ID |
| image_id | int | - | require | 镜像ID |
| password | int | - | require | 密码 |
| port | int | - | require | 端口 |
| format_data_disk | int | 0 | - | 是否格式化数据盘(0=不格式,1=格式化) |
| client_operate_password | string | - | - | 操作密码,需要验证时传 |
响应参数
无
获取图表数据
| 项目 | 内容 |
|---|---|
| 接口描述 | 获取图表数据 |
| 接口地址 | /console/v1/remf_cloud/:id/chart |
| 请求方式 | GET |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | require | 产品ID |
| start_time | int | - | - | 开始秒级时间 |
| type | string | - | require | 图表类型(cpu=CPU,memory=内存,disk_io=硬盘IO,bw=带宽) |
响应参数
| name | type | default | desc |
|---|---|---|---|
| list[].time | int | - | 时间(秒级时间戳) |
| list[].value | float | - | CPU使用率 |
| list[].total | int | - | 总内存(单位:B) |
| list[].used | int | - | 内存使用量(单位:B) |
| list[].read_bytes | float | - | 读取速度(B/s) |
| list[].write_bytes | float | - | 写入速度(B/s) |
| list[].read_iops | float | - | 读取IOPS |
| list[].write_iops | float | - | 写入IOPS |
| list[].in_bw | float | - | 进带宽(bps) |
| list[].out_bw | float | - | 出带宽(bps) |
获取网络流量
| 项目 | 内容 |
|---|---|
| 接口描述 | 获取网络流量 |
| 接口地址 | /console/v1/remf_cloud/:id/flow |
| 请求方式 | GET |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | require | 产品ID |
响应参数
| name | type | default | desc |
|---|---|---|---|
| total | string | -总流量 | - |
| used | string | -已用流量 | - |
| leave | string | - | 剩余流量 |
| reset_flow_date | string | - | 流量归零时间 |
| flow_packet.leave_size | float | - | 流量包剩余流量大小(GB) |
| flow_packet.total_size | int | - | 流量包总大小(GB) |
| flow_packet.used_size | float | - | 流量包已用大小(GB) |
获取实例磁盘
| 项目 | 内容 |
|---|---|
| 接口描述 | 获取实例磁盘 |
| 接口地址 | /console/v1/remf_cloud/:id/disk |
| 请求方式 | GET |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | require | 产品ID |
响应参数
| name | type | default | desc |
|---|---|---|---|
| list[].id | int | - | 魔方云磁盘ID |
| list[].name | string | - | 名称 |
| list[].size | int | - | 磁盘大小(GB) |
| list[].create_time | int | - | 创建时间 |
| list[].type | string | - | 磁盘类型 |
| list[].type2 | string | - | 类型(system=系统盘,data=数据盘) |
| list[].is_free | int | - | 是否免费盘(0=否,1=是),免费盘不能扩容 |
| list[].status | int | - | 磁盘状态(0=卸载,1=挂载,2=正在挂载,3=创建中) |
| list[].type2 | string | - | 类型(system=系统盘,data=数据盘) |
卸载磁盘
| 项目 | 内容 |
|---|---|
| 接口描述 | 卸载磁盘 |
| 接口地址 | /console/v1/remf_cloud/:id/disk/:disk_id/unmount |
| 请求方式 | POST |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | require | 产品ID |
| disk_id | int | - | require | 磁盘ID |
响应参数
| name | type | default | desc |
|---|---|---|---|
| name | string | - | 磁盘名称 |
挂载磁盘
| 项目 | 内容 |
|---|---|
| 接口描述 | 挂载磁盘 |
| 接口地址 | /console/v1/remf_cloud/:id/disk/:disk_id/mount |
| 请求方式 | POST |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | require | 产品ID |
| disk_id | int | - | require | 磁盘ID |
响应参数
| name | type | default | desc |
|---|---|---|---|
| name | string | - | 磁盘名称 |
快照列表
| 项目 | 内容 |
|---|---|
| 接口描述 | 快照列表 |
| 接口地址 | /console/v1/remf_cloud/:id/snapshot |
| 请求方式 | GET |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | require | 产品ID |
| page | int | - | - | 页数 |
| limit | int | - | - | 每页条数 |
响应参数
| name | type | default | desc |
|---|---|---|---|
| list[].id | int | - | 快照ID |
| list[].name | string | - | 快照名称 |
| list[].create_time | int | - | 创建时间 |
| list[].notes | string | - | 备注 |
| list[].status | int | - | 状态(0=创建中,1=创建完成) |
| count | int | - | 总条数 |
创建快照
| 项目 | 内容 |
|---|---|
| 接口描述 | 创建快照 |
| 接口地址 | /console/v1/remf_cloud/:id/snapshot |
| 请求方式 | POST |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | require | 产品ID |
| name | int | - | require | 快照名称 |
| disk_id | int | - | require | 磁盘ID |
响应参数
无
快照还原
| 项目 | 内容 |
|---|---|
| 接口描述 | 快照还原 |
| 接口地址 | /console/v1/remf_cloud/:id/snapshot/restore |
| 请求方式 | POST |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | require | 产品ID |
| snapshot_id | int | - | require | 快照ID |
响应参数
| name | type | default | desc |
|---|---|---|---|
| name | string | - | 快照名称 |
删除快照
| 项目 | 内容 |
|---|---|
| 接口描述 | 删除快照 |
| 接口地址 | /console/v1/remf_cloud/:id/snapshot/:snapshot_id |
| 请求方式 | DELETE |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | require | 产品ID |
| snapshot_id | int | - | require | 快照ID |
响应参数
| name | type | default | desc |
|---|---|---|---|
| name | string | - | 快照名称 |
备份列表
| 项目 | 内容 |
|---|---|
| 接口描述 | 备份列表 |
| 接口地址 | /console/v1/remf_cloud/:id/backup |
| 请求方式 | GET |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | require | 产品ID |
| page | int | - | - | 页数 |
| limit | int | - | - | 每页条数 |
响应参数
| name | type | default | desc |
|---|---|---|---|
| list[].id | int | - | 备份ID |
| list[].name | string | - | 备份名称 |
| list[].create_time | int | - | 创建时间 |
| list[].notes | string | - | 备注 |
| list[].status | int | - | 状态(0=创建中,1=创建成功) |
| count | int | - | 总条数 |
创建备份
| 项目 | 内容 |
|---|---|
| 接口描述 | 创建备份 |
| 接口地址 | /console/v1/remf_cloud/:id/backup |
| 请求方式 | POST |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | require | 产品ID |
| name | int | - | require | 备份名称 |
| disk_id | int | - | require | 磁盘ID |
响应参数
无
备份还原
| 项目 | 内容 |
|---|---|
| 接口描述 | 备份还原 |
| 接口地址 | /console/v1/remf_cloud/:id/backup/restore |
| 请求方式 | POST |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | require | 产品ID |
| backup_id | int | - | require | 备份ID |
响应参数
| name | type | default | desc |
|---|---|---|---|
| name | string | - | 备份名称 |
删除备份
| 项目 | 内容 |
|---|---|
| 接口描述 | 删除备份 |
| 接口地址 | /console/v1/remf_cloud/:id/backup/:backup_id |
| 请求方式 | DELETE |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | require | 产品ID |
| backup_id | int | - | require | 备份ID |
响应参数
| name | type | default | desc |
|---|---|---|---|
| name | string | - | 备份名称 |
日志
| 项目 | 内容 |
|---|---|
| 接口描述 | 日志 |
| 接口地址 | /console/v1/remf_cloud/:id/log |
| 请求方式 | GET |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | - | 产品ID |
| keywords | string | - | - | 关键字 |
| page | int | - | - | 页数 |
| limit | int | - | - | 每页条数 |
| orderby | string | - | id,description,create_time,ip | 排序 |
| sort | string | - | asc,desc | 升/降序 |
响应参数
| name | type | default | desc |
|---|---|---|---|
| list | array | - | 系统日志 |
| list[].id | int | - | 系统日志ID |
| list[].description | string | - | 描述 |
| list[].create_time | string | - | 时间 |
| list[].ip | int | - | IP |
| count | int | - | 系统日志总数 |
获取魔方云远程信息
| 项目 | 内容 |
|---|---|
| 接口描述 | 获取魔方云远程信息 |
| 接口地址 | console/v1/remf_cloud/:id/remote_info |
| 请求方式 | GET |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | require | 产品ID |
响应参数
| name | type | default | desc |
|---|---|---|---|
| rescue | int | - | 是否正在救援系统(0=不是,1=是) |
| username | string | - | 远程用户名 |
| password | string | - | 远程密码 |
| port | int | - | 远程端口 |
| ip_num | int | - | IP数量 |
| simulate_physical_machine | int | - | 模拟物理机运行(0=关闭,1=开启) |
| system_disk_real_size | float | - | 系统盘实际占用大小(单位:G) |
| panel_pass | string | - | 面板管理密码 |
获取IP列表
| 项目 | 内容 |
|---|---|
| 接口描述 | 获取IP列表 |
| 接口地址 | /console/v1/remf_cloud/:id/ip |
| 请求方式 | GET |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | - | 产品ID |
| page | int | 1 | - | 页数 |
| limit | int | - | - | 每页条数 |
响应参数
| name | type | default | desc |
|---|---|---|---|
| list | array | - | 列表数据 |
| list[].ip | string | - | IP |
| list[].subnet_mask | string | - | 掩码 |
| list[].gateway | string | - | 网关 |
| count | int | - | 总数 |
获取订购磁盘价格
| 项目 | 内容 |
|---|---|
| 接口描述 | 获取订购磁盘价格 |
| 接口地址 | /console/v1/remf_cloud/:id/disk/price |
| 请求方式 | POST |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | require | 产品ID |
| remove_disk_id | array | - | - | 要取消订购的磁盘ID |
| add_disk | array | - | - | 新增磁盘大小参数,如:[{"size":1,"type":"SSH"}] |
| add_disk[].size | int | - | - | 磁盘大小 |
| add_disk[].type | string | - | - | 磁盘类型 |
响应参数
| name | type | default | desc |
|---|---|---|---|
| price | string | - | 价格 |
| description | string | - | 生成的订单描述 |
| price_difference | string | - | 差价 |
| renew_price_difference | string | - | 续费差价 |
| base_price | string | - | 基础价格 |
| price_client_level_discount | string | - | 价格等级折扣 |
| price_difference_client_level_discount | string | - | 差价等级折扣 |
| renew_price_difference_client_level_discount | string | - | 续费差价等级折扣 |
生成购买磁盘订单
| 项目 | 内容 |
|---|---|
| 接口描述 | 生成购买磁盘订单 |
| 接口地址 | /console/v1/remf_cloud/:id/disk/order |
| 请求方式 | POST |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | require | 产品ID |
| remove_disk_id | array | - | - | 要取消订购的磁盘ID |
| add_disk | array | - | - | 新增磁盘大小参数,如:[{"size":1,"type":"SSH"}] |
| add_disk[].size | int | - | - | 磁盘大小 |
| add_disk[].type | string | - | - | 磁盘类型 |
响应参数
| name | type | default | desc |
|---|---|---|---|
| id | string | - | 订单ID |
获取磁盘扩容价格
| 项目 | 内容 |
|---|---|
| 接口描述 | 获取磁盘扩容价格 |
| 接口地址 | /console/v1/remf_cloud/:id/disk/resize |
| 请求方式 | POST |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | require | 产品ID |
| resize_data_disk[].id | int | - | - | 魔方云磁盘ID |
| resize_data_disk[].size | int | - | - | 磁盘大小 |
响应参数
| name | type | default | desc |
|---|---|---|---|
| price | string | - | 价格 |
| description | string | - | 生成的订单描述 |
| price_difference | string | - | 差价 |
| renew_price_difference | string | - | 续费差价 |
| base_price | string | - | 基础价格 |
| price_client_level_discount | string | - | 价格等级折扣 |
| price_difference_client_level_discount | string | - | 差价等级折扣 |
| renew_price_difference_client_level_discount | string | - | 续费差价等级折扣 |
生成磁盘扩容订单
| 项目 | 内容 |
|---|---|
| 接口描述 | 生成磁盘扩容订单 |
| 接口地址 | /console/v1/remf_cloud/:id/disk/resize/order |
| 请求方式 | POST |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | require | 产品ID |
| resize_data_disk[].id | int | - | - | 魔方云磁盘ID |
| resize_data_disk[].size | int | - | - | 磁盘大小 |
响应参数
| name | type | default | desc |
|---|---|---|---|
| id | string | - | 订单ID |
检查产品是够购买过镜像
| 项目 | 内容 |
|---|---|
| 接口描述 | 检查产品是够购买过镜像 |
| 接口地址 | /console/v1/remf_cloud/:id/image/check |
| 请求方式 | GET |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | require | 产品ID |
| image_id | int | - | require | 镜像ID |
响应参数
| name | type | default | desc |
|---|---|---|---|
| price | string | - | 需要支付的金额(0.00表示镜像免费或已购买) |
| description | string | - | 描述 |
| price_client_level_discount | string | - | 价格等级折扣 |
生成购买镜像订单
| 项目 | 内容 |
|---|---|
| 接口描述 | 生成购买镜像订单 |
| 接口地址 | /console/v1/remf_cloud/:id/image/order |
| 请求方式 | POST |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | require | 产品ID |
| image_id | int | - | require | 镜像ID |
响应参数
| name | type | default | desc |
|---|---|---|---|
| data.id | string | - | 订单ID |
获取快照/备份数量升降级价格
| 项目 | 内容 |
|---|---|
| 接口描述 | 获取快照/备份数量升降级价格 |
| 接口地址 | /console/v1/remf_cloud/:id/backup_config |
| 请求方式 | GET |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | require | 产品ID |
| type | string | - | require | 类型(snap=快照,backup=备份) |
| num | int | - | require | 数量 |
响应参数
| name | type | default | desc |
|---|---|---|---|
| price | string | - | 价格 |
| description | string | - | 描述 |
| price_difference | string | - | 差价 |
| renew_price_difference | string | - | 续费差价 |
| base_price | string | - | 基础价格 |
| price_client_level_discount | string | - | 价格等级折扣 |
| price_difference_client_level_discount | string | - | 差价等级折扣 |
| renew_price_difference_client_level_discount | string | - | 续费差价等级折扣 |
生成快照/备份数量升降级订单
| 项目 | 内容 |
|---|---|
| 接口描述 | 生成快照/备份数量升降级订单 |
| 接口地址 | /console/v1/remf_cloud/:id/backup_config/order |
| 请求方式 | POST |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | require | 产品ID |
| type | string | - | require | 类型(snap=快照,backup=备份) |
| num | int | - | require | 数量 |
响应参数
| name | type | default | desc |
|---|---|---|---|
| id | string | - | 订单ID |
获取附加IP价格
| 项目 | 内容 |
|---|---|
| 接口描述 | 获取附加IP价格 |
| 接口地址 | /console/v1/remf_cloud/:id/ip_num |
| 请求方式 | GET |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | require | 产品ID |
| ip_num | int | - | require | 附加IP数量 |
响应参数
| name | type | default | desc |
|---|---|---|---|
| price | string | - | 价格 |
| description | string | - | 生成的订单描述 |
| price_difference | string | - | 差价 |
| renew_price_difference | string | - | 续费差价 |
| base_price | string | - | 基础价格 |
| price_client_level_discount | string | - | 价格等级折扣 |
| price_difference_client_level_discount | string | - | 差价等级折扣 |
| renew_price_difference_client_level_discount | string | - | 续费差价等级折扣 |
生成附加IP订单
| 项目 | 内容 |
|---|---|
| 接口描述 | 生成附加IP订单 |
| 接口地址 | /console/v1/remf_cloud/:id/ip_num/order |
| 请求方式 | POST |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | require | 产品ID |
| ip_num | int | - | require | 附加IP数量 |
响应参数
| name | type | default | desc |
|---|---|---|---|
| id | string | - | 订单ID |
创建VPC网络
| 项目 | 内容 |
|---|---|
| 接口描述 | 创建VPC网络 |
| 接口地址 | /console/v1/remf_cloud/:id/vpc_network |
| 请求方式 | POST |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | require | 产品ID |
| name | string | - | require | VPC网络名称 |
| ips | string | - | - | IP段(cidr,如10.0.0.0/16,系统分配时不传) |
响应参数
| name | type | default | desc |
|---|---|---|---|
| id | int | - | VPC网络ID |
VPC网络列表
| 项目 | 内容 |
|---|---|
| 接口描述 | VPC网络列表 |
| 接口地址 | /console/v1/remf_cloud/:id/vpc_network |
| 请求方式 | GET |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | require | 产品ID |
| page | int | - | - | 页数 |
| limit | int | - | - | 每页条数 |
| orderby | string | - | - | 排序(id,name) |
| sort | string | - | - | 升降序(asc,desc) |
| downstream_client_id | int | - | - | 下游用户ID(api时可用) |
响应参数
| name | type | default | desc |
|---|---|---|---|
| list[].id | int | - | VPC网络ID |
| list[].name | string | - | VPC网络名称 |
| list[].ips | string | - | VPC网络网段 |
| count | int | - | 总条数 |
| list[].host[].id | int | - | 主机产品ID |
| list[].host[].name | string | - | 主机标识 |
| host | array | - | 可用产品ID(api时返回) |
修改VPC网络
| 项目 | 内容 |
|---|---|
| 接口描述 | 修改VPC网络 |
| 接口地址 | /console/v1/remf_cloud/:id/vpc_network/:vpc_network_id |
| 请求方式 | PUT |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | require | 产品ID |
| vpc_network_id | int | - | require | VPC网络ID |
| name | string | - | require | VPC网络名称 |
| downstream_client_id | int | - | - | 下游用户ID(api时可用) |
响应参数
| name | type | default | desc |
|---|---|---|---|
| name | string | - | 原VPC名称 |
删除VPC网络
| 项目 | 内容 |
|---|---|
| 接口描述 | 删除VPC网络 |
| 接口地址 | /console/v1/remf_cloud/:id/vpc_network/:vpc_network_id |
| 请求方式 | DELETE |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | require | 产品ID |
| vpc_network_id | int | - | require | VPC网络ID |
| downstream_client_id | int | - | - | 下游用户ID(api时可用) |
响应参数
无
切换实例VPC网络
| 项目 | 内容 |
|---|---|
| 接口描述 | 切换实例VPC网络 |
| 接口地址 | /console/v1/remf_cloud/:id/vpc_network |
| 请求方式 | PUT |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | require | 产品ID |
| vpc_network_id | int | - | require | 新VPCID |
| downstream_client_id | int | - | - | 下游用户ID(api时可用) |
响应参数
| name | type | default | desc |
|---|---|---|---|
| name | string | - | 变更后VPC网络名称 |
获取cpu/内存使用信息
| 项目 | 内容 |
|---|---|
| 接口描述 | 获取cpu/内存使用信息 |
| 接口地址 | /console/v1/remf_cloud/:id/real_data |
| 请求方式 | GET |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | require | 产品ID |
响应参数
| name | type | default | desc |
|---|---|---|---|
| cpu_usage | string | - | CPU使用率 |
| memory_total | string | - | 内存总量(‘-’代表获取不到) |
| memory_usable | string | - | 已用内存(‘-’代表获取不到) |
| memory_usage | string | - | 内存使用百分比(‘-1’代表获取不到) |
计算产品配置升级价格
| 项目 | 内容 |
|---|---|
| 接口描述 | 计算产品配置升级价格 |
| 接口地址 | /console/v1/remf_cloud/:id/common_config |
| 请求方式 | GET |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | require | 产品ID |
| cpu | int | - | require | 核心数 |
| memory | int | - | require | 内存 |
| bw | int | - | - | 带宽 |
| flow | int | - | - | 流量 |
| peak_defence | int | - | - | 防御峰值 |
响应参数
| name | type | default | desc |
|---|---|---|---|
| price | string | - | 价格 |
| description | string | - | 描述 |
| price_difference | string | - | 差价 |
| renew_price_difference | string | - | 续费差价 |
| price_client_level_discount | string | - | 价格等级折扣 |
| price_difference_client_level_discount | string | - | 差价等级折扣 |
| renew_price_difference_client_level_discount | string | - | 续费差价等级折扣 |
生成产品配置升级订单
| 项目 | 内容 |
|---|---|
| 接口描述 | 生成产品配置升级订单 |
| 接口地址 | /console/v1/remf_cloud/:id/common_config/order |
| 请求方式 | POST |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | require | 产品ID |
| cpu | int | - | require | 核心数 |
| memory | int | - | require | 内存 |
| bw | int | - | - | 带宽 |
| flow | int | - | - | 流量 |
| peak_defence | int | - | - | 防御峰值 |
响应参数
| name | type | default | desc |
|---|---|---|---|
| id | string | - | 订单ID |
获取线路配置
| 项目 | 内容 |
|---|---|
| 接口描述 | 获取线路配置 |
| 接口地址 | /console/v1/product/:id/remf_cloud/line/:line_id |
| 请求方式 | GET |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | require | 商品ID |
| line_id | int | - | require | 线路ID |
响应参数
| name | type | default | desc |
|---|---|---|---|
| bill_type | string | - | 计费类型(bw=带宽计费,flow=流量计费) |
| gpu_name | string | - | 显卡名称 |
| bw[].type | string | - | 配置方式(radio=单选,step=阶梯,total=总量) |
| bw[].value | int | - | 带宽 |
| bw[].min_value | int | - | 最小值 |
| bw[].max_value | int | - | 最大值 |
| bw[].step | int | - | 步长 |
| flow[].value | int | - | 流量 |
| defence[].value | int | - | 防御峰值(G) |
| ip[].value | int | - | IP数量 |
| gpu[].value | int | - | 显卡数量 |
验证下单
| 项目 | 内容 |
|---|---|
| 接口描述 | 验证下单 |
| 接口地址 | /console/v1/product/:id/remf_cloud/validate_settle |
| 请求方式 | POST |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | require | 商品ID |
| downstream_client_id | int | - | - | 下游用户ID(api时可用) |
| custom.duration_id | int | - | require | 周期ID |
| custom.recommend_config_id | int | - | - | 套餐ID |
| custom.data_center_id | int | - | - | 数据中心ID |
| custom.cpu | int | - | - | CPU |
| custom.memory | int | - | - | 内存 |
| custom.system_disk.size | int | - | - | 系统盘大小(G) |
| custom.system_disk.disk_type | string | - | - | 系统盘类型 |
| custom.data_disk[].size | int | - | - | 数据盘大小(G) |
| custom.data_disk[].disk_type | string | - | - | 数据盘类型 |
| custom.line_id | int | - | - | 线路ID |
| custom.bw | int | - | - | 带宽(Mbps) |
| custom.flow | int | - | - | 流量(G) |
| custom.peak_defence | int | - | - | 防御峰值(G) |
| custom.gpu_num | int | - | - | 显卡数量 |
| custom.image_id | int | - | - | 镜像ID |
| custom.backup_num | int | 0 | - | 备份数量 |
| custom.snap_num | int | 0 | - | 快照数量 |
| custom.ip_mac_bind_enable | int | 0 | - | 嵌套虚拟化(0=关闭,1=开启) |
| custom.ipv6_num_enable | int | 0 | - | 是否使用IPv6(0=关闭,1=开启) |
| custom.nat_acl_limit_enable | int | 0 | - | 是否启用NAT转发(0=关闭,1=开启) |
| custom.nat_web_limit_enable | int | 0 | - | 是否启用NAT建站(0=关闭,1=开启) |
| custom.resource_package_id | int | 0 | - | 资源包ID |
| custom.network_type | string | - | - | 网络类型(normal=经典网络,vpc=VPC网络) |
| custom.vpc.id | int | - | - | VPC网络ID |
| custom.vpc.ips | string | - | - | VPCIP段 |
响应参数
| name | type | default | desc |
|---|---|---|---|
| price | string | - | 价格 |
| renew_price | string | - | 续费价格 |
| billing_cycle | string | - | 周期 |
| duration | int | - | 周期时长 |
| description | string | - | 订单子项描述 |
| base_price | string | - | 基础价格 |
| billing_cycle_name | string | - | 周期名称多语言 |
| preview[].name | string | - | 配置项名称 |
| preview[].value | string | - | 配置项值 |
| preview[].price | string | - | 配置项价格 |
| discount | string | - | 用户等级折扣 |
| order_item[].type | string | - | 订单子项类型(addon_idcsmart_client_level=用户等级) |
| order_item[].rel_id | int | - | 关联ID |
| order_item[].amount | float | - | 子项金额 |
| order_item[].description | string | - | 子项描述 |
NAT转发列表
| 项目 | 内容 |
|---|---|
| 接口描述 | NAT转发列表 |
| 接口地址 | console/v1/remf_cloud/:id/nat_acl |
| 请求方式 | GET |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | require | 产品ID |
响应参数
| name | type | default | desc |
|---|---|---|---|
| list[].id | int | - | 转发ID |
| list[].name | string | - | 名称 |
| list[].ip | string | - | IP端口 |
| list[].int_port | int | - | 内部端口 |
| list[].protocol | int | - | 协议(1=tcp,2=udp,3=tcp+udp) |
| count | int | - | 总条数 |
创建NAT转发
| 项目 | 内容 |
|---|---|
| 接口描述 | 创建NAT转发 |
| 接口地址 | console/v1/remf_cloud/:id/nat_acl |
| 请求方式 | POST |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | require | 产品ID |
| name | string | - | require | 名称 |
| int_port | int | - | require | 内部端口 |
| protocol | int | - | require | 协议(1=tcp,2=udp,3=tcp+udp) |
| ext_port | int | - | - | 外部端口(0-65535除开80/443/22) |
响应参数
无
删除NAT转发
| 项目 | 内容 |
|---|---|
| 接口描述 | 删除NAT转发 |
| 接口地址 | console/v1/remf_cloud/:id/nat_acl |
| 请求方式 | DELETE |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | require | 产品ID |
| nat_acl_id | int | - | require | NAT转发ID |
响应参数
无
NAT建站列表
| 项目 | 内容 |
|---|---|
| 接口描述 | NAT建站列表 |
| 接口地址 | console/v1/remf_cloud/:id/nat_web |
| 请求方式 | GET |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | require | 产品ID |
响应参数
| name | type | default | desc |
|---|---|---|---|
| list[].id | int | - | 建站ID |
| list[].domain | string | - | 域名 |
| list[].ext_port | int | - | 外部端口 |
| list[].int_port | int | - | 内部端口 |
| count | int | - | 总条数 |
创建NAT建站
| 项目 | 内容 |
|---|---|
| 接口描述 | 创建NAT建站 |
| 接口地址 | console/v1/mf_cloud/:id/nat_web |
| 请求方式 | POST |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | require | 产品ID |
| domain | string | - | require | 域名 |
| int_port | int | - | require | 内部端口 |
响应参数
无
删除NAT建站
| 项目 | 内容 |
|---|---|
| 接口描述 | 删除NAT建站 |
| 接口地址 | console/v1/mf_cloud/:id/nat_web |
| 请求方式 | DELETE |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | require | 产品ID |
| nat_web_id | int | - | require | NAT建站ID |
响应参数
| name | type | default | desc |
|---|---|---|---|
| domain | string | - | 域名 |
获取可升降级套餐
| 项目 | 内容 |
|---|---|
| 接口描述 | 获取可升降级套餐 |
| 接口地址 | console/v1/remf_cloud/:id/recommend_config |
| 请求方式 | GET |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | require | 产品ID |
响应参数
| name | type | default | desc |
|---|---|---|---|
| list[].id | int | - | 套餐ID |
| list[].product_id | int | - | 商品ID |
| list[].name | string | - | 名称 |
| list[].description | string | - | 描述 |
| list[].order | int | - | 排序ID |
| list[].data_center_id | int | - | 数据中心ID |
| list[].cpu | int | - | CPU |
| list[].memory | int | - | 内存(GB) |
| list[].system_disk_size | int | - | 系统盘大小(GB) |
| list[].data_disk_size | int | - | 数据盘大小(GB) |
| list[].bw | int | - | 带宽(Mbps) |
| list[].peak_defence | int | - | 防御峰值(G) |
| list[].system_disk_type | string | - | 系统盘类型 |
| list[].data_disk_type | string | - | 数据盘类型 |
| list[].flow | int | - | 流量 |
| list[].line_id | int | - | 线路ID |
| list[].create_time | int | - | 创建时间 |
| list[].ip_num | int | - | IP数量 |
| list[].upgrade_range | int | - | 升降级范围(0=不可升降级,1=全部,2=自选) |
| list[].hidden | int | - | 是否隐藏(0=否,1=是) |
| list[].gpu_num | int | - | 显卡数量 |
| list[].gpu_name | string | - | 显卡名称 |
| count | int | - | 总条数 |
计算升降级套餐价格
| 项目 | 内容 |
|---|---|
| 接口描述 | 计算升降级套餐价格 |
| 接口地址 | console/v1/remf_cloud/:id/recommend_config/price |
| 请求方式 | GET |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | require | 产品ID |
| recommend_config_id | int | - | require | 套餐ID |
响应参数
| name | type | default | desc |
|---|---|---|---|
| price | string | - | 价格 |
| description | string | - | 描述 |
| price_difference | string | - | 差价 |
| renew_price_difference | string | - | 续费差价 |
| base_price | string | - | 基础价格 |
| price_client_level_discount | string | - | 价格等级折扣 |
| price_difference_client_level_discount | string | - | 差价等级折扣 |
| renew_price_difference_client_level_discount | string | - | 续费差价等级折扣 |
生成套餐升级订单
| 项目 | 内容 |
|---|---|
| 接口描述 | 生成套餐升级订单 |
| 接口地址 | console/v1/remf_cloud/:id/recommend_config/order |
| 请求方式 | POST |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | require | 产品ID |
| recommend_config_id | int | - | require | 套餐ID |
响应参数
| name | type | default | desc |
|---|---|---|---|
| id | string | - | 订单ID |
模拟物理机运行
| 项目 | 内容 |
|---|---|
| 接口描述 | 模拟物理机运行 |
| 接口地址 | /console/v1/remf_cloud/:id/simulate_physical_machine |
| 请求方式 | POST |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | require | 产品ID |
| simulate_physical_machine | int | - | require | 模拟物理机运行(0=关闭,1=开启) |
响应参数
无
IPv6列表
| 项目 | 内容 |
|---|---|
| 接口描述 | IPv6列表 |
| 接口地址 | /console/v1/remf_cloud/:id/ipv6 |
| 请求方式 | GET |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | require | 产品ID |
| page | int | 1 | - | 页数 |
| limit | int | 20 | - | 每页条数 |
响应参数
| name | type | default | desc |
|---|---|---|---|
| list[].ipv6 | string | - | IPv6地址 |
| count | int | - | 总条数 |
下载RDP
| 项目 | 内容 |
|---|---|
| 接口描述 | 下载RDP |
| 接口地址 | /console/v1/remf_cloud/:id/download_rdp |
| 请求方式 | GET |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | require | 产品ID |
响应参数
| name | type | default | desc |
|---|---|---|---|
| content | string | - | 下载RDP内容 |
| name | string | - | 下载文件名 |
计算套餐产品配置升级价格(未完成)
| 项目 | 内容 |
|---|---|
| 接口描述 | 计算套餐产品配置升级价格 |
| 接口地址 | /console/v1/remf_cloud/:id/package/config/price |
| 请求方式 | GET |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | require | 产品ID |
| ip_num | int | - | - | IPv4数量 |
| ipv6_num | int | - | - | IPv6数量 |
| flow | int | - | - | 流量 |
| bw | int | - | - | 带宽 |
| peak_defence | int | - | - | 防御峰值 |
| is_downstream | int | 0 | - | 是否下游发起(0=否,1=是) |
响应参数
| name | type | default | desc |
|---|---|---|---|
| price | string | - | 价格 |
| description | string | - | 描述 |
| price_difference | string | - | 差价 |
| renew_price_difference | string | - | 续费差价 |
| base_price | string | - | 基础价格 |
| price_client_level_discount | string | - | 价格等级折扣 |
| price_difference_client_level_discount | string | - | 差价等级折扣 |
| renew_price_difference_client_level_discount | string | - | 续费差价等级折扣 |
生成套餐产品配置升级订单(未完成)
| 项目 | 内容 |
|---|---|
| 接口描述 | 生成套餐产品配置升级订单 |
| 接口地址 | /console/v1/remf_cloud/:id/package/config/order |
| 请求方式 | POST |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | require | 产品ID |
| ip_num | int | - | - | IPv4数量 |
| ipv6_num | int | - | - | IPv6数量 |
| flow | int | - | - | 流量 |
| bw | int | - | - | 带宽 |
| peak_defence | int | - | - | 防御峰值 |
响应参数
| name | type | default | desc |
|---|---|---|---|
| id | int | - | 订单ID |
| amount | string | - | 订单价格 |
其他文档字段
json
{
"时间": "2025-01-13"
}获取升级防御配置
| 项目 | 内容 |
|---|---|
| 接口描述 | 获取升级防御配置 |
| 接口地址 | /console/v1/remf_cloud/:id/upgrade_defence_config |
| 请求方式 | GET |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | require | 产品ID |
| ip | string | - | require | IP |
响应参数
| name | type | default | desc |
|---|---|---|---|
| defence[].value | string | - | 防御 |
| defence[].desc | string | - | 防御显示 |
| current_defence | string | - | IP当前防御 |
计算升级防御价格
| 项目 | 内容 |
|---|---|
| 接口描述 | 计算升级防御价格 |
| 接口地址 | /console/v1/remf_cloud/:id/upgrade_defence/price |
| 请求方式 | GET |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | require | 产品ID |
| ip | string | - | require | IP |
| peak_defence | string | - | require | 防御峰值 |
响应参数
| name | type | default | desc |
|---|---|---|---|
| price | string | - | 价格 |
| description | string | - | 描述 |
| price_difference | string | - | 差价 |
| renew_price_difference | string | - | 续费差价 |
| base_price | string | - | 基础价格 |
| price_client_level_discount | string | - | 价格等级折扣 |
| price_difference_client_level_discount | string | - | 差价等级折扣 |
| renew_price_difference_client_level_discount | string | - | 续费差价等级折扣 |
生成升级防御订单
| 项目 | 内容 |
|---|---|
| 接口描述 | 生成升级防御订单 |
| 接口地址 | /console/v1/remf_cloud/:id/upgrade_defence/order |
| 请求方式 | POST |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | require | 产品ID |
| ip | string | - | require | IP |
| peak_defence | string | - | require | 防御峰值 |
响应参数
| name | type | default | desc |
|---|---|---|---|
| id | int | - | 订单ID |
| amount | string | - | 订单价格 |
其他文档字段
json
{
"时间": "2025-01-13"
}是否可以续费
| 项目 | 内容 |
|---|---|
| 接口描述 | 是否可以续费 |
| 接口地址 | /console/v1/remf_cloud/:id/whether_renew |
| 请求方式 | GET |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | require | 产品ID |
响应参数
无
实例流量数据
| 项目 | 内容 |
|---|---|
| 接口描述 | 实例流量数据 |
| 接口地址 | console/v1/remf_cloud/:id/flow_data |
| 请求方式 | GET |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | require | 产品ID |
| start_time | int | - | require | 开始时间 |
| end_time | int | - | - | 结束时间 |
响应参数
| name | type | default | desc |
|---|---|---|---|
| list[].time | string | - | 时间 |
| list[].in | float | - | 进流量 |
| list[].out | float | - | 出流量 |
| unit | string | - | 当前单位 |
流量包列表
| 项目 | 内容 |
|---|---|
| 接口描述 | 流量包列表 |
| 接口地址 | /console/v1/remf_cloud/:id/traffic_package |
| 请求方式 | GET |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | require | 产品ID |
| page | int | - | - | 页数 |
| limit | int | - | - | 每页条数 |
响应参数
| name | type | default | desc |
|---|---|---|---|
| list | array | - | 流量包列表 |
| list[].id | int | - | 流量包ID |
| list[].name | string | - | 流量包名称 |
| list[].size | int | - | 流量包大小(GB) |
| list[].used | float | - | 已使用(GB) |
| list[].expire_time | int | - | 到期时间(秒级时间戳,0表示不到期) |
| list[].expire_with_reset | int | - | 是否随重置过期(0=否,1=是) |
| list[].status | int | - | 状态(0=失效,1=有效) |
| list[].create_time | int | - | 创建时间(秒级时间戳) |
| count | int | - | 总条数 |
下游退款前验证
| 项目 | 内容 |
|---|---|
| 接口描述 | 下游退款前验证 |
| 接口地址 | /console/v1/remf_cloud/:id/check_refund |
| 请求方式 | GET |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | require | 产品ID |
响应参数
无