GET 产品详情
接口概览
| 项目 | 内容 |
|---|---|
| 文档类型 | 前台接口 |
| 请求方式 | GET |
| 接口地址 | /console/v1/host/{id} |
| 所属业务 | 产品管理 |
| 来源模块/系统 | 产品管理 |
| 认证方式 | Bearer Token（用户令牌） |
完整请求
请求
正在加载示例…失败请求
正在加载示例…接口说明
产品详情
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| id | path | integer(int32) | 是 | 产品ID |
成功响应
正在加载示例…失败响应 400：请求参数或业务校验失败
正在加载示例…失败响应 401：未认证或登录已失效
正在加载示例…失败响应 403：无权执行当前操作
正在加载示例…失败响应 404：接口或业务资源不存在
正在加载示例…失败响应 500：服务器内部错误
正在加载示例…响应状态
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功响应 | 内联对象 |
| 400 | Bad Request | 请求参数或业务校验失败 | 内联对象 |
| 401 | Unauthorized | 未认证或登录已失效 | 内联对象 |
| 403 | Forbidden | 无权执行当前操作 | 内联对象 |
| 404 | Not Found | 接口或业务资源不存在 | 内联对象 |
| 500 | Internal Server Error | 服务器内部错误 | 内联对象 |
响应参数
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| status | integer(int32) | 否 | — | — | 状态码 |
| msg | string | 否 | — | — | 提示信息 |
| data | object | 否 | — | — | — |
| data.host | object | 否 | — | — | 产品 |
| data.host.id | integer(int32) | 否 | — | — | 产品ID |
| data.host.order_id | integer(int32) | 否 | — | — | 订单ID |
| data.host.product_id | integer(int32) | 否 | — | — | 商品ID |
| data.host.name | string | 否 | — | — | 标识 |
| data.host.first_payment_amount | string | 否 | — | — | 订购金额 |
| data.host.renew_amount | string | 否 | — | — | 续费金额 |
| data.host.billing_cycle | string | 否 | — | — | 计费周期 |
| data.host.billing_cycle_name | string | 否 | — | — | 模块计费周期名称 |
| data.host.billing_cycle_time | string | 否 | — | — | 模块计费周期时间,秒 |
| data.host.active_time | integer(int32) | 否 | — | — | 开通时间 |
| data.host.due_time | integer(int32) | 否 | — | — | 到期时间 |
| data.host.status | string | 否 | — | — | 状态Unpaid未付款Pending开通中Active已开通Suspended已暂停Deleted已删除Failed开通失败 |
| data.host.suspend_type | string | 否 | — | — | 暂停类型,overdue到期暂停,overtraffic超流暂停,certification_not_complete实名未完成,other其他 |
| data.host.suspend_reason | string | 否 | — | — | 暂停原因 |
| data.host.ratio_renew | integer(int32) | 否 | — | — | 是否开启比例续费:0否,1是 |
| data.host.base_price | string | 否 | — | — | 购买周期原价 |
| data.host.product_name | string | 否 | — | — | 商品名称 |
| data.host.agent | integer(int32) | 否 | — | — | 代理产品0否1是 |
| data.host.upstream_host_id | string | 否 | — | — | 上游产品ID |
| data.host.base_info | string | 否 | — | — | 产品基础信息 |
| data.host.auto_release_time | integer(int32) | 否 | — | — | 自动释放时间(0=未设置过) |
| data.host.keep_time_price | string | 否 | — | — | 保留期价格 |
| data.host.on_demand_flow_price | string | 否 | — | — | 按需流量价格 |
| data.host.on_demand_billing_cycle_unit | string | 否 | — | — | 出账周期单位(hour=每小时,day=每天,month=每月) |
| data.host.on_demand_billing_cycle_day | integer(int32) | 否 | — | — | 出账周期号数 |
| data.host.on_demand_billing_cycle_point | string | 否 | — | — | 出账周期时间点(如00:00) |
| data.host.change_billing_cycle_id | integer(int32) | 否 | — | — | 是否申请了到期转按需(0=否,>0是,申请了不能执行续费/升降级操作) |
| data.host.addition | object | 否 | — | — | — |
| data.host.addition.country_id | integer(int32) | 否 | — | — | 国家ID |
| data.host.addition.city | string | 否 | — | — | 城市 |
| data.host.addition.area | string | 否 | — | — | 区域 |
| data.host.addition.image_icon | string | 否 | — | — | 镜像图标(Windows,CentOS,Ubuntu,Debian,ESXi,XenServer,FreeBSD,Fedora,ArchLinux,Rocky,AlmaLinux,OpenEuler,RedHat,其他) |
| data.host.addition.image_name | string | 否 | — | — | 镜像名称 |
| data.host.addition.username | string | 否 | — | — | 实例用户名 |
| data.host.addition.password | string | 否 | — | — | 实例密码 |
| data.host.addition.port | integer(int32) | 否 | — | — | 端口 |
| data.host.product_on_demand | object | 否 | — | — | — |
| data.host.product_on_demand.client_auto_delete | integer(int32) | 否 | — | — | 允许用户设置自动释放(0=否,1=是) |
| data.host.product_on_demand.on_demand_to_duration | integer(int32) | 否 | — | — | 允许按需转包年包月(0=否,1=是) |
| data.host.product_on_demand.duration_to_on_demand | integer(int32) | 否 | — | — | 允许包年包月/试用转按需(0=否,1=是) |
| data.host.renew_forbidden | integer(int32) | 否 | — | — | 是否禁止续费 0允许 1禁止 |
| data.notes | string | 否 | — | — | 备注 |
| data.self_defined_field | [object] | 否 | — | — | — |
| data.self_defined_field[].id | integer(int32) | 否 | — | — | 自定义字段ID |
| data.self_defined_field[].field_name | string | 否 | — | — | 字段名称 |
| data.self_defined_field[].field_type | string | 否 | — | — | 字段类型(text=文本框,link=链接,password=密码,dropdown=下拉,checkbox=勾选框,textarea=文本区) |
| data.self_defined_field[].value | string | 否 | — | — | 当前值 |
失败状态码 400、401、403、404、500 共用以下结构：
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| status | integer(int32) | 是 | — | — | 错误状态码 |
| msg | string | 是 | — | — | 错误提示 |