更新时间:2025-07-25 GMT+08:00
分享

查询物理服务器信息

功能介绍

Get imetal server by id

调用方法

请参见如何调用API

URI

GET /v1/{project_id}/physicalservers/{id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目ID

约束限制

不涉及

取值范围

账号的项目ID

默认取值

不涉及

id

String

参数解释

服务器ID

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

调用接口的认证方式分为Token,如果您使用的Token方式,此参数为必填,请填写Token的值

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

id

String

参数解释

服务器ID

约束限制

不涉及

取值范围

uuid格式

默认取值

不涉及

name

String

参数解释

物理服务器名称,在创建实例时作为hostname

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

project_id

String

参数解释

项目ID

约束限制

不涉及

取值范围

账号的项目ID

默认取值

不涉及

domain_id

String

参数解释

domain ID

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

manage_state

String

参数解释

服务器管理状态

约束限制

不涉及

取值范围

  • onboard:上架中,用户下单,完成LLD设计。

  • ready:交付完成,完成硬装、网调、服务器初始化、软调及转维验收。

  • in-use:使用中,用户发放裸机。

  • frozen:冻结,因欠费导致资源冻结。

  • offboarding:下架中。

默认取值

不涉及

power_state

String

参数解释

电源状态

power_state 会根据不同的操作和事件发生转换,常见的状态转换流程如下:

  • 开机流程:off -> powering-on -> on

  • 关机流程:on -> powering-off -> off

  • 重启流程:on -> rebooting -> on

约束限制

不涉及

取值范围

  • on:表示节点的电源已开启,硬件处于通电状态,操作系统正在运行或者可以正常启动。这意味着节点能够执行计算任务,为上层应用提供服务。

  • off:表明节点的电源已关闭,硬件停止供电,所有组件处于非工作状态,无法执行任何计算任务。

  • rebooting:节点正在进行重启操作,即先关闭电源,然后再重新开启。在这个过程中,节点会经历硬件初始化和操作系统启动等步骤。

  • powering-on:节点正在开启电源的过程中,此时硬件开始通电,但操作系统可能还未完全启动。

  • powering-off:节点正在关闭电源的过程中,操作系统会进行一些清理工作,如保存数据、关闭服务等,然后切断硬件的电源供应。

示例场景:当用户在 Ironic 中创建并激活一个节点,或者手动开启节点电源后,节点的 power_state 会变为 power on。

示例场景:在维护节点或者不需要使用节点资源时,管理员可以将节点的电源关闭,此时 power_state 变为 power off。

示例场景:当管理员通过 Ironic API 发送重启节点的指令后,节点的 power_state 会暂时变为 rebooting,直到重启完成。

示例场景:当管理员发送开机指令后,节点会进入 powering on 状态,直到操作系统成功启动,power_state 变为 power on。

示例场景:当管理员发送关机指令后,节点会进入 powering off 状态,直到电源完全关闭,power_state 变为 off。

默认取值

不涉及

health_state

String

参数解释

硬件健康状态

约束限制

不涉及

取值范围

  • OK:健康

  • Warning:警告

  • Critical:严重

  • Unknown:未知

默认取值

不涉及

onboard_time

String

参数解释

上架时间

约束限制

不涉及

取值范围

使用RFC 3339格式,例如:2025-04-22T12:03:18.50083+08:00

默认取值

不涉及

location

Location object

参数解释

物理服务器部署位置信息

约束限制

不涉及

hardware_attributes

HardwareSummary object

参数解释

硬件总览信息,包括服务器的制造商、型号、序列号等

约束限制

不涉及

tags

Array of Tag objects

参数解释

标签

约束限制

不涉及

error

ErrorStatus object

参数解释

失败时返回的错误对象

约束限制

不涉及

表4 Location

参数

参数类型

描述

dc

String

参数解释

机房名称

约束限制

不涉及

取值范围

只能由中文字符、英文字母(a~z,A~Z)、数字(0~9)、下划线(_)、中划线(-)、点(.)组成,且大小不超过256字节

默认取值

不涉及

rack

String

参数解释

机柜名称

约束限制

不涉及

取值范围

由英文字母(a~z,A~Z)、数字(0~9)、下划线(_)、中划线(-)、点(.)组成,不能以中划线或者点开头,且大小不超过128字节

默认取值

不涉及

unit

String

参数解释

机柜U位

约束限制

不涉及

取值范围

大小不超过128字节

默认取值

不涉及

表5 HardwareSummary

参数

参数类型

描述

sn

String

参数解释

serial number

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

manufacturer

String

参数解释

制造商

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

model

String

参数解释

型号

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

main_board_manufacturer

String

参数解释

主板厂商

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

表6 Tag

参数

参数类型

描述

key

String

参数解释

标签key值

约束限制

不涉及

取值范围

  • 不能为空且首尾不能包含空格,最多支持128个字符

  • 可用UTF-8格式表示的任意语种字母、数字和空格

  • 支持部分特殊字符:_.:=+-@

  • 不能以"sys"开头

默认取值

不涉及

value

String

参数解释

标签value值

约束限制

不涉及

取值范围

  • 可以为空但不能缺省,最多支持255个字符

  • 可用UTF-8格式表示的汉字、字母、数字和空格

  • 支持部分特殊字符:_.:/=+-@

默认取值

不涉及

表7 ErrorStatus

参数

参数类型

描述

error_code

String

参数解释

错误码

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

error_msg

String

参数解释

错误描述

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

error_type

String

参数解释

错误类型

约束限制

不涉及

取值范围

  • create_instance_error:创建实例异常

  • delete_instance_error:删除实例异常

  • reinstall_error:重装OS异常

  • modify_ip_error:修改IP异常

  • verify_server_error:验证服务器异常

  • delete_server_error:删除服务器异常

默认取值

不涉及

状态码:400

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

错误码

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

error_msg

String

参数解释

错误描述

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

状态码:401

表9 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

错误码

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

error_msg

String

参数解释

错误描述

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

状态码:429

表10 响应Body参数

参数

参数类型

描述

-

String

-

状态码:500

表11 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

错误码

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

error_msg

String

参数解释

错误描述

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

请求示例

查询物理服务器信息

GET https://{endpoint}/v1/{project_id}/physicalservers/{id}

响应示例

状态码:200

返回物理服务器信息

{
  "id" : "0197ee54-53de-78fe-94dd-a6684e4a85ee",
  "name" : "CloudDC-Jarvis-147",
  "project_id" : "e750c9499ffb4244add7398a0af4f215",
  "domain_id" : "aef171e13fe24458a819bb42870571d9",
  "manage_state" : "ready",
  "power_state" : "off",
  "health_state" : "OK",
  "onboard_time" : "2025-07-09T16:36:33.374276+08:00",
  "location" : {
    "dc" : "BBB",
    "rack" : "AAA",
    "unit" : "19"
  },
  "hardware_attributes" : {
    "sn" : "CloudDC-Jarvis-147",
    "manufacturer" : "Huawei",
    "model" : "NV602x1x99x3"
  },
  "tags" : [ {
    "key" : "chennantest",
    "value" : "1223"
  }, {
    "key" : "QQ",
    "value" : "QQ"
  } ],
  "ops_result" : "Uninstalling",
  "az_id" : "",
  "region_id" : "",
  "bmc_firmware_version" : ""
}

状态码

状态码

描述

200

返回物理服务器信息

400

请求参数错误,请求失败

401

请求未鉴权

429

请求过载

500

服务端内部错误

错误码

请参见错误码

相关文档