智简魔方文档

GET 获取实例详情

接口概览

项目内容
文档类型前台接口
请求方式GET
接口地址/console/v1/remf_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.ipstring否——IP 地址
data.ip_numinteger(int32)否——附加 IP 数量
data.backup_numinteger(int32)否——允许备份数量
data.snap_numinteger(int32)否——允许快照数量
data.power_statusstring否——电源状态(on=开机,off=关机,operating=操作中,fault=故障)
data.cpustring | integer否——CPU
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否———
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_namestring否——镜像分组
data.image.iconstring否——图标
data.image.image_group_idinteger否———
data.ssh_keyobject否———
data.ssh_key.idinteger(int32)否——SSH密钥 ID
data.ssh_key.namestring否——SSH密钥名称
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否———
data.config.simulate_physical_machine_enableinteger否———
data.config.show_panel_password_enable任意类型否———
data.config.manual_resource_control_modestring否———
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.ipv6_numinteger否———
data.data_diskobject否———
data.data_disk.countinteger是———
data.data_disk.total_sizeinteger是———
data.custom_show[任意类型]否———
data.support_apply_for_suspendinteger否———
data.vpc_private_ipstring否———
data.backup_modestring否———
data.backup_cart_urlstring否———

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

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