智简魔方文档

GET 获取实例详情

接口概览

项目内容
文档类型前台接口
请求方式GET
接口地址/console/v1/mf_cloud/{id}
所属业务模块
来源模块/系统魔方云(自定义配置)
认证方式Bearer Token(用户令牌)

完整请求

请求

bash
正在加载示例…

失败请求

bash
正在加载示例…

接口说明

获取实例详情

请求参数

名称位置类型必选说明
idpathinteger(int32)产品ID

成功响应

json
正在加载示例…

失败响应 400:请求参数或业务校验失败

json
正在加载示例…

失败响应 401:未认证或登录已失效

json
正在加载示例…

失败响应 403:无权执行当前操作

json
正在加载示例…

失败响应 404:接口或业务资源不存在

json
正在加载示例…

失败响应 500:服务器内部错误

json
正在加载示例…

响应状态

状态码状态码含义说明数据模型
200OK成功响应内联对象
400Bad Request请求参数或业务校验失败内联对象
401Unauthorized未认证或登录已失效内联对象
403Forbidden无权执行当前操作内联对象
404Not Found接口或业务资源不存在内联对象
500Internal Server Error服务器内部错误内联对象

响应参数

状态码 200

名称类型必选约束中文名说明
statusinteger(int32)状态码
msgstring提示信息
dataobject
data.typestring类型(host=KVM加强版,lightHost=KVM轻量版,hyperv=Hyper-V)
data.order_idinteger(int32)订单ID
data.ipstringIP地址
data.ip_numinteger(int32)附加IPv4数量
data.ipv6_numinteger(int32)附加IPv6数量
data.backup_numinteger(int32)允许备份数量
data.snap_numinteger(int32)允许快照数量
data.power_statusstring电源状态(on=开机,off=关机,operating=操作中,fault=故障)
data.cpustringCPU
data.memoryinteger(int32)内存
data.system_diskobject
data.system_disk.sizeinteger(int32)系统盘大小(G)
data.system_disk.typestring系统盘类型
data.lineobject
data.line.idinteger(int32)线路ID
data.line.namestring线路名称
data.line.bill_typestring计费类型(bw=带宽计费,flow=流量计费)
data.line.sync_firewall_ruleinteger(int32)同步防火墙规则(0=关闭,1=开启)
data.bwinteger(int32)带宽
data.peak_defenceinteger(int32)防御峰值(G)
data.network_typestring网络类型(normal=经典网络,vpc=VPC网络)
data.gpustring显卡
data.usernamestring用户名
data.passwordstring密码
data.data_centerobject
data.data_center.idinteger(int32)数据中心ID
data.data_center.citystring城市
data.data_center.areastring区域
data.data_center.countrystring国家
data.data_center.isostring图标
data.imageobject
data.image.idinteger(int32)镜像ID
data.image.namestring镜像名称
data.image.image_group_idinteger(int32)镜像分组ID
data.image.image_group_namestring镜像分组
data.image.iconstring图标
data.ssh_keyobject
data.ssh_key.idinteger(int32)SSH密钥ID
data.ssh_key.namestringSSH密钥名称
data.nat_acl_limitinteger(int32)NAT转发数量
data.nat_web_limitinteger(int32)NAT建站数量
data.configobject
data.config.reinstall_sms_verifyinteger(int32)重装短信验证(0=不启用,1=启用)
data.config.reset_password_sms_verifyinteger(int32)重置密码短信验证(0=不启用,1=启用)
data.config.manual_manageinteger(int32)手动管理商品(0=关闭,1=开启)
data.config.simulate_physical_machine_enableinteger(int32)模拟物理机运行(0=关闭,1=开启)
data.config.show_panel_password_enableinteger(int32)前台显示面板密码(0=关闭,1=开启)
data.security_groupobject
data.security_group.idinteger(int32)关联的安全组ID(0=没关联)
data.security_group.namestring关联的安全组名称
data.recommend_configobject
data.recommend_config.idinteger(int32)套餐ID(有表示是套餐)
data.recommend_config.product_idinteger(int32)商品ID
data.recommend_config.namestring套餐名称
data.recommend_config.descriptionstring套餐描述
data.recommend_config.orderinteger(int32)排序
data.recommend_config.data_center_idinteger(int32)数据中心ID
data.recommend_config.cpuinteger(int32)CPU
data.recommend_config.memoryinteger(int32)内存(GB)
data.recommend_config.system_disk_sizeinteger(int32)系统盘大小(G)
data.recommend_config.data_disk_sizeinteger(int32)数据盘大小(G)
data.recommend_config.bwinteger(int32)带宽
data.recommend_config.peak_defenceinteger(int32)防御峰值(G)
data.recommend_config.system_disk_typestring系统盘类型
data.recommend_config.data_disk_typestring数据盘类型
data.recommend_config.flowinteger(int32)流量
data.recommend_config.line_idinteger(int32)线路ID
data.recommend_config.create_timeinteger(int32)创建时间
data.recommend_config.ip_numinteger(int32)IP数量
data.recommend_config.upgrade_rangeinteger(int32)升降级范围(0=不可升降级,1=全部,2=自选)
data.recommend_config.hiddeninteger(int32)是否隐藏(0=否,1=是)
data.recommend_config.gpu_numinteger(int32)显卡数量
data.data_diskobject
data.data_disk.countinteger(int32)数据盘数量
data.data_disk.total_sizeinteger(int32)数据盘总大小
data.support_apply_for_suspendinteger(int32)是否支持申请停用(0=否,1=是)
data.vpc_private_ipstringVPC内网IP
data.backup_modestring备份模式(空字符串=未设置,count=数量模式,space=备份空间模式)
data.backup_cart_urlstring订购备份空间链接(空表示没有可订购的)

失败状态码 400、401、403、404、500 共用以下结构:

名称类型必选约束中文名说明
statusinteger(int32)错误状态码
msgstring错误提示