华为云用户手册

请求示例 获取ID为cf2a8b97-b5c6-47ef-9714-eb27adf26e5b的裸金属服务器的远程登录地址，远程登录协议和类型均为serial。 1 POST https://{BMS Endpoint}/v1/bbf1946d374b44a0a2a95533562ba954/baremetalservers/cf2a8b97-b5c6-47ef-9714-eb27adf26e5b/remote_console { "remote_console": { "protocol": "serial", "type": "serial" } }

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

响应示例 { "remote_console": { "type": "serial", "protocol": "serial", "url": "https://console.domainname.com:443/serial/pod05ironic.region-01/?token=2a794f06-15ec-4f3d-a55b-06aca8e3dcbc" } }

响应参数 正常响应要素 表4 正常响应要素说明 名称 参数类型 说明 job_id String 提交任务成功后返回的任务ID，用户可以使用该ID对任务执行情况进行查询。 如何根据job_id来查询Job的执行状态，请参考查询Job状态。 异常响应要素 表5 异常响应要素说明 名称 参数类型 说明 error 字典数据结构 提交任务异常时返回的异常信息，详情请参见表6。 表6 error数据结构 名称 参数类型 说明 message String 任务异常错误信息描述。 code String 任务异常错误信息编码。

请求示例 强制重启ID为616fb98f-46ca-475e-917e-2563e5a8cd19和726fb98f-46ca-475e-917e-2563e5a8cd20的裸金属服务器。 1 POST https://{BMS Endpoint}/v1/bbf1946d374b44a0a2a95533562ba954/baremetalservers/action 1 2 3 4 5 6 7 8 9 10 11 12 13 { "reboot": { "type": "HARD", "servers": [ { "id": "616fb98f-46ca-475e-917e-2563e5a8cd19" }, { "id": "726fb98f-46ca-475e-917e-2563e5a8cd20" } ] } }

请求参数 重启裸金属服务器请求参数中，必须以“reboot”字段下发重启裸金属服务器请求，详见请求示例。 参数 是否必选 参数类型 描述 reboot 是 Object 标记为重启裸金属服务器操作，详情请参见表2。 表2 reboot字段数据结构说明 参数 是否必选 参数类型 描述 type 是 String 重启类型： SOFT：普通重启（不生效）。 HARD：强制重启（默认）。 servers 是 Array of objects 裸金属服务器ID列表，详情请参见表3。 表3 servers字段数据结构说明 参数 是否必选 参数类型 描述 id 是 String 裸金属服务器ID。 可以从裸金属服务器控制台查询，或者通过调用查询裸金属服务器列表（OpenStack原生）获取。

请求示例 绑定网卡，其中网卡的子网ID为d32019d3-bc6e-4319-9c1d-6722fc136a23，安全组ID为f0ac4394-7e4a-4409-9701-ba8be283dbc3。 { "nics": [ { "subnet_id": "d32019d3-bc6e-4319-9c1d-6722fc136a23", "security_groups": [ { "id": "f0ac4394-7e4a-4409-9701-ba8be283dbc3" } ] } ] }

请求参数 参数 是否必选 参数类型 描述 nics 是 Array of objects 需要绑定的网卡参数列表，详情请参见表2。 约束： 当前不支持10个网卡以上的并发挂载。10个以上并发挂载时，挂载可能失败。 表2 nics字段数据结构说明 参数 是否必选 参数类型 描述 subnet_id 是 String 网卡的子网ID。 网络（network）的ID可以从控制台或者参考《虚拟私有云API参考》的“查询子网列表”章节获取，UUID格式。 约束： 指定subnet_id绑定网卡时，网卡带宽下限默认值是quota:min_rate。 指定subnet_id绑定网卡时，队列个数默认值是quota:vif_multiqueue_num。 quota:min_rate和quota:vif_multiqueue_num可参见查询裸金属服务器规格extra_specs参数的详情（OpenStack原生）查询。 security_groups 否 Array of objects 网卡的安全组信息，详情请参见表3。 约束： 仅在指定subnet_id时生效，当使用subnet_id跨租户挂网卡时，此字段必填。 ip_address 否 String IP地址。无该参数表示自动分配IP地址。 约束： 仅在指定subnet_id时生效。 表3 security_groups字段数据结构说明 参数 是否必选 参数类型 描述 id 是 String 安全组ID。

响应参数 表4 正常响应要素说明 名称 参数类型 说明 job_id String 提交任务成功后返回的任务ID，用户可以使用该ID对任务执行情况进行查询。 如何根据job_id来查询Job的执行状态，请参考查询Job状态。 表5 异常响应要素说明 名称 参数类型 说明 error 字典数据结构 提交任务异常时返回的异常信息，详情请参见表6。 表6 error数据结构 名称 参数类型 说明 message String 任务异常错误信息描述。 code String 任务异常错误信息编码。

响应示例 1 2 3 4 5 6 7 8 9 10 { "addresses": { "08a7715f-7de6-4ff9-a343-95ba4209f24a": [ { "version": 4, "addr": "192.168.2.90" } ] } }

请求示例 查询ID为95bf2490-5428-432c-ad9b-5e3406f869dd的裸金属服务器上ID为ce531f90-199f-48c0-816c-13e38010b442的网卡信息。 1 GET https://{ECS Endpoint}/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd/os-interface/ce531f90-199f-48c0-816c-13e38010b442

响应示例 1 2 3 4 5 6 7 8 9 10 11 12 13 14 { "interfaceAttachment": { "port_state": "ACTIVE", "fixed_ips": [ { "subnet_id": "f8a6e8f8-c2ec-497c-9f23-da9616de54ef", "ip_address": "192.168.1.3" } ], "net_id": "3cb9bc59-5699-4588-a4b1-b87f96708bc6", "port_id": "ce531f90-199f-48c0-816c-13e38010b442", "mac_addr": "fa:16:3e:4c:2c:30" } }

URI GET /v2.1/{project_id}/servers/{server_id}/os-interface/{id} 参数说明请参见表1。 表1 参数说明 参数 是否必选 描述 project_id 是 项目ID。 获取方式请参见获取项目ID。 server_id 是 裸金属服务器ID。 可以从裸金属服务器控制台查询，或者通过调用查询裸金属服务器列表（OpenStack原生）获取。 id 是 网卡ID。 可以在裸金属服务器详情页面“网卡”页签中查看；也可以通过查询裸金属服务器网卡信息（OpenStack原生）API获取，对应的是参数“port_id”的取值。

响应参数 参数 参数类型 描述 interfaceAttachment Object 裸金属服务器网卡信息列表，详情请参见表2。 表2 interfaceAttachment字段数据结构说明 参数 参数类型 描述 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地址信息。 表3 fixed_ips字段数据结构说明 参数 参数类型 描述 subnet_id String 网卡私网IP对应子网的子网ID（subnet_id）。 ip_address String 网卡IP地址。

请求示例 关闭ID为95bf2490-5428-432c-ad9b-5e3406f869dd的裸金属服务器。 1 POST https://{ECS Endpoint}/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd/action 1 2 3 { "os-stop": {} }

响应示例 { "flavors": [ { "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": 321725, "OS-FLV-DISABLED:disabled": false, "vcpus": 56, "swap": "", "os-flavor-access:is_public": true, "rxtx_factor": 1, "OS-FLV-EXT-DATA:ephemeral": 0, "disk": 3725, "id": "physical.o2.medium" } ] }

请求示例 查询规格信息列表。 1 GET https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/flavors/detail 查询规格信息列表且最小的磁盘规格为3725GB。 1 GET https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/flavors/detail?minDisk=3725

响应参数 参数 参数类型 描述 flavors Array of objects 裸金属服务器规格列表。详情请参见表3。 表3 flavors数据结构说明 参数 参数类型 描述 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 规格相关快捷链接地址。详情请参见表4。 表4 links字段数据结构说明 参数 参数类型 描述 rel String 快捷链接标记名称。 self：包含版本号的资源链接，需要立即跟踪时使用此类链接。 bookmark：提供了适合长期存储的资源链接。 href String 对应快捷链接。

请求参数 查询裸金属服务器规格时可选的查询检索参数如表2所示。 表2 可选的查询检索参数 参数 是否必选 参数类型 描述 minDisk 否 String 最小的硬盘规格，单位GB，大于等于此规格的都可以查询到。 minRam 否 String 最小的内存规格，单位MB，大于等于此规格的都可以查询到。 sort_key 否 String 排序字段，默认值为：flavorid。可以指定的其他key为name/ memory_mb/vcpus，/root_gb/flavorid。 sort_dir 否 String 升序/降序排序。 可以指定的参数为asc/desc，默认值为：asc

URI PUT /v2.1/{project_id}/servers/{server_id}/metadata/{key} 参数说明请参见表1。 表1 参数说明 参数 是否必选 描述 project_id 是 项目ID。 获取方式请参见获取项目ID。 server_id 是 裸金属服务器ID。 可以从裸金属服务器控制台查询，或者通过调用查询裸金属服务器列表（OpenStack原生）获取。 key 是 待修改的裸金属服务器metadata键值。

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

响应示例 1 2 3 4 5 6 7 8 { "volumeAttachment": { "device": "/dev/vdb", "serverId": "820abbd0-2d8e-4bc5-ae46-69cacfd4fbaa", "id": "b53f23bd-ee8f-49ec-9420-d1acfeaf91d6", "volumeId": "b53f23bd-ee8f-49ec-9420-d1acfeaf91d6" } }

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

请求示例 查询ID为95bf2490-5428-432c-ad9b-5e3406f869dd的裸金属服务器上挂载的ID为b53f23bd-ee8f-49ec-9420-d1acfeaf91d6的云硬盘信息。 1 GET https://{ECS Endpoint}/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd/os-volume_attachments/b53f23bd-ee8f-49ec-9420-d1acfeaf91d6

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

响应参数 参数 参数类型 描述 status String Job的状态。 SUCCESS：成功 RUNNING：运行中 FAIL：失败 INIT：正在初始化 PENDING_PAYMENT：包年/包月订单待支付 entities Object Job操作的对象。请参见表2。 根据不同Job类型，显示不同的内容。裸金属服务器相关操作显示server_id；网卡相关操作显示nic_id；有子Job时为子Job的详情。 job_id String Job ID。 job_type String Job的类型，包含以下类型： baremetalBatchCreate：批量创建裸金属服务器 baremetalBatchOperate：批量修改裸金属服务器电源状态 baremetalVolumeBootReinstallOs：重装快速发放裸金属服务器操作系统 baremetalReinstallOs：重装本地盘裸金属服务器操作系统 baremetalAttachVolume：挂载单个磁盘 baremetalDetachVolume：卸载单个磁盘 begin_time String 开始时间。 时间戳格式为ISO 8601，例如：2019-04-25T20:04:47.591Z end_time String 结束时间。 时间戳格式为ISO 8601，例如：2019-04-26T20:04:47.591Z error_code String Job执行失败时的错误码。 fail_reason String Job执行失败时的错误原因。 message String 出现错误时，返回的错误消息。 code String 出现错误时，返回的错误码。 错误码和其对应的含义请参考状态码。 表2 entities字段数据结构说明 参数 参数类型 描述 sub_jobs_total Integer 子任务数量。没有子任务时为0。 sub_jobs Array of objects 每个子任务的执行信息。没有子任务时为空列表。请参见表3。 表3 sub_jobs字段数据结构说明 参数 参数类型 描述 status String Job的状态。 SUCCESS：成功 RUNNING：运行中 FAIL：失败 INIT：正在初始化 entities Object Job操作的对象。根据不同Job类型，显示不同的内容。裸金属服务器相关操作显示server_id；网卡相关操作显示nic_id。 请参见表4。 job_id String Job ID。 job_type String Job的类型，包含以下类型： baremetalSingleCreate：创建单个裸金属服务器 baremetalSingleOperate：修改单个裸金属服务器电源状态 begin_time String 开始时间。 时间戳格式为ISO 8601，例如：2019-04-25T20:04:47.591Z end_time String 结束时间。 时间戳格式为ISO 8601，例如：2019-04-26T20:04:47.591Z error_code String Job执行失败时的错误码。 fail_reason String Job执行失败时的错误原因。 message String 出现错误时，返回的错误消息。 code String 出现错误时，返回的错误码。 错误码和其对应的含义请参考状态码。 表4 entities字段数据结构说明 参数 参数类型 描述 server_id String 裸金属服务器相关操作显示server_id。 nic_id String 网卡相关操作显示nic_id。

响应示例 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 { "status": "SUCCESS", "entities": { "sub_jobs_total": 1, "sub_jobs": [ { "status": "SUCCESS", "entities": { "server_id": "bae51750-0089-41a1-9b18-5c777978ff6d" }, "job_id": "2c9eb2c5544cbf6101544f0635672b60", "job_type": "baremetalSingleCreate", "begin_time": "2019-04-25T20:04:47.591Z", "end_time": "2019-04-25T20:08:21.328Z", "error_code": null, "fail_reason": null } ] }, "job_id": "2c9eb2c5544cbf6101544f0602af2b4f", "job_type": "baremetalBatchCreate", "begin_time": "2019-04-25T20:04:34.604Z", "end_time": "2019-04-25T20:08:41.593Z", "error_code": null, "fail_reason": null }

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

URI GET /v2.1/{project_id}/servers/{server_id}/ips/{vpc_id} 参数说明请参见表1。 表1 参数说明 参数 是否必选 描述 project_id 是 项目ID。 获取方式请参见获取项目ID。 server_id 是 裸金属服务器ID。 可以从裸金属服务器控制台查询，或者通过调用查询裸金属服务器列表（OpenStack原生）获取。 vpc_id 是 裸金属服务器所在虚拟私有云ID。

响应示例 1 2 3 4 5 6 7 8 9 10 11 12 { "keypairs": [ { "keypair": { "fingerprint": "15:b0:f8:b3:f9:48:63:71:cf:7b:5b:38:6d:44:2d:4a", "name": "keypair-test", "type": "ssh", "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQC+Eo/RZRngaGTkFs7I62ZjsIlO79KklKbMXi8F+KITD4bVQHHn+kV+4gRgkgCRbdoDqoGfpaDFs877DYX9n4z6FrAIZ4PES8TNKhatifpn9NdQYWA+IkU8CuvlEKGuFpKRi/k7JLos/gHi2hy7QUwgtRvcefvD/vgQZOVw/mGR9Q== Generated-by-Nova" } } ] }