GET 获取实例详情
接口概览
| 项目 | 内容 |
|---|---|
| 文档类型 | 前台接口 |
| 请求方式 | GET |
| 接口地址 | /console/v1/rewhmcs_dcim/{id} |
| 所属业务 | 模块 |
| 来源模块/系统 | DCIM 代理(WHMCS) |
| 认证方式 | 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.serverid | integer(int32) | 否 | — | — | 服务器 ID |
| data.server | object | 否 | — | — | 服务器 |
| data.server.id | string | 否 | — | — | 服务器 ID |
| data.server.wltag | string | 否 | — | — | 物理标签 |
| data.server.osname | string | 否 | — | — | 操作系统 |
| data.server.power | string | 否 | — | — | 电源状态 |
| data.server.power_msg | string | 否 | — | — | 电源状态描述 |
| data.server.osusername | string | 否 | — | — | 操作系统用户名 |
| data.server.ospassword | string | 否 | — | — | 操作系统密码 |
| data.server.crack_success_info | string | 否 | — | — | 破解密码信息 |
| data.server.crack_user | string | 否 | — | — | 破解用户 |
| data.server.default_user | string | 否 | — | — | 默认用户 |
| data.server.ippassword | string | 否 | — | — | 面板密码 |
| data.server.port | string | 否 | — | — | 端口 |
| data.server.main_ip | string | 否 | — | — | 主 IP |
| data.server.configoptionsupgrade | string | 否 | — | — | 支持升降级0否1是 |
| data.ip | [object] | 否 | — | — | 附加 IP |
| data.ip[].ipaddress | string | 否 | — | — | IP 地址 |
| data.ip[].subnetmask | string | 否 | — | — | 子网掩码 |
| data.ip[].gateway | string | 否 | — | — | 网关 |
| data.configoptions | object | 否 | — | — | 当前配置 |
| data.configoptions.area | object | 否 | — | — | — |
| data.configoptions.area.name | object | 否 | — | — | 配置area对应的名称 |
| data.configoptions.area.value | object | 否 | — | — | 配置area对应的值 |
| data.oldconfigoptions | object | 否 | — | — | 当前配置 ID对应的值,例如{"1":1,"2":2} |
| data.customfields | object | 否 | — | — | 自定义字段 |
失败状态码 400、401、403、404、500 共用以下结构：
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| status | integer(int32) | 是 | — | — | 错误状态码 |
| msg | string | 是 | — | — | 错误提示 |