查询裸金属服务器列表 - ListBareMetalServersDetail

功能介绍

用户根据设置的请求条件筛选裸金属服务器，并获取裸金属服务器的详细信息。

调试

您可以在API Explorer中调试该接口。

URI

GET /v1.1/{project_id}/baremetalservers/detail

参数说明请参见表1。

表1 参数说明
参数	是否必选	描述
project_id	是	项目ID。获取方式请参见获取项目ID。

表2 查询参数
参数	是否必选	参数类型	描述
flavor	否	String	裸金属服务器规格ID。
name	否	String	裸金属服务器名称。
status	否	String	裸金属服务器状态。取值范围： ACTIVE：运行中/正在关机/删除中 BUILD：创建中 ERROR：故障 HARD_REBOOT：强制重启中 REBOOT：重启中 SHUTOFF：关机
limit	否	Integer	每页返回裸金属服务器的条数，默认值是25，最大值为1000。
offset	否	Integer	此接口为分页查询接口：不传offset参数，返回结果是符合条件的裸金属服务器总条数，servers列表为空。传offset参数，offset为查询页码，起始页码为1，每页查询的条数为limit值。
detail	否	String	查询裸金属服务器结果的详细级别，级别越高，查询到的裸金属服务器信息越多。可使用的级别为1，2，3，4，5。默认级别为4。

请求参数

无

请求示例

查询当前用户所有企业项目绑定的裸金属服务器。

GET https://{BMS Endpoint}/v1.1/bbf1946d374b44a0a2a95533562ba954/baremetalservers/detail?offset=1&limit=2

响应参数

参数	参数类型	描述
servers	列表数据结构	裸金属服务器详情列表，具体参照表3接口。查询级别不同，返回的详情不同。

参数

参数类型

描述

servers

列表数据结构

裸金属服务器详情列表，具体参照表3接口。

查询级别不同，返回的详情不同。

表3 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表示相同的概念。
flavor	Object	裸金属服务器规格信息。详情请参见表4。
status	String	裸金属服务器当前状态信息。取值范围： ACTIVE：运行中/正在关机/删除中 BUILD：创建中 ERROR：故障 HARD_REBOOT：强制重启中 REBOOT：重启中 SHUTOFF：关机
task_state	String	裸金属服务器当前的任务状态。取值范围： rebooting：重启中 reboot_started：普通重启 reboot_started_hard：强制重启 powering-off：关机中 powering-on：开机中 rebuilding：重建中 scheduling：调度中 deleting：删除中
vm_state	String	裸金属服务器的稳定状态。取值范围： active：运行中 shutoff：关机 reboot：重启
availability_zone	String	裸金属服务器所在可用区名称。
fault	Object	裸金属服务器故障原因。详情请参见表5。
in_recycle_bin	Boolean	裸金属服务器是否处于回收站中。

表4 flavor数据结构说明
参数	参数类型	描述
id	String	裸金属服务器规格ID。
name	String	裸金属服务器规格名称。
disk	Integer	该裸金属服务器规格对应要求系统盘大小，0为不限制。
vcpus	Integer	该裸金属服务器规格对应的CPU核数。
ram	Integer	该裸金属服务器规格对应的内存大小，单位为MB。
gpus	Array of objects	该裸金属服务器规格对应的GPU卡信息。详情请参见表6。
asic_accelerators	Array of objects	该裸金属服务器规格对应的ASIC加速卡信息。详情请参见表7。

表5 fault数据结构说明
参数	参数类型	描述
message	String	故障信息。
code	Integer	故障代码。
details	String	故障详情。
created	String	故障时间，ISO 8601格式。

表6 gpus数据结构说明
参数	参数类型	描述
name	String	GPU卡名称。
count	Integer	GPU卡数量。
memory_mb	Integer	GPU卡显存大小（单位：MB）。

表7 asic_accelerators数据结构说明
参数	参数类型	描述
name	String	ASIC加速卡名称。
count	Integer	ASIC加速卡数量。
memory_mb	Integer	ASIC加速卡显存大小（单位：MB）。

响应示例

{
    "servers": [
        {
            "tenant_id": "ce5c827cf74a45e381a2ceba3511xxxx",
            "availability_zone": "cn-north-1a",
            "created": "2025-05-08T02:58:16Z",
            "task_state": "null",
            "vm_state": " active ",
            "flavor": {
                "disk": 0,
                "asic_accelerators": [

                ],
                "gpus": [

                ],
                "name": "xxx",
                "id": "xxx",
                "vcpus": 24,
                "ram": 49152
            },
            "user_id": "521ac9375b8e4661ad8409c0311xxxxx",
            "in_recycle_bin": false,
            "name": "bms-caae",
            "id": "7ef189e7-7795-47e7-9116-47bd50exxxxx",
            "updated": "2025-05-08T02:58:24Z",
            "status": "ACTIVE"
        }
    ],
}