4.3 裸金属服务器生命周期管理
4.3.3 查询裸金属服务器详情列表
功能介绍
用户根据设置的请求条件筛选裸金属服务器，并获取裸金属服务器的详细信息。
该接口支持查询裸金属服务器计费方式，以及是否被冻结。
调试
您可以在API Explorer中调试该接口。
URI
GET /v1/{project_id}/baremetalservers/detail{?
flavor={flavor}&name={name}&status={status}&limit={limit}&offset={offset}&tags
={tags}&reservation_id={reservation_id}&enterprise_project_id={enterprise_project_
id}}
参数说明请参见表4-32。
表4-32 参数说明
参数 是否必选 描述
project_id 是 项目ID。
获取方式请参见获取项目ID。
表4-33 查询参数
参数 是否必选 参数类型 描述
flavor 否 String 裸金属服务器规格ID。
name 否 String 裸金属服务器名称。
参数 是否必选 参数类型 描述
status 否 String 裸金属服务器状态。
取值范围：
● ACTIVE：运行中/正在关机/删除 中
● BUILD：创建中
● ERROR：故障
● HARD_REBOOT：强制重启中
● REBOOT：重启中
● DELETED：实例已被正常删除
● SHUTOFF：关机/正在开机/删除 中/重建中/重装操作系统中/重装 操作系统失败/冻结
limit 否 Integer 每页返回裸金属服务器的条数，默
认值是25，最大值为1000。
offset 否 Integer 此接口为分页查询接口，offset为查 询页码（起始页码为1），返回值包 括总条数和裸金属服务器详情列 表。
● 传入offset
按limit值分页（limit默认为 1000），返回第offset页裸金属 服务器详情列表和总条数，总条 数最大值为limit，不足按实际情 况返回。
● 不传入offset
– 传入limit：返回裸金属服务器 详情列表和总条数，总条数最 大值为limit，不足按实际情况 返回。
– 不传入limit：按25条分页，
返回第1页裸金属服务器详情 列表，总条数最大值为25，
不足按实际情况返回。
tags 否 String 裸金属服务器的标签，取值为：
● __type_baremetal：系统内部标 签。
● 其他由您自定义的标签。
reservation_i
d 否 String 批量创建裸金属服务器时，指定该
预留ID，可以查询同批次创建的裸 金属服务器。
参数 是否必选 参数类型 描述
detail 否 String 查询裸金属服务器结果的详细级
别，级别越高，查询到的裸金属服 务器信息越多。
可使用的级别为1，2，3，4，5。
默认级别为4。
enterprise_pr
oject_id 否 String 查询绑定某个企业项目的裸金属服 务器。
若需要查询当前用户所有企业项目 绑定的裸金属服务器，请传参 all_granted_eps。
说明
● 查询的企业项目需具备 bms:servers:list的权限。
● 当前all_granted_eps支持查询的企 业项目个数不超过100。
请求消息
● 请求参数 无
● 请求样例
携带多个可选参数：
GET https://{BMS Endpoint}/v1/bbf1946d374b44a0a2a95533562ba954/baremetalservers/detail?
offset=1&limit=2&enterprise_project_id=all_granted_eps
响应消息
● 响应参数
参数 参数类型 描述
servers 列表数据结构 裸金属服务器详情列表，具体参照查询 裸金属服务器详情接口。
查询级别不同，返回的详情不同。
count Integer 满足过滤条件的裸金属服务器的总数。
● 响应样例
{ "count": 2, "servers": [ {
"id": "b544be62-1b3b-4982-ad98-572b002ac23b", "name": "bms-test1",
"addresses": {
"5849fdf1-9d79-4589-80c2-fe557990c417": [ {
"version": "4", "addr": "192.168.1.63",
"OS-EXT-IPS-MAC:mac_addr": "fa:16:3e:3a:8d:f1",
"OS-EXT-IPS:port_id": "c79d2813-94c9-4135-973e-cbf5d23e78e6",
"hostId": "cd243addb5d2c64e89218180b7a3ed95abe6882e81c337cc563137df", "updated": "2018-09-10T01:20:58Z",
"created": "2018-09-06T09:29:27Z", "metadata": {
"baremetalPortIDList": "[c79d2813-94c9-4135-973e-cbf5d23e78e6]", "chargingMode": "0"
"tenant_id": "bbf1946d374b44a0a2a95533562ba954", "user_id": "0c50494c5816425eb05c40b5e81ab65a", "key_name": "KeyPair-dec-jx",
"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-0014bdc2", "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/vda", "OS-EXT-SRV-ATTR:ramdisk_id": "",
"enterprise_project_id": "0",
"OS-SRV-USG:launched_at": "2018-09-06T09:30:36.000000", "OS-EXT-SRV-ATTR:kernel_id": "",
"OS-EXT-SRV-ATTR:launch_index": 0, "host_status": "UP",
"OS-EXT-SRV-ATTR:reservation_id": "r-qjad3fv0", "OS-EXT-SRV-ATTR:hostname": "bms-test1",
"id": "a1541cfc-8ac3-43e9-a70d-b8d4b395b256", "name": "bms_test2",
},
"hostId": "cd243addb5d2c64e89218180b7a3ed95abe6882e81c337cc563137df", "updated": "2018-09-06T10:00:25Z",
"created": "2018-08-30T12:40:47Z", "metadata": {
"metering.order_id": "CS18083020422CNV9",
"baremetalPortIDList": "[460aa585-9f83-4719-9527-fc39ebaca9aa]", "metering.product_id": "00301-167001-0--0",
"chargingMode": "1"
}, "tags": [
"__type_baremetal",
"_sys_enterprise_project_id=9dd1131d-71fd-40fe-8f14-3fe6b6b5ef8b", "key1=value1",
"tenant_id": "bbf1946d374b44a0a2a95533562ba954", "user_id": "3fc5ab2b0c544979abcaafd86edd80e6", "key_name": "KeyPair-hec-tzy",
"OS-EXT-STS:power_state": 4, "OS-EXT-STS:vm_state": "stopped", "OS-EXT-SRV-ATTR:host": "bms.dc1",
"OS-EXT-SRV-ATTR:instance_name": "instance-0014581b", "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/vda", "OS-EXT-SRV-ATTR:ramdisk_id": "",
"enterprise_project_id": "0",
"OS-SRV-USG:launched_at": "2018-08-30T12:42:10.000000", "OS-EXT-SRV-ATTR:kernel_id": "",
"OS-EXT-SRV-ATTR:launch_index": 0, "host_status": "UP",
"OS-EXT-SRV-ATTR:reservation_id": "r-i5w3yc9a", "OS-EXT-SRV-ATTR:hostname": "bms-test2",
其他返回值请参考状态码。
错误码
请参考错误码。