更新时间:2024-09-27 GMT+08:00
分享

查询裸金属服务器详情列表

功能介绍

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

该接口支持查询裸金属服务器计费方式,以及是否被冻结。

调试

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

URI

GET /v1/{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为查询页码(起始页码为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。
表3 flavor数据结构说明

参数

参数类型

描述

id

String

裸金属服务器规格ID。

name

String

裸金属服务器规格名称。

disk

String

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

vcpus

String

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

ram

String

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

gpus

Array of objects

裸金属服务器规格对应的GPU卡信息。详情请参见表4

asic_accelerators

Array of objects

裸金属服务器规格对应的ASIC加速卡信息。详情请参见表5

表4 gpus数据结构说明

参数

参数类型

描述

name

String

GPU卡名称。

count

Integer

GPU卡数量。

memory_mb

Integer

GPU卡显存大小(单位:MB)。

表5 asic_accelerators数据结构说明

参数

参数类型

描述

name

String

ASIC加速卡名称。

count

Integer

ASIC加速卡数量。

memory_mb

Integer

ASIC加速卡显存大小(单位:MB)。

请求参数

请求示例

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

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

响应参数

参数

参数类型

描述

servers

列表数据结构

裸金属服务器详情列表,具体参照查询裸金属服务器详情接口。

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

count

Integer

满足过滤条件的裸金属服务器的总数。

响应示例

  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
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
{
    "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

服务器已成功处理了请求。

其他返回值请参考状态码

错误码

请参考错误码

相关文档