查询裸金属服务器详情
功能介绍
获取裸金属服务器的详细信息。
该接口支持查询裸金属服务器的计费方式,以及是否被冻结。
URI
GET /v1/{project_id}/baremetalservers/{server_id}
参数说明请参见表1。
参数 |
是否必选 |
描述 |
---|---|---|
project_id |
是 |
项目ID。 获取方式请参见获取项目ID。 |
server_id |
是 |
裸金属服务器ID。 可以从裸金属服务器控制台查询,或者通过调用查询裸金属服务器列表(OpenStack原生)API获取。 |
请求消息
响应消息
- 响应参数
参数
参数类型
描述
server
Object
裸金属服务器信息。详情请参见表2。
表2 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
裸金属服务器的网络属性。详情请参见表3 addresses数据结构说明。
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:重启中
- 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-SRV-ATTR:instance_name
String
扩展属性,裸金属服务器别名。
OS-EXT-STS:power_state
Integer
扩展属性,裸金属服务器电源状态。例如:
- 0表示“NO STATE”
- 1表示“RUNNING”
- 4表示“SHUTDOWN”
OS-EXT-SRV-ATTR:hypervisor_hostname
String
扩展属性,裸金属服务器所在虚拟化主机名。
OS-EXT-AZ:availability_zone
String
扩展属性,裸金属服务器所在可用区名称。
OS-DCF:diskConfig
String
扩展属性,磁盘配置,取值为以下两种:
- MANUAL:API使用镜像中的分区方案和文件系统创建裸金属服务器。如果目标flavor磁盘较大,则API不会对剩余磁盘空间进行分区。
- AUTO:API使用与目标flavor磁盘大小相同的单个分区创建裸金属服务器,API会自动调整文件系统以适应整个分区。
fault
Object
裸金属服务器故障原因。详情请参见表9。
OS-SRV-USG:launched_at
String
裸金属服务器启动时间。
时间戳格式为ISO 8601,例如:2019-05-22T03:23:59.000000
OS-SRV-USG:terminated_at
String
裸金属服务器删除时间。
时间戳格式为ISO 8601,例如:2019-05-22T04:23:59.000000
os-extended-volumes:volumes_attached
Array of objects
挂载到裸金属服务器上的磁盘。详情请参见表9 os-extended-volumes:volumes_attached 数据结构说明。
description
String
裸金属服务器的描述信息。
host_status
String
裸金属服务器宿主机状态。
- UP:服务正常
- UNKNOWN:状态未知
- DOWN:服务异常
- MAINTENANCE:维护状态
- 空字符串:裸金属服务器无主机信息
OS-EXT-SRV-ATTR:hostname
String
裸金属服务器的主机名。
OS-EXT-SRV-ATTR:reservation_id
String
批量创建场景,裸金属服务器的预留ID。
当批量创建裸金属服务器时,这些服务器将拥有相同的reservation_id。
OS-EXT-SRV-ATTR:launch_index
Integer
批量创建场景,裸金属服务器的启动顺序。
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:root_device_name
String
裸金属服务器系统盘的设备名称,例如“/dev/sda”。
OS-EXT-SRV-ATTR:user_data
String
创建裸金属服务器时指定的user_data,取值为base64编码后的结果或空字符串。
locked
Boolean
裸金属服务器是否为锁定状态。
- true:锁定
- false:未锁定
tags
Array of strings
裸金属服务器标签。
os:scheduler_hints
Object
裸金属服务器调度信息。详情请参见表10 os:scheduler_hints 数据结构说明。
sys_tags
Array of objects
裸金属服务器系统标签。详情请参见表12 sys_tags数据结构说明。
表3 addresses数据结构说明 参数
参数类型
描述
vpc_id
Array of objects
裸金属服务器所属网络信息。
- key:表示裸金属服务器使用的虚拟私有云的ID。
- value:网络详细信息,具体请参见表4 address数据结构说明。
表4 address数据结构说明 参数
参数类型
描述
version
Integer
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。
表5 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
镜像相关快捷链接地址。详情请参见表6。
表7 flavor数据结构说明 参数
参数类型
描述
id
String
裸金属服务器规格ID。
name
String
裸金属服务器规格名称。
disk
String
该裸金属服务器规格对应要求系统盘大小,0为不限制。
vcpus
String
该裸金属服务器规格对应的CPU核数。
ram
String
该裸金属服务器规格对应的内存大小,单位为MB。
表9 fault数据结构说明 参数
参数类型
描述
message
String
故障信息。
code
Integer
故障代码。
details
String
故障详情。
created
String
故障时间,ISO 8601格式。
表10 os-extended-volumes:volumes_attached数据结构说明 参数
参数类型
描述
id
String
磁盘ID,格式为UUID。
delete_on_termination
String
删除裸金属服务器时是否一并删除该磁盘。
- true:是
- false:否
bootIndex
String
启动标识,“0”代表启动盘,“-1“代表非启动盘。
device
String
磁盘设备名称,例如“/dev/sdb”。
表12 metadata数据结构说明 参数
参数类型
描述
chargingMode
String
裸金属服务器的计费类型。
1:按包年包月计费(即prePaid:预付费方式)。
metering.order_id
String
按“包年/包月”计费的裸金属服务器对应的订单ID。
metering.product_id
String
按“包年/包月”计费的裸金属服务器对应的产品ID。
vpc_id
String
裸金属服务器所属的虚拟私有云ID。
metering.image_id
String
裸金属服务器操作系统对应的镜像ID。
metering.imagetype
String
镜像类型,目前支持:
- 公共镜像(gold)
- 私有镜像(private)
- 共享镜像(shared)
baremetalPortIDList
String
裸金属服务器的网卡列表。
metering.resourcespeccode
String
裸金属服务器对应的资源规格编码,格式为:{规格ID}.{os_type},例如physical.o2.medium.linux。
metering.resourcetype
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”。
- 响应样例
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89
{ "server": { "id": "53206ed0-56de-4d6b-b7ee-ffc62ca26f43", "name": "bms-test", "addresses": { "5849fdf1-9d79-4589-80c2-fe557990c417": [ { "version": "4", "addr": "192.168.1.216", "OS-EXT-IPS-MAC:mac_addr": "fa:16:3e:25:56:c3", "OS-EXT-IPS:port_id": "9e62503b-094e-4c6e-bc95-f10bbfb455d5", "OS-EXT-IPS:type": "fixed" }, { "version": "4", "addr": "10.154.72.77", "OS-EXT-IPS-MAC:mac_addr": "fa:16:3e:25:56:c3", "OS-EXT-IPS:port_id": "9e62503b-094e-4c6e-bc95-f10bbfb455d5", "OS-EXT-IPS:type": "floating" } ] }, "flavor": { "disk": "9309", "vcpus": "32", "ram": "193047", "id": "physical.o2.medium", "name": "physical.o2.medium" }, "accessIPv4": "", "accessIPv6": "", "status": "ACTIVE", "progress": 0, "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", "chargingMode": "1" }, "tags": [ "__type_baremetal" ], "description": "bms-6e18", "locked": false, "image": { "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": "IyEvYmluL2Jhc2gKZWNobyAncm9vdDokNiRtTGM1REEkN3IvWFVZaEI0VG1YZ0FCT1F2SE4wOHNoWTVZcDYzUXFDTTVyMHpmWjhJLkJlNW92UlU2QW85a25QNlZUVnhkckF5RTJtdC40S0NxcXBBNUVuUVppNC4nIHwgY2hwYXNzd2QgLWU7", "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": [ { "key": "_sys_enterprise_project_id", "value": "2c7b6d77-9013-4d74-a221-2f612fc56372" } ] } }
错误码
请参考错误码。