
# 查询裸金属服务器详情列表 - ListBareMetalServers
#### 功能介绍
用户根据设置的请求条件筛选裸金属服务器，并获取裸金属服务器的详细信息。
该接口支持查询裸金属服务器计费方式，以及是否被冻结。
#### 调试
您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/BMS/doc?api=ListBareMetalServers)中调试该接口。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-bms/bms_api_0900.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
  
  | 授权项              | 访问级别 | 资源类型（\*为必须） | 条件键                   | 别名 | 依赖的授权项 |
  |:---|:---|:---|:---|:---|:---|
  | bms:servers:list | list | -           | g:EnterpriseProjectId | -  | -      |
     
  
 
#### URI
GET /v1/{project_id}/baremetalservers/detail
参数说明请参见[表1]。
 表1参数说明 
| 参数         | 是否必选 | 描述                                                                                                                 |
|:---|:---|:---|
| project_id | 是    | 项目ID。 获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-bms/bms_api_appendix_03.html)。 |
   
表2查询参数 
| 参数                    | 是否必选 | 参数类型    | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
|:---|:---|:---|:---|
| flavor                | 否    | String  | 裸金属服务器规格ID。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| name                  | 否    | String  | 裸金属服务器名称。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| status                | 否    | String  | 裸金属服务器状态。 取值范围： - ACTIVE：运行中/正在关机/删除中  - BUILD：创建中  - ERROR：故障  - HARD_REBOOT：强制重启中  - REBOOT：重启中  - 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_id        | 否    | String  | 批量创建裸金属服务器时，指定该预留ID，可以查询同批次创建的裸金属服务器。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| detail                | 否    | String  | 查询裸金属服务器结果的详细级别，级别越高，查询到的裸金属服务器信息越多。 可使用的级别为1，2，3，4。默认级别为4。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| enterprise_project_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 | 列表数据结构  | 裸金属服务器详情列表，具体参照[查询裸金属服务器详情 - ListBareMetalServerDetails](https://support.huaweicloud.com/api-bms/bms_api_0608.html)接口。 查询级别不同，返回的详情不同。 |
| 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",
                        "OS-EXT-IPS:type": "fixed"
                    }
                ]
            },
            "flavor": {
                "disk": "9309",
                "vcpus": "32",
                "ram": "193047",
                "id": "physical.s1.medium.ondemand",
                "name": "physical.s1.medium.ondemand",
                "gpus": [{
                  "name":"Nvidia Tesla V100S 32GB",
                  "count":8,
                  "memory_mb":32768
              }],
                "asic_accelerators": []
            },
            "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": "$key_name",
            "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",
            "sys_tags": [
                {
                    "key": "_sys_enterprise_project_id",
                    "value": "0"
                }
            ]
        },
        {
            "id": "a1541cfc-8ac3-43e9-a70d-b8d4b395b256",
            "name": "bms_test2",
            "addresses": {
                "5849fdf1-9d79-4589-80c2-fe557990c417": [
                    {
                        "version": "4",
                        "addr": "192.168.1.50",
                        "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": "$key_name",
            "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",
            "sys_tags": [
                {
                    "key": "_sys_enterprise_project_id",
                    "value": "0"
                }]
        }
    ]
}
```
#### 返回值
正常返回值：
| 返回值 | 说明           |
|:---|:---|
| 200 | 服务器已成功处理了请求。 |
   
其他返回值请参考[状态码](https://support.huaweicloud.com/api-bms/bms_api_0801.html)。
#### 错误码
请参考[错误码](https://support.huaweicloud.com/api-bms/bms_api_0802.html)。
