华为云用户手册

请求参数 参数 是否必选 参数类型 描述 os-reinstall 是 Object 标记为重装裸金属服务器操作。详情请参见表2。 表2 os-reinstall字段数据结构说明 参数 是否必选 参数类型 描述 adminpass 否 String 裸金属服务器管理员账号的初始登录密码。 其中，Linux管理员账户为root，Windows管理员账户为Administrator。 建议密码复杂度如下： 长度为8-26位。 密码至少必须包含大写字母、小写字母、数字和特殊字符（!@$%^-_=+[{}]:,./?）中的三种。 密码不能包含用户名或用户名的逆序。 说明： 对于Windows裸金属服务器，不能包含用户名中超过两个连续字符的部分。 对于Linux裸金属服务器也可使用user_data字段实现密码注入，此时adminpass字段无效。 adminpass和keyname不能同时有值。 adminpass和keyname如果同时为空，此时，metadata中的user_data属性必须有值。 keyname 否 String 密钥名称。 密钥可以通过创建和导入SSH密钥（OpenStack原生）API创建，或者使用查询SSH密钥列表（OpenStack原生）API查询已有的密钥。 userid 否 String 用户ID（登录管理控制台，进入我的凭证，即可看到“用户ID”）。 metadata 否 Object 重装裸金属服务器的元数据。详情请参见表3。 表3 metadata字段数据结构说明 参数 是否必选 参数类型 描述 user_data 否 String 重装裸金属服务器过程中待注入的Linux镜像root密码，用户自定义初始化密码。 注：修改密码脚本需经base64编码。 建议密码复杂度如下： 长度为8-26位。 密码至少必须包含大写字母（A-Z）、小写字母（a-z）、数字（0-9）和特殊字符（!@$%^-_=+[{}]:,./?）中的三种。 示例： 1 2 #!/bin/bash echo 'root:$6$V6azyeLwcD3CHlpY$BN3VVq18fmCkj66B4zdHLWevqcxlig/GpOkLcOhab9smJoLKYm/Tf9Hcwa6DpiPDhdHfGEAPajFmLZa0YDd910' | chpasswd -e 此脚本需经base64编码方式编码。 其中，$6$V6azyeLwcD3CHlpY$BN3VVq18fmCkj66B4zdHLWevqcxlig为密文密码，生成方法如下： 生成加密盐值 1 2 [root@test linux]# python -c "import crypt, getpass, pwd;print crypt.mksalt()" $6$V6azyeLwcD3CHlpY 根据盐值生成密文密码 1 2 [root@test linux]# python -c "import crypt, getpass, pwd;print crypt.crypt('Cloud.1234','\$6\$V6azyeLwcD3CHlpY')" $6$V6azyeLwcD3CHlpY$BN3VVq18fmCkj66B4zdHLWevqcxlig/GpOkLcOhab9smJoLKYm/Tf9Hcwa6DpiPDhdHfGEAPajFmLZa0YDd910 密文生成之后，修改密码脚本需经base64编码方式编码。

URI POST /v1/{project_id}/baremetalservers/{server_id}/reinstallos 参数说明请参见表1。 表1 参数说明 参数 是否必选 描述 project_id 是 项目ID。 获取方式请参见获取项目ID。 server_id 是 裸金属服务器ID。 可以从裸金属服务器控制台查询，或者通过调用查询裸金属服务器列表（OpenStack原生）获取。

请求示例 查询ID为4d8c3732-a248-40ed-bebc-539a6ffd25c0的裸金属服务器上挂载的云硬盘信息。 1 GET https://{BMS Endpoint}/v1/bbf1946d374b44a0a2a95533562ba954/baremetalservers/4d8c3732-a248-40ed-bebc-539a6ffd25c0/os-volume_attachments

响应参数 参数 参数类型 描述 volumeAttachments Array of objects 裸金属服务器挂载信息列表，详情请参见表2。 表2 volumeAttachments字段数据结构说明 参数 参数类型 描述 device String 挂载目录，例如“/dev/sdd”。 id String 挂载资源ID。 serverId String 所属裸金属服务器ID。 volumeId String 挂载云磁盘ID。

URI GET /v1/{project_id}/baremetalservers/{server_id}/os-volume_attachments 参数说明请参见表1。 表1 参数说明 参数 是否必选 描述 project_id 是 项目ID。 获取方式请参见获取项目ID。 server_id 是 裸金属服务器ID。 可以从裸金属服务器控制台查询，或者通过调用查询裸金属服务器列表（OpenStack原生）获取。

响应示例 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 { "volumeAttachments": [ { "device": "/dev/sdd", "id": "a26887c6-c47b-4654-abb5-dfadf7d3f803", "serverId": "4d8c3732-a248-40ed-bebc-539a6ffd25c0", "volumeId": "a26887c6-c47b-4654-abb5-dfadf7d3f803" }, { "device": "/dev/sdc", "id": "a26887c6-c47b-4654-abb5-dfadf7d3f804", "serverId": "4d8c3732-a248-40ed-bebc-539a6ffd25c0", "volumeId": "a26887c6-c47b-4654-abb5-dfadf7d3f804" } ] }

请求示例 查询裸金属服务器列表。 1 GET https://{E CS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/servers 查询标签中包含__type_baremetal的裸金属服务器列表。 1 GET https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/servers?tags=__type_baremetal 查询标签中包含__type_baremetal且名称包含bms-test01的裸金属服务器列表。 1 GET https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/servers?tags=__type_baremetal&name=bms-test01

响应参数 参数 参数类型 描述 servers Array of objects 裸金属服务器信息列表。详情请参见表2。 表2 servers字段数据结构说明 参数 参数类型 描述 name String 裸金属服务器名称。 id String 裸金属服务器唯一标识。 links Array of objects 裸金属服务器相关快捷链接信息。详情请参见表3。 表3 links字段数据结构说明 参数 参数类型 描述 rel String 快捷链接标记名称。取值为： self：包含版本号的资源链接，需要立即跟踪时使用此类链接。 bookmark：提供了适合长期存储的资源链接。 href String 对应快捷链接。

响应示例 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 { "servers": [ { "name": "bms", "links": [ { "rel": "self", "href": "https://openstack.example.com/v2.1/c685484a8cc2416b97260938705deb65/servers/820abbd0-2d8b-4bc5-ae46-69cacfd4fbaa" }, { "rel": "bookmark", "href": "https://openstack.example.com/c685484a8cc2416b97260938705deb65/servers/820abbd0-2d8e-4bc5-ae46-69cacfd4fbaa" } ], "id": "820abbd0-2d8e-4bc5-ae46-69cacfd4fbaa" } ] }

URI GET /v2.1/{project_id}/servers{?changes-since={changes-since}&image={image}&flavor={flavor}&name={name}&status={status}&limit={limit}&marker={marker}&tags={tags}¬-tags={not-tags}&reservation_id={reservation_id}&sort_key={sort_key}&sort_dir={sort_dir}} 参数说明请参见表1。 表1 参数说明 参数 是否必选 描述 project_id 是 项目ID。 获取方式请参见获取项目ID。

请求参数 参数 是否必选 参数类型 描述 changes-since 否 String 裸金属服务器上次更新状态的时间戳信息。格式为ISO 8601时间格式，例如：2013-06-09T06:42:18Z。 image 否 String 镜像ID。 可以在 镜像服务 控制台查询，也可以调用“查询镜像列表”API获取。 说明： 在使用image作为条件过滤时，不能同时支持其他过滤条件和分页条件。如果同时指定image及其他条件，则以image条件为准；当条件不含image时，接口功能不受限制。 flavor 否 String 规格ID。 可以在裸金属服务器控制台查询，也可以调用查询裸金属服务器规格信息列表（OpenStack原生）API获取。 name 否 String 裸金属服务器名称，使用模糊匹配的方式查询。 例如，“?name=bob”正则表达式会同时返回bob和bobb。如果必须仅匹配bob，则可以使用与基础数据库服务器的语法相匹配的正则表达式，如MySQL或PostgreSQL（官方网站：https://www.postgresql.org/docs/9.2/static/functions-matching.html）。 status 否 String 裸金属服务器状态。 取值范围： ACTIVE：运行中/正在关机/删除中 BUILD：创建中 ERROR：故障 HARD_REBOOT：强制重启中 REBOOT：重启中 SHUTOFF：关机/正在开机/删除中/重建中/重装操作系统中/重装操作系统失败/冻结 limit 否 Integer 每页返回裸金属服务器的条数。 marker 否 String 从marker指定的裸金属服务器ID的下一条数据开始查询。 tags 否 String 查询tag字段中包含该值的裸金属服务器。 微版本2.26新增 not-tags 否 String 查询tag字段中不包含该值的裸金属服务器，值为标签的Key。 说明： 如果之前添加的Tag为“Key.Value”的形式，则查询的时候需要使用“Key”来查询。 例如：之前添加的tag为“a.b”,则升级后，查询时需使用“not-tags=a”。 微版本2.26新增 reservation_id 否 String 批量创建裸金属服务器时，指定该预留ID，可以查询同批次创建的裸金属服务器。 微版本2.26新增 sort_key 否 String 用于排序的属性，包括uuid（裸金属服务器的uuid）、vm_state（裸金属服务器的状态）、display_name（裸金属服务器名称）、task_state（裸金属服务器任务状态）、power_state（电源状态）、created_at（创建时间）、updated_at（更新时间）、availability_zone（可用区）。可以指定多对sort_key和sort_dir。 默认排序顺序为created_at逆序。 sort_dir 否 String 排序方向。 asc：升序 desc：降序（默认值）

请求参数 参数 是否必选 参数类型 描述 volumeAttachment 是 Object 要挂载的卷相关信息，详情请参见表2。 表2 volumeAttachment数据结构说明 参数 是否必选 参数类型 描述 volumeId 是 String 要挂卷的卷ID。 可以从云硬盘控制台查询，或者通过调用“查询云硬盘列表”API获取。 device 否 String 磁盘挂载点，如/dev/sda、/dev/sdb。 新增加的磁盘挂载点不能和已有的磁盘挂载点相同。 需要根据已有设备名称顺序指定，否则不写device或device的值为""时，由系统自动生成。

请求示例 挂载ID为b53f23bd-ee8f-49ec-9420-d1acfeaf91d6的云硬盘到ID为cf2a8b97-b5c6-47ef-9714-eb27adf26e5b的裸金属服务器。 1 POST https://{BMS Endpoint}/v1/bbf1946d374b44a0a2a95533562ba954/baremetalservers/cf2a8b97-b5c6-47ef-9714-eb27adf26e5b/attachvolume 1 2 3 4 5 6 { "volumeAttachment": { "volumeId": "b53f23bd-ee8f-49ec-9420-d1acfeaf91d6", "device": "" } }

URI POST /v1/{project_id}/baremetalservers/{server_id}/attachvolume 参数说明请参见表1。 表1 参数说明 参数 是否必选 描述 project_id 是 项目ID。 获取方式请参见获取项目ID。 server_id 是 裸金属服务器ID。 可以从裸金属服务器控制台查询，或者通过调用查询裸金属服务器列表（OpenStack原生）获取。

URI GET /v1/{project_id}/baremetalservers/{server_id}/os-server-password 参数说明请参见表1。 表1 参数说明 参数 是否必选 描述 project_id 是 项目ID。 获取方式请参见获取项目ID。 server_id 是 裸金属服务器ID。 可以从裸金属服务器控制台查询，或者通过调用查询裸金属服务器列表（OpenStack原生）获取。

响应示例 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 { "flavors": [ { "id": "physical.kl1.3xlarge", "name": "physical.kl1.3xlarge", "vcpus": "24", "ram": 321729, "disk": "6707", "swap": "", "links": [ { "rel": "self", "href": "https://compute.Region.dc1.domainname.com/v2/bbf1946d374b44a0a2a95533562ba954/flavors/physical.kl1.3xlarge", "type": null }, { "rel": "bookmark", "href": "https://compute.Region.dc1.domainname.com/bbf1946d374b44a0a2a95533562ba954/flavors/physical.kl1.3xlarge", "type": null } ], "OS-FLV-EXT-DATA:ephemeral": 0, "rxtx_factor": 1, "OS-FLV-DISABLED:disabled": false, "rxtx_quota": null, "rxtx_cap": null, "os-flavor-access:is_public": false, "os_extra_specs": { "capabilities:cpu_arch": "x86_64", "baremetal:disk_detail": "SAS SSD:2*800G Raid 1 + NVMe SSD Card1.6T", "capabilities:hypervisor_type": "ironic", "baremetal:__support_evs": "true", "baremetal:extBootType": "LocalDisk", "capabilities:board_type": "o2m", "baremetal:net_num": "2", "baremetal:netcard_detail": "2 x 2*10GE", "baremetal:cpu_detail": "Intel Xeon E5-2667 V4 (2*8core* 3.2 GHz)", "resource_type": "ironic", "baremetal:memory_detail": "256GB DDR4 RAM (GB)" } } ] }

响应参数 参数 参数类型 描述 flavors Array of objects 裸金属服务器规格列表，详情请参见表3。 表3 flavors数据结构说明 参数 参数类型 描述 id String 裸金属服务器规格的ID。 name String 裸金属服务器规格的名称。 vcpus String 该裸金属服务器规格对应的CPU核数。 ram Integer 该裸金属服务器规格对应的内存大小，单位为MB。 disk String 该裸金属服务器规格对应要求系统盘大小，0为不限制。 swap String 未使用。 OS-FLV-EXT-DATA:ephemeral Integer 未使用。 OS-FLV-DISABLED:disabled Boolean 未使用。 rxtx_factor Float 未使用。 rxtx_quota String 未使用。 rxtx_cap String 未使用。 os-flavor-access:is_public Boolean 是否是公共规格。 false：私有规格；true：公共规格 links Array of objects 规格相关快捷链接地址，详情请参见表4。 os_extra_specs Object 裸金属服务器规格的扩展字段，详情请参见表5。 表4 links字段数据结构说明 参数 参数类型 描述 rel String 快捷链接标记名称。取值为： self：包含版本号的资源链接，需要立即跟踪时使用此类链接。 bookmark：提供了适合长期存储的资源链接。 href String 对应快捷链接。 type String 快捷链接类型。 表5 os_extra_specs数据结构说明 参数 参数类型 描述 resource_type String 标识该规格对应的资源类型。 capabilities:cpu_arch String 裸金属服务器的CPU架构类型，取值为： x86_64（适用于x86机型） aarch64（适用于ARM机型） baremetal:disk_detail String 磁盘物理规格描述信息。 capabilities:hypervisor_type String 标示ironic类型的规格。 baremetal:__support_evs String 标识当前规格是否支持挂载云硬盘。 true false 如果裸金属服务器规格中没有此参数，表示不支持挂载云硬盘。 baremetal:extBootType String 裸金属服务器启动源。 LocalDisk：本地盘 Volume：云硬盘（快速发放） capabilities:board_type String 裸金属服务器的规格类型。格式为规格的缩写，例如规格名称为“physical.o2.medium”，则规格类型为“o2m”。 baremetal:net_num String 实际可挂载网络数量。 baremetal:netcard_detail String 网卡物理规格描述信息。 baremetal:cpu_detail String CPU物理规格描述信息。 baremetal:memory_detail String 内存物理规格描述信息。 cond:operation:status String 裸金属服务器规格状态。不配置时等同于normal。 normal：正常商用 abandon：下线（即不显示） sellout：售罄 obt：公测 promotion：推荐（等同normal，也是商用） cond:operation:az String 在某个AZ的裸金属服务器规格状态。 此参数是AZ级配置，某个AZ没有在此参数中配置时默认使用cond:operation:status参数的取值。 格式：az(xx)。()内为某个AZ下的裸金属服务器规格状态，()内必须填写状态，不填为无效配置。 例如：规格在某个区域的az0正常商用，az1售罄，az2公测，az3正常商用，其他az显示下线，可配置为： “cond:operation:status”设置为“abandon” “cond:operation:az”设置为“az0(normal), az1(sellout), az2(obt), az3(promotion)” 说明： 如果规格在某个AZ下的状态与cond:operation:status配置状态不同，必须配置该参数。

URI GET /v1/{project_id}/baremetalservers/flavors?availability_zone={availability_zone} 参数说明请参见表1。 表1 参数说明 参数 是否必选 描述 project_id 是 项目ID。 获取方式请参见获取项目ID。 表2 查询参数 参数 是否必选 参数类型 描述 availability_zone 否 String 可用区，需要指定可用区（AZ）的名称。 请参考地区和终端节点获取。

请求示例 更新ID为95bf2490-5428-432c-ad9b-5e3406f869dd的裸金属服务器的元数据，其中自定义metadata键值对为key和value。 1 POST https://{ECS Endpoint}/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd/metadata 1 2 3 4 5 { "metadata": { "key": "value" } }

请求示例 卸载ID为cf2a8b97-b5c6-47ef-9714-eb27adf26e5b的裸金属服务器上ID为6b604cef-9bd8-4f5a-ae56-45839e6e1f0a的云硬盘。 1 DELETE https://{BMS Endpoint}/v1/bbf1946d374b44a0a2a95533562ba954/baremetalservers/cf2a8b97-b5c6-47ef-9714-eb27adf26e5b/detachvolume/6b604cef-9bd8-4f5a-ae56-45839e6e1f0a

约束 裸金属服务器状态为“关机”时支持用户盘的卸载且没有操作系统的限制。当裸金属服务器状态为“运行中”时卸载磁盘有如下约束： 对于Linux裸金属服务器，由于操作系统限制，需要客户先登录裸金属服务器，执行unmount命令，取消待卸载磁盘与文件系统之间的关联，并确保没有程序正在对该磁盘进行读写操作。否则，卸载磁盘将失败。 对于Windows裸金属服务器，在线卸载磁盘，请确保没有程序正在对该磁盘进行读写操作。否则，将造成数据丢失。

URI DELETE /v1/{project_id}/baremetalservers/{server_id}/detachvolume/{attachment_id} 参数说明请参见表1。 表1 参数说明 参数 是否必选 描述 project_id 是 项目ID。 获取方式请参见获取项目ID。 server_id 是 裸金属服务器ID。 可以从裸金属服务器控制台查询，或者通过调用查询裸金属服务器列表（OpenStack原生）获取。 attachment_id 是 裸金属服务器的云硬盘ID。 可以通过查询裸金属服务器挂载的云硬盘信息API获取其挂载的云硬盘ID列表。

请求示例 查询ID为cf2a8b97-b5c6-47ef-9714-eb27adf26e5b的裸金属服务器是否支持一键重置密码。 1 GET https://{BMS Endpoint}/v1/bbf1946d374b44a0a2a95533562ba954/baremetalservers/cf2a8b97-b5c6-47ef-9714-eb27adf26e5b/os-resetpwd-flag

URI GET /v1/{project_id}/baremetalservers/{server_id}/os-resetpwd-flag 参数说明请参见表1。 表1 参数说明 参数 是否必选 描述 project_id 是 项目ID。 获取方式请参见获取项目ID。 server_id 是 裸金属服务器ID。 可以从裸金属服务器控制台查询，或者通过调用查询裸金属服务器列表（OpenStack原生）获取。

响应参数 参数 参数类型 描述 flavor Object 裸金属服务器规格。详情请参见表2。 表2 flavor数据结构说明 参数 参数类型 描述 id String 裸金属服务器规格ID。 name String 裸金属服务器规格名称。 vcpus Integer 该裸金属服务器规格对应的CPU核数。 ram Integer 该裸金属服务器规格对应的内存大小，单位为MB。 disk Integer 该裸金属服务器规格对应要求磁盘大小，单位为GB。 swap String 未使用。 OS-FLV-EXT-DATA:ephemeral Integer 未使用。 OS-FLV-DISABLED:disabled Boolean 未使用。 rxtx_factor Float 未使用。 os-flavor-access:is_public Boolean 未使用。 links Array of objects 规格相关快捷链接地址。详情请参见表3。 表3 links字段数据结构说明 参数 参数类型 描述 rel String 快捷链接标记名称。 self：包含版本号的资源链接，需要立即跟踪时使用此类链接。 bookmark：提供了适合长期存储的资源链接。 href String 对应快捷链接。

响应示例 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 { "flavor": { "name": "physical.o2.medium", "links": [ { "href": "https://openstack.example.com/v2/c685484a8cc2416b97260938705deb65/flavors/physical.o2.medium", "rel": "self" }, { "href": "https://openstack.example.com/c685484a8cc2416b97260938705deb65/flavors/physical.o2.medium", "rel": "bookmark" } ], "ram": 192705, "OS-FLV-DISABLED:disabled": false, "vcpus": 24, "swap": "", "os-flavor-access:is_public": true, "rxtx_factor": 1, "OS-FLV-EXT-DATA:ephemeral": 0, "disk": 1862, "id": "physical.o2.medium" } }

响应示例 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 { "interfaceAttachments": [ { "port_state": "ACTIVE", "fixed_ips": [ { "subnet_id": "a5052101-11e1-4f3d-a5fa-f6ba6791219c", "ip_address": "192.168.1.147" } ], "net_id": "ad0fadbf-4bc1-472c-a030-5310e53b3818", "port_id": "bb585b04-f2a2-4528-9064-fd0aeb4e15a9", "mac_addr": "fa:16:3e:3b:58:fc" } ] }

URI GET /v1/{project_id}/baremetalservers/{server_id}/os-interface 参数说明请参见表1。 表1 参数说明 参数 是否必选 描述 project_id 是 项目ID。 获取方式请参见获取项目ID。 server_id 是 裸金属服务器ID。 可以从裸金属服务器控制台查询，或者通过调用查询裸金属服务器列表（OpenStack原生）获取。

响应参数 参数 参数类型 描述 interfaceAttachments Array of objects 裸金属服务器网卡信息列表，详情请参见表2。 表2 interfaceAttachments字段数据结构说明 参数 参数类型 描述 port_state String 网卡端口状态。取值为：ACTIVE、BUILD、DOWN fixed_ips Array of objects 网卡私网IP信息列表，详情请参见表3。 net_id String 网卡端口所属子网的网络ID（network_id）。 port_id String 网卡端口ID。 mac_addr String 网卡MAC地址信息。 driver_mode String 从guest os中，网卡的驱动类型。可选值为virtio和hinic，默认为virtio。 pci_address String 弹性网卡在Linux GuestOS里的BDF号。 表3 fixed_ips字段数据结构说明 参数 参数类型 描述 subnet_id String 网卡私网IP对应子网的子网ID（subnet_id）。 ip_address String 网卡私网IP信息。

响应示例 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 { "version": { "id": "v1", "links": [ { "href": "http://bms.xxx.com/v1/", "rel": "self" } ], "min_version": "", "status": "CURRENT", "updated": "2018-09-30T00:00:00Z", "version": "" } }