GET 产品详情
接口概览
| 项目 | 内容 |
|---|---|
| 文档类型 | 后台接口 |
| 请求方式 | GET |
| 接口地址 | /DIR_ADMIN/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
| 名称 | 类型 | 必选 | 约束 | 说明 |
|---|---|---|---|---|
host | object | 否 | — | 产品 |
host.id | integer(int32) | 否 | — | 产品ID |
host.order_id | integer(int32) | 否 | — | 订单ID |
host.product_id | integer(int32) | 否 | — | 商品ID |
host.server_id | integer(int32) | 否 | — | 接口ID |
host.name | string | 否 | — | 标识 |
host.notes | string | 否 | — | 备注 |
host.first_payment_amount | string | 否 | — | 订购金额 |
host.renew_amount | string | 否 | — | 续费金额 |
host.billing_cycle | string | 否 | — | 计费周期 |
host.billing_cycle_name | string | 否 | — | 模块计费周期名称 |
host.billing_cycle_time | string | 否 | — | 模块计费周期时间 |
host.active_time | integer(int32) | 否 | — | 开通时间 |
host.due_time | integer(int32) | 否 | — | 到期时间 |
host.status | string | 否 | — | 状态 Unpaid未付款 Pending开通中 Active已开通 Suspended已暂停 Deleted已删除 Failed开通失败 Grace宽限 Keep保留 |
host.suspend_type | string | 否 | — | 暂停类型 overdue到期暂停 overtraffic超流暂停 certification_not_complete实名未完成 other其他 |
host.suspend_reason | string | 否 | — | 暂停原因 |
host.client_notes | string | 否 | — | 用户备注 |
host.ratio_renew | integer(int32) | 否 | — | 是否开启比例续费 0否 1是 |
host.base_price | string | 否 | — | 购买周期原价 |
host.product_name | string | 否 | — | 商品名称 |
host.agent | integer(int32) | 否 | — | 代理产品 0否 1是 |
host.upstream_host_id | string | 否 | — | 上游产品ID |
host.mode | string | 否 | — | 商品代理模式 only_api仅调用接口 sync同步商品 |
host.renew_forbidden | integer(int32) | 否 | — | 是否禁止续费 0允许 1禁止 |
host.keep_time_price | string | 否 | — | 保留期价格 |
host.on_demand_flow_price | string | 否 | — | 按需流量价格 |
host.on_demand_billing_cycle_unit | string | 否 | — | 出账周期单位 hour每小时 day每天 month每月 |
host.on_demand_billing_cycle_day | integer(int32) | 否 | — | 出账周期号数 |
host.on_demand_billing_cycle_point | string | 否 | — | 出账周期时间点 如00:00 |
host.addition | object | 否 | — | — |
host.addition.country_id | integer(int32) | 否 | — | 国家ID |
host.addition.city | string | 否 | — | 城市 |
host.addition.area | string | 否 | — | 区域 |
host.addition.image_icon | string | 否 | — | 镜像图标 |
host.addition.image_name | string | 否 | — | 镜像名称 |
status | [string] | integer(int32) | 否 | — | 状态列表 |
self_defined_field | [object] | 否 | — | — |
self_defined_field[].id | integer(int32) | 否 | — | 自定义字段ID |
self_defined_field[].field_name | string | 否 | — | 字段名称 |
self_defined_field[].field_type | string | 否 | — | 字段类型 text文本框 link链接 password密码 dropdown下拉 checkbox勾选框 textarea文本区 |
self_defined_field[].description | string | 否 | — | 字段描述 |
self_defined_field[].field_option | string | 否 | — | 下拉选项 |
self_defined_field[].is_required | integer(int32) | 否 | — | 是否必填 0否 1是 |
self_defined_field[].value | string | 否 | — | 当前值 |
msg | string | 否 | — | 提示信息 |
data | object | 否 | — | — |
data.host | object | 否 | — | — |
data.status | [string] | 否 | — | — |
data.self_defined_field | [任意类型] | 否 | — | — |
失败状态码 400、401、403、404、500 共用以下结构：
| 名称 | 类型 | 必选 | 约束 | 说明 |
|---|---|---|---|---|
status | integer(int32) | 是 | — | 错误状态码 |
msg | string | 是 | — | 错误提示 |