华为云计算 云知识 查询裸金属服务器详情列表ListBareMetalServers
查询裸金属服务器详情列表ListBareMetalServers

 

接口说明

用户根据设置的请求条件筛选 裸金属服务器 ,并获取裸金属服务器的详细信息。该接口支持查询裸金属服务器计费方式,以及是否被冻结。

URL
GET  https://bms.cn-north-1.myhuaweicloud.com/v1/{project_id}/baremetalservers/detail 
请求参数
名称 类型 IN 必选 描述
X-Auth-Token
 
string header

用户Token。通过调用 IAM 服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)

project_id
 
string path

项目ID

flavor
 
string query

裸金属服务器规格ID

name
 
string query

裸金属服务器名称

status
 
string query

裸金属服务器状态,只有管理员可以使用DELETED状态过滤查询已经删除的裸金属服务器。取值范围:ACTIVE、BUILD、ERROR、HARD_REBOOT、REBOOT、REBUILD、SHUTOFF

limit
 
integer query

每页返回裸金属服务器的条数,默认值是25,最大值为1000。limit为每页返回裸金属服务器详情的条数

offset
 
integer query

此接口为分页查询接口,offset为查询页码(起始页码为1),返回值包括总条数和裸金属服务器详情列表。传入offset:按limit值分页(limit默认为1000),返回第offset页裸金属服务器详情列表和总条数,总条数最大值为limit,不足按实际情况返回。不传入offset,传入limit:返回裸金属服务器详情列表和总条数,总条数最大值为limit,不足按实际情况返回。不传入offset,不传入limit:按25条分页,返回第1页裸金属服务器详情列表,总条数最大值为25,不足按实际情况返回。

tags
 
string query

裸金属服务器标签:__type_baremetal

reservation_id
 
string query

批量创建裸金属服务器时,指定返回的ID,用于查询本次批量创建的裸金属服务器

detail
 
string query

查询裸金属服务器结果的详细级别,级别越高,查询到的裸金属服务器信息越多,默认为4。可使用的级别为 1,2,3,4

ent erp rise_project_id
 
string query

查询绑定某个企业项目的裸金属服务器

返回参数
返回码: 200

服务器已成功处理了请求

名称 类型 必选 描述
servers
 
Array of ServerDetails objects

裸金属服务器详情列表

count
 
integer

裸金属服务器的列表总数

200 servers
名称 类型 必选 描述
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
 
Map<String,Array<Object>>

裸金属服务器的网络属性。详情请参见表3 addresses数据结构说明。

key_name
 
string

裸金属服务器使用的密钥对名称

image
 
ImageInfo object

裸金属服务器 镜像 信息。详情请参见表5 image数据结构说明。

flavor
 
FlavorInfos object

裸金属服务器规格信息。详情请参见表6 flavor数据结构说明。

security_groups
 
Array of SecurityGroupsList 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
 
MetadataList 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:关机reboot:重启

OS-EXT-SRV-ATTR:host
 
string

扩展属性,裸金属服务器宿主名称

OS-EXT-SRV-ATTR:instance_name
 
string

扩展属性,裸金属服务器实例ID

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
 
Fault object

裸金属服务器故障原因。详情请参见表 fault数据结构说明。

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 OsExtendedVolumesInfo 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。您可以使用6.3.3-查询裸金属服务器详情列表API并指定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
 
SchedulerHints object

裸金属服务器调度信息。详情请参见表10 os:scheduler_hints 数据结构说明。

enterprise_project_id
 
string

裸金属服务器所属的企业项目ID

sys_tags
 
Array of SystemTags objects

裸金属服务器系统标签。详情请参见表12 sys_tags数据结构说明。

200 servers.addresses: Map<String,Array<Object>>
名称 类型 必选 描述
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

200 servers.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 Links objects

镜像相关快捷链接地址。

200 servers.flavor
名称 类型 必选 描述
id
 
string

裸金属服务器规格ID

name
 
string

裸金属服务器规格名称

disk
 
string

该裸金属服务器规格对应要求系统盘大小,0为不限制。

vcpus
 
string

该裸金属服务器规格对应的CPU核数

ram
 
string

该裸金属服务器规格对应的内存大小,单位为MB

200 servers.security_groups
名称 类型 必选 描述
name
 
string

安全组名称或者UUID

id
 
string

安全组ID。

200 servers.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

裸金属服务器对应的资源类型,取值为:hws.resource.type.pm

image_name
 
string

裸金属服务器操作系统对应的镜像名称

op_svc_userid
 
string

用户ID(登录管理控制台,进入我的凭证,即可看到“用户ID”)

os_type
 
string

操作系统类型,取值为:Linux、Windows

__bms_support_evs
 
string

裸金属服务器是否支持EVS卷。

os_bit
 
string

操作系统位数,一般取值为“32”或者“64”。

200 servers.fault
名称 类型 必选 描述
message
 
string

故障信息

code
 
integer

故障code

details
 
string

故障详情

created
 
string

故障时间。时间戳格式为ISO 8601:YYYY-MM-DDTHH:MM:SSZ,例如:2019-05-22T03:30:52Z

200 servers.os-extended-volumes:volumes_attached
名称 类型 必选 描述
id
 
string

磁盘ID,格式为UUID

delete_on_termination
 
string

删裸金属服务器时是否一并删除该磁盘。true:是false:否

bootIndex
 
string

启动标识,“0”代表启动盘,“-1“代表非启动盘

device
 
string

磁盘设备名称,例如“/dev/sdb”。

200 servers.os:scheduler_hints
名称 类型 必选 描述
dec_baremetal
 
Array of strings

是否在专属云中创建裸金属服务器,参数值为share或dedicate。约束:该值不传时默认为share。在专属云中创建裸金属服务器时,必须指定该字段为dedicate。

200 servers.sys_tags
名称 类型 必选 描述
key
 
string

键。最大长度36个unicode字符。key不能为空。不能包含非打印字符ASCII(0-31),以及特殊字符同一资源的key值不能重复。

value
 
string

值。每个值最大长度43个unicode字符,可以为空字符串。不能包含非打印字符ASCII(0-31),以及特殊字符

返回码: 400

服务器未能处理请求

名称 类型 必选 描述
error
 
Error object

提交任务异常时返回的异常信息

400 error
名称 类型 必选 描述
message
 
string

任务异常错误信息描述

code
 
string

任务异常错误信息编码

返回码: 401

被请求的页面需要用户名和密码

名称 类型 必选 描述
error
 
Error object

提交任务异常时返回的异常信息

401 error
名称 类型 必选 描述
message
 
string

任务异常错误信息描述

code
 
string

任务异常错误信息编码

返回码: 403

对被请求页面的访问被禁止

名称 类型 必选 描述
error
 
Error object

提交任务异常时返回的异常信息

403 error
名称 类型 必选 描述
message
 
string

任务异常错误信息描述

code
 
string

任务异常错误信息编码

返回码: 404

服务器无法找到被请求的页面

名称 类型 必选 描述
error
 
Error object

提交任务异常时返回的异常信息

404 error
名称 类型 必选 描述
message
 
string

任务异常错误信息描述

code
 
string

任务异常错误信息编码

返回码: 405

请求中指定的方法不被允许

名称 类型 必选 描述
error
 
Error object

提交任务异常时返回的异常信息

405 error
名称 类型 必选 描述
message
 
string

任务异常错误信息描述

code
 
string

任务异常错误信息编码

返回码: 406

服务器生成的响应无法被客户端所接受

名称 类型 必选 描述
error
 
Error object

提交任务异常时返回的异常信息

406 error
名称 类型 必选 描述
message
 
string

任务异常错误信息描述

code
 
string

任务异常错误信息编码

返回码: 407

用户必须首先使用代理服务器进行验证,这样请求才会被处理

名称 类型 必选 描述
error
 
Error object

提交任务异常时返回的异常信息

407 error
名称 类型 必选 描述
message
 
string

任务异常错误信息描述

code
 
string

任务异常错误信息编码

返回码: 408

请求超出了服务器的等待时间

名称 类型 必选 描述
error
 
Error object

提交任务异常时返回的异常信息

408 error
名称 类型 必选 描述
message
 
string

任务异常错误信息描述

code
 
string

任务异常错误信息编码

返回码: 409

由于冲突,请求无法被完成

名称 类型 必选 描述
error
 
Error object

提交任务异常时返回的异常信息

409 error
名称 类型 必选 描述
message
 
string

任务异常错误信息描述

code
 
string

任务异常错误信息编码

返回码: 500

请求未完成。服务异常

名称 类型 必选 描述
error
 
Error object

提交任务异常时返回的异常信息

500 error
名称 类型 必选 描述
message
 
string

任务异常错误信息描述

code
 
string

任务异常错误信息编码

返回码: 501

请求未完成。服务器不支持所请求的功能

名称 类型 必选 描述
error
 
Error object

提交任务异常时返回的异常信息

501 error
名称 类型 必选 描述
message
 
string

任务异常错误信息描述

code
 
string

任务异常错误信息编码

返回码: 502

请求未完成。服务器从上游服务器收到一个无效的响应

名称 类型 必选 描述
error
 
Error object

提交任务异常时返回的异常信息

502 error
名称 类型 必选 描述
message
 
string

任务异常错误信息描述

code
 
string

任务异常错误信息编码

返回码: 503

请求未完成。系统暂时异常

名称 类型 必选 描述
error
 
Error object

提交任务异常时返回的异常信息

503 error
名称 类型 必选 描述
message
 
string

任务异常错误信息描述

code
 
string

任务异常错误信息编码

返回码: 504

网关超时

名称 类型 必选 描述
error
 
Error object

提交任务异常时返回的异常信息

504 error
名称 类型 必选 描述
message
 
string

任务异常错误信息描述

code
 
string

任务异常错误信息编码

请求示例
示例 1
 
"GET https://{BMS Endpoint}/v1/bbf1946d374b44a0a2a95533562ba954/baremetalservers/detail?detail=5&offset=1&limit=2&enterprise_project_id=all_granted_eps"
返回示例
返回码:200

服务器已成功处理了请求

示例 1
 
{
"count": 2,
"servers": [
{
"id": "b544be62-1b3b-4982-ad98-572b002ac23b",
"name": "bms-test1",
"addresses": {
"5849fdf1-9d79-4589-80c2-fe557990c417": [
{
"addr": "192.168.1.63",
"version": "4",
"OS-EXT-IPS-MAC:mac_addr": "fa:16:3e:3a:8d:f1",
"OS-EXT-IPS:port_id": "c79d2813-94c9-4135-973e-cbf5d23e78e6",
"OS-EXT-IPS:type": "fixed"
}
]
},
"flavor": {
"disk": "9309",
"vcpus": "32",
"ram": "193047",
"id": "physical.s1.medium.ondemand",
"name": "physical.s1.medium.ondemand"
},
"accessIPv4": "",
"accessIPv6": "",
"status": "ACTIVE",
"progress": 0,
"hostId": "cd243addb5d2c64e89218180b7a3ed95abe6882e81c337cc563137df",
"updated": "2018-09-10T01:20:58Z",
"created": "2018-09-06T09:29:27Z",
"metadata": {
"baremetalPortIDList": "[c79d2813-94c9-4135-973e-cbf5d23e78e6]",
"chargingMode": 0
},
"tags": [
"__type_baremetal"
],
"description": "bms-test1",
"locked": false,
"config_drive": "",
"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": "kvmxen.dc1",
"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",
"sys_tags": [
{
"key": "_sys_enterprise_project_id",
"value": "0"
}
]
},
{
"id": "a1541cfc-8ac3-43e9-a70d-b8d4b395b256",
"name": "bms-test2",
"addresses": {
"5849fdf1-9d79-4589-80c2-fe557990c417": [
{
"addr": "192.168.1.50",
"version": "4",
"OS-EXT-IPS-MAC:mac_addr": "fa:16:3e:8f:38:2c",
"OS-EXT-IPS:port_id": "460aa585-9f83-4719-9527-fc39ebaca9aa",
"OS-EXT-IPS:type": "fixed"
}
]
},
"flavor": {
"disk": "9309",
"vcpus": "32",
"ram": "193047",
"id": "physical.s1.medium",
"name": "physical.s1.medium"
},
"accessIPv4": "",
"accessIPv6": "",
"status": "SHUTOFF",
"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",
"three=3",
"two=2"
],
"description": "bms-test2",
"locked": false,
"config_drive": "",
"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": "kvmxen.dc1",
"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",
"sys_tags": [
{
"key": "_sys_enterprise_project_id",
"value": "0"
}
]
}
]
}
SDK
点击 裸金属服务器 (BMS) SDK, 下载SDK或查看SDK文档。SDK的安装、认证方式等在SDK文档中对应语言类型的【使用】目录下。
错误码
请参考 错误码说明

上一篇:工作负载DaemonSet概述 下一篇:查询容量统计ShowStorageUsage

裸金属服务器 BMS

裸金属服务器(Bare Metal Server)为您和您的企业提供专属的云上物理服务器,具备传统物理服务器高性能的同时,兼具云上高安全可靠、灵活快速发放等特点,助力企业在数据库、大数据、容器、高性能计算、AI等场景关键业务云上创新