4.3 裸金属服务器生命周期管理
4.3.2 查询裸金属服务器详情
功能介绍
获取裸金属服务器的详细信息。
该接口支持查询裸金属服务器的计费方式，以及是否被冻结。
调试
您可以在API Explorer中调试该接口。
URI
GET 参数说明请参见表4-20。
/v1/{project_id}/baremetalservers/{server_id}
表4-20 参数说明
参数 是否必选 描述
project_id 是 项目ID。
获取方式请参见获取项目ID。
server_id 是 裸金属服务器ID。
可以从裸金属服务器控制台查询，或者 通过调用查询裸金属服务器列表
（OpenStack原生）API获取。
请求消息
● 请求参数 无
● 请求样例
GET https://{BMS Endpoint}/v1/bbf1946d374b44a0a2a95533562ba954/baremetalservers/
53206ed0-56de-4d6b-b7ee-ffc62ca26f43
响应消息
● 响应参数
参数 参数类型 描述
server Object 裸金属服务器信息。详情请参见表 4-21。
表4-21 server 字段数据结构说明
参数 参数类型 描述
id String 裸金属服务器ID，格式为UUID。
user_id String 创建裸金属服务器的用户ID，格式为 UUID。
name String 裸金属服务器名称。
created String 裸金属服务器创建时间。
时间戳格式为ISO 8601：YYYY-MM-DDTHH:MM:SSZ，例如：
2019-05-22T03:30:52Z updated String 裸金属服务器更新时间。
时间戳格式为ISO 8601：YYYY-MM-DDTHH:MM:SSZ，例如：
2019-05-22T04:30:52Z
tenant_id String 裸金属服务器所属租户ID，格式为 UUID。
该参数和project_id表示相同的概念。
hostId String 裸金属服务器对应的主机ID。
addresses Object 裸金属服务器所属网络信息。
● key：表示裸金属服务器使用的虚 拟私有云的ID。
● value：网络详细信息，具体请参见 表4 address数据结构说明。
key_name String 裸金属服务器使用的密钥对名称。
image Object 裸金属服务器镜像信息。详情请参见
表5 image数据结构说明。
flavor Object 裸金属服务器规格信息。详情请参见 表6 flavor数据结构说明。
security_groups Array of objects 裸金属服务器所属安全组。详情请参 见表7 security_groups数据结构说 明。
参数 参数类型 描述 accessIPv4 String 预留属性。
accessIPv6 String 预留属性。
status String 裸金属服务器当前状态信息。
取值范围：
● ACTIVE：运行中/正在关机/删除中
● BUILD：创建中
● ERROR：故障
● HARD_REBOOT：强制重启中
● REBOOT：重启中
● DELETED：实例已被正常删除
● SHUTOFF：关机/正在开机/删除 中/重建中/重装操作系统中/重装操 作系统失败/冻结
progress Integer 预留属性。
config_drive String 是否为裸金属服务器配置config drive 分区。
取值为：True或空字符串
metadata Object 裸金属服务器元数据。详情参见表11 metadata数据结构说明。
说明
元数据包含系统默认添加字段和用户设置 的字段。
OS-EXT-STS:task_state String 扩展属性，裸金属服务器当前的任务 状态。例如：
● rebooting：重启中
● reboot_started：普通重启
● reboot_started_hard：强制重启
● powering-off：关机中
● powering-on：开机中
● rebuilding：重建中
● scheduling：调度中
● deleting：删除中
OS-EXT-STS:vm_state String 扩展属性，裸金属服务器的稳定状 态。例如：
● active：运行中
● shutoff：关机
● suspended：暂停
● reboot：重启
参数 参数类型 描述
OS-EXT-SRV-ATTR:host String 扩展属性，裸金属服务器宿主机名 称。
OS-EXT-STS:power_state Integer 扩展属性，裸金属服务器电源状态。
例如：
OS-DCF:diskConfig String 扩展属性，磁盘配置，取值为以下两 种：
fault Object 裸金属服务器故障原因。详情请参见
表4-27。
OS-SRV-USG:launched_at String 裸金属服务器启动时间。
时间戳格式为ISO 8601，例如：
Array of objects 挂载到裸金属服务器上的磁盘。详情 请参见表9
os-extended-volumes:volumes_attached 数据结 构说明。
description String 裸金属服务器的描述信息。
参数 参数类型 描述
host_status String 裸金属服务器宿主机状态。
● UP：服务正常
OS-EXT-SRV-ATTR:hostname String 裸金属服务器的主机名。
OS-EXT-SRV-ATTR:kernel_id String 若使用AMI格式的镜像，则表示kernel image的UUID；否则，留空。
OS-EXT-SRV-ATTR:ramdisk_id String 若使用AMI格式镜像，则表示ramdisk image的UUID；否则，留空。
OS-EXT-SRV-ATTR:user_data String 创建裸金属服务器时指定的
user_data，取值为base64编码后的结 果或空字符串。
locked Boolean 裸金属服务器是否为锁定状态。
● true：锁定
● false：未锁定 tags Array of strings 裸金属服务器标签。
os:scheduler_hint
s Object 裸金属服务器调度信息。详情请参见
表10 os:scheduler_hints 数据结构说 明。
enterprise_project
_id String 裸金属服务器所属的企业项目ID。
sys_tags Array of objects 裸金属服务器系统标签。详情请参见 表12 sys_tags数据结构说明。
表4-22 address 数据结构说明
参数 参数类型 描述
version String IP地址版本。
● 4：代表IPv4。
● 6：代表IPv6。
addr String IP地址。
OS-EXT-IPS:type String IP地址类型。
● fixed：代表私有IP地址。
● floating：代表弹性IP地址。
OS-EXT-IPS-MAC:mac_addr String MAC地址。
OS-EXT-IPS:port_id String IP地址对应的端口ID。
表4-23 image 数据结构说明
参数 参数类型 描述
id String 镜像ID，格式为UUID。
name String 镜像的名称。
__os_type String 镜像的类型。
取值为：
● Linux（包括SUSE/RedHat/
CentOS/Oracle Linux/EulerOS/
Ubuntu操作系统）
● Windows（Windows操作系统）
● Other（ESXi操作系统）
links Array of objects 镜像相关快捷链接地址。详情请参 见表4-24。
表4-24 links 数据结构说明
参数 参数类型 描述
rel String 快捷链接标记名称。
href String 对应快捷链接。
表4-25 flavor 数据结构说明
参数 参数类型 描述
id String 裸金属服务器规格ID。
name String 裸金属服务器规格名称。
disk String 该裸金属服务器规格对应要求系统
盘大小，0为不限制。
vcpus String 该裸金属服务器规格对应的CPU核
数。
ram String 该裸金属服务器规格对应的内存大
小，单位为MB。
表4-26 security_groups 数据结构说明
参数 参数类型 描述
name String 安全组名称。
id String 安全组ID。
表4-27 fault 数据结构说明
参数 参数类型 描述
message String 故障信息。
code Integer 故障代码。
details String 故障详情。
created String 故障时间，ISO 8601格式。
表4-28 os-extended-volumes:volumes_attached 数据结构说明
参数 参数类型 描述
id String 磁盘ID，格式为UUID。
delete_on_termina
tion String 删除裸金属服务器时是否一并删除
该磁盘。
● true：是
● false：否
bootIndex String 启动标识，“0”代表启动盘，
“-1“代表非启动盘。
参数 参数类型 描述
device String 磁盘设备名称，例如“/dev/
sdb”。
表4-29 os:scheduler_hints 数据结构说明
参数 参数类型 描述
dec_baremetal Array of strings 是否在专属云中创建裸金属服务 器，参数值为share或dedicate。
表4-30 metadata 数据结构说明
参数 参数类型 描述
chargingMode String 裸金属服务器的计费类型。
1：按包年包月计费（即prePaid：
预付费方式）。
metering.order_id String 按“包年/包月”计费的裸金属服 务器对应的订单ID。
metering.product_i
d String 按“包年/包月”计费的裸金属服
务器对应的产品ID。
vpc_id String 裸金属服务器所属的虚拟私有云
ID。
metering.image_id String 裸金属服务器操作系统对应的镜像 ID。
metering.imagetyp
e String 镜像类型，目前支持：
● 公共镜像（gold）
● 私有镜像（private）
● 共享镜像（shared）
baremetalPortIDLi
st String 裸金属服务器的网卡列表。
metering.resources
peccode String 裸金属服务器对应的资源规格编
码，格式为：{规格ID}.
{os_type}，例如
physical.o2.medium.linux。
metering.resourcet
ype String 裸金属服务器对应的资源类型，取
值为：__type_baremetal
image_name String 裸金属服务器操作系统对应的镜像 名称。
参数 参数类型 描述
op_svc_userid String 用户ID（登录管理控制台，进入我 的凭证，即可看到“用户ID”）。
os_type String 操作系统类型，取值为：Linux、
Windows
__bms_support_evs String 裸金属服务器是否支持EVS卷。
os_bit String 操作系统位数，一般取值为“32”
或者“64”。
表4-31 sys_tags 数据结构说明
参数 参数类型 描述
key String 系统标签的Key值，当前仅支持
“_sys_enterprise_project_id”，
表示企业项目ID。
value String 系统标签的value值。
● 响应样例
{ "server": {
"id": "53206ed0-56de-4d6b-b7ee-ffc62ca26f43", "name": "bms-test",
"hostId": "cd243addb5d2c64e89218180b7a3ed95abe6882e81c337cc563137df", "updated": "2018-09-18T09:29:44Z",
"created": "2018-09-18T02:43:26Z", "metadata": {
"metering.order_id": "CS1809181040HCFC2",
"metering.image_id": "8589958c-6bc7-40c6-b81b-3fe4cd2e3d85", "baremetalPortIDList": "[9e62503b-094e-4c6e-bc95-f10bbfb455d5]", "metering.resourcespeccode": "physical.o2.medium.linux",
"regionId": "region_id", "image_name": "redhat_7_2",
"op_svc_userid": "745973c535ec4d4caba86f6f9419ff6d", "metering.resourcetype": "__type_baremetal",
"agency_name": "CES_test",
"metering.product_id": "00301-74069-0--0", "os_bit": "64",
"vpc_id": "5849fdf1-9d79-4589-80c2-fe557990c417", "os_type": "Linux",
"id": "8589958c-6bc7-40c6-b81b-3fe4cd2e3d85"
},
"config_drive": "",
"tenant_id": "bbf1946d374b44a0a2a95533562ba954", "user_id": "3fc5ab2b0c544979abcaafd86edd80e6", "OS-EXT-STS:power_state": 1,
"OS-EXT-STS:vm_state": "active", "OS-EXT-SRV-ATTR:host": "bms.dc1",
"OS-EXT-SRV-ATTR:instance_name": "instance-00154f94", "OS-EXT-SRV-ATTR:hypervisor_hostname": "nova002@2", "OS-DCF:diskConfig": "MANUAL",
"OS-EXT-AZ:availability_zone": "az-dc-1", "os:scheduler_hints": {},
"OS-EXT-SRV-ATTR:root_device_name": "/dev/sda", "OS-EXT-SRV-ATTR:ramdisk_id": "",
"enterprise_project_id": "2c7b6d77-9013-4d74-a221-2f612fc56372", "OS-EXT-SRV-ATTR:user_data":
"IyEvYmluL2Jhc2gKZWNobyAncm9vdDokNiRtTGM1REEkN3IvWFVZaEI0VG1YZ0FCT1F2SE4wOHNoWTV ZcDYzUXFDTTVyMHpmWjhJLkJlNW92UlU2QW85a25QNlZUVnhkckF5RTJtdC40S0NxcXBBNUVuUVppN C4nIHwgY2hwYXNzd2QgLWU7",
"OS-SRV-USG:launched_at": "2018-09-18T02:46:07.954587", "OS-EXT-SRV-ATTR:kernel_id": "",
"OS-EXT-SRV-ATTR:launch_index": 0, "host_status": "UP",
"OS-EXT-SRV-ATTR:reservation_id": "r-08tuyo8v", "OS-EXT-SRV-ATTR:hostname": "bms-6e18", "sys_tags": [
错误码
请参考错误码。