查询裸金属服务器详情(OpenStack原生)
功能介绍
根据裸金属服务器ID,查询裸金属服务器的详细信息。
URI
GET /v2.1/{project_id}/servers/{server_id}
参数说明请参见表1。
参数 |
是否必选 |
描述 |
---|---|---|
project_id |
是 |
项目ID。 获取方式请参见获取项目ID。 |
server_id |
是 |
裸金属服务器ID。 可以从裸金属服务器控制台查询,或者通过调用查询裸金属服务器列表(OpenStack原生)API获取。 |
请求消息
响应消息
- 响应参数
参数
参数类型
描述
server
Object
裸金属服务器信息。详情请参见表2。
表2 server字段数据结构说明 参数
参数类型
描述
name
String
裸金属服务器名称。
id
String
裸金属服务器唯一标识ID。
status
String
裸金属服务器当前状态信息。
取值范围:
- ACTIVE:运行中/正在关机/删除中
- BUILD:创建中
- ERROR:故障
- HARD_REBOOT:强制重启中
- REBOOT:重启中
- SHUTOFF:关机/正在开机/删除中/重建中/重装操作系统中/重装操作系统失败
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
flavor
Object
裸金属服务器规格信息。详情请参见表3。
image
Object
裸金属服务器镜像信息。详情请参见表4。
tenant_id
String
裸金属服务器所属租户ID,UUID格式。
该参数和project_id表示相同的概念。
key_name
String
SSH密钥名称。
user_id
String
裸金属服务器所属用户ID。
metadata
Object
裸金属服务器元数据。详情请参见表6。
hostId
String
裸金属服务器对应的主机ID。
addresses
Object
裸金属服务器对应的网络地址信息。详情请参见表7。
security_groups
Array of objects
裸金属服务器所属安全组列表。详情请参见表9。
links
Array of objects
裸金属服务器相关快捷链接信息。详情请参见表5。
OS-DCF:diskConfig
String
扩展属性,磁盘配置方式,取值为以下两种:
- MANUAL:API使用镜像中的分区方案和文件系统创建裸金属服务器。如果目标flavor磁盘较大,则API不会对剩余磁盘空间进行分区。
- AUTO:API使用与目标flavor磁盘大小相同的单个分区创建裸金属服务器,API会自动调整文件系统以适应整个分区。
OS-EXT-AZ:availability_zone
String
扩展属性,裸金属服务器所在可用区名称。
OS-EXT-SRV-ATTR:host
String
扩展属性,裸金属服务器宿主机名称。
OS-EXT-SRV-ATTR:hypervisor_hostname
String
扩展属性,hypervisor主机名称,由Nova virt驱动提供。
OS-EXT-SRV-ATTR:instance_name
String
扩展属性,裸金属服务器别名。
OS-EXT-STS:power_state
Integer
扩展属性,裸金属服务器电源状态。
取值范围:0,1,2,3,4
- 0:pending
- 1:running
- 2:paused
- 3:shutdown
- 4:crashed
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-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
裸金属服务器挂载的云磁盘信息。详情请参见表10。
accessIPv4
String
预留属性。
accessIPv6
String
预留属性。
fault
Object
故障原因,如果裸金属服务器为故障状态,则返回该字段。详情请参见表11。
config_drive
String
预留属性。
progress
Integer
预留属性。
description
String
描述信息。
微版本2.19新增
host_status
String
裸金属服务器宿主机状态。
- UP:服务正常
- UNKNOWN:状态未知
- DOWN:服务异常
- MAINTENANCE:维护状态
- 空字符串:裸金属服务器无主机信息
微版本2.16新增
OS-EXT-SRV-ATTR:hostname
String
裸金属服务器的主机名。
微版本2.3新增
OS-EXT-SRV-ATTR:reservation_id
String
批量创建场景,裸金属服务器的预留id。
微版本2.3新增
OS-EXT-SRV-ATTR:launch_index
Integer
批量创建场景,裸金属服务器的启动顺序。
微版本2.3新增
OS-EXT-SRV-ATTR:kernel_id
String
若使用AMI格式的镜像,则表示kernel image的UUID;否则,留空。
微版本2.3新增
OS-EXT-SRV-ATTR:ramdisk_id
String
若使用AMI格式镜像,则表示ramdisk image的UUID;否则,留空。
微版本2.3新增
OS-EXT-SRV-ATTR:root_device_name
String
裸金属服务器系统盘的设备名称,例如“/dev/sda”。
微版本2.3新增
OS-EXT-SRV-ATTR:user_data
String
创建裸金属服务器时指定的user_data,取值为base64编码的结果或空字符串。
locked
Boolean
裸金属服务器实例是否为锁定状态。
- true:锁定
- false:未锁定
微版本2.9新增
tags
Array of strings
裸金属服务器标签列表。
微版本2.26新增,如果不使用微版本查询,响应中无tags字段。
tag值遵循如下规则:
- key与value使用“=”连接,如“key=value”。
- 如果value为空字符串,则仅返回key。
表3 flavor字段数据结构说明 参数
参数类型
描述
id
String
裸金属服务器类型ID。
links
Array of objects
裸金属服务器类型相关快捷链接信息。
详情请参见表5。
表5 links字段数据结构说明 参数
参数类型
描述
rel
String
快捷链接标记名称。取值为:
- self:包含版本号的资源链接,需要立即跟踪时使用此类链接。
- bookmark:提供了适合长期存储的资源链接。
href
String
对应快捷链接。
表7 addresses字段数据结构说明 名称
参数类型
说明
vpc_id
Array of objects
裸金属服务器所属网络信息。
- key:表示裸金属服务器使用的虚拟私有云的ID。
- value:网络详细信息,具体请参见表8。
表8 address字段数据结构说明 参数
参数类型
描述
addr
String
IP地址信息。
version
Integer
IP地址类型,值为4或6。
- 4:IP地址类型是IPv4
- 6:IP地址类型是IPv6
OS-EXT-IPS-MAC:mac_addr
String
扩展属性,MAC地址。
OS-EXT-IPS:type
String
扩展属性,IP地址类型。
- fixed:代表私有IP地址。
- floating:代表弹性IP地址。
表9 security_groups字段数据结构说明 参数
参数类型
描述
name
String
- 创建裸金属服务器时未指定安全组,该值为default。
- 创建裸金属服务器时指定了安全组,该值为安全组名称。
- 响应样例
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
{ "server": { "tenant_id": "c685484a8cc2416b97260938705deb65", "addresses": { "08a7715f-7de6-4ff9-a343-95ba4209f24a": [ { "OS-EXT-IPS-MAC:mac_addr": "fa:16:3e:0e:c3:77", "OS-EXT-IPS:type": "fixed", "addr": "192.168.0.107", "version": 4 } ] }, "metadata": { "op_svc_userid": "1311c433dd9b408886f57d695c229cbe" }, "OS-EXT-STS:task_state": null, "OS-DCF:diskConfig": "MANUAL", "OS-EXT-AZ:availability_zone": "az-dc-1", "links": [ { "rel": "self", "href": "https://openstack.example.com/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd" }, { "rel": "bookmark", "href": "https://openstack.example.com/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd" } ], "OS-EXT-STS:power_state": 1, "id": "95bf2490-5428-432c-ad9b-5e3406f869dd", "os-extended-volumes:volumes_attached": [ { "id": "dfa375b5-9856-44ad-a937-a4802b6434c3" }, { "id": "bb9f1b27-843b-4561-b62e-ca18eeaec417" }, { "id": "86e801c3-acc6-465d-890c-d43ba493f553" }, { "id": "0994d3ac-3c6a-495c-a439-c597a4f08fa6" } ], "OS-EXT-SRV-ATTR:host": "bms.az1", "image": { "links": [ { "rel": "bookmark", "href": "https://openstack.example.com/c685484a8cc2416b97260938705deb65/images/1a6635d8-afea-4f2b-abb6-27a202bad319" } ], "id": "1a6635d8-afea-4f2b-abb6-27a202bad319" }, "OS-SRV-USG:terminated_at": null, "accessIPv4": "", "accessIPv6": "", "created": "2017-05-24T06:14:05Z", "hostId": "e9c3ee0fcc58ab6085cf30df70b5544eab958858fb50d925f023e53e", "OS-EXT-SRV-ATTR:hypervisor_hostname": "nova004@2", "key_name": "KeyPair-JX", "flavor": { "links": [ { "rel": "bookmark", "href": "https://openstack.example.com/c685484a8cc2416b97260938705deb65/flavors/physical.83.medium" } ], "id": "physical.83.medium" }, "security_groups": [ { "name": "0011b620-4982-42e4-ad12-47c95ca495c4" } ], "config_drive": "", "OS-EXT-STS:vm_state": "active", "OS-EXT-SRV-ATTR:instance_name": "instance-0000ebd3", "user_id": "1311c433dd9b408886f57d695c229cbe", "name": "bms-83", "progress": 0, "OS-SRV-USG:launched_at": "2017-05-25T03:40:25.066078", "updated": "2017-05-25T03:40:25Z", "status": "ACTIVE" } }
错误码
请参考错误码。