华为云用户手册

请求参数 参数 是否必选 参数类型 描述 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": "" } }

响应示例 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)" } } ] }

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

响应参数 参数 参数类型 描述 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配置状态不同，必须配置该参数。

请求示例 更新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列表。

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

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

响应参数 参数 参数类型 描述 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": "" } }

响应参数 参数 参数类型 描述 version Object 描述裸金属服务器API指定版本信息。详情请参见表2。 表2 version字段数据结构说明 参数 参数类型 描述 id String API版本ID。 links Array of objects API的url地址。详情请参见表3。 min_version String API支持的最小微版本号。 status String API版本状态： CURRENT：表示该版本为主推版本。 SUPPORTED：表示为老版本，但是现在还在继续支持。 DEPRECATED：表示为废弃版本，存在后续删除的可能。 updated String API版本发布时间。 时间戳格式为ISO 8601：YYYY-MM-DDTHH:MM:SSZ，例如：2018-09-30T00:00:00Z version String API支持的最大微版本号。 表3 links字段数据结构说明 参数 参数类型 描述 href String API的url地址。 rel String API的url地址依赖。取值为： self：包含版本号的资源链接，需要立即跟踪时使用此类链接。 bookmark：提供了适合长期存储的资源链接。

请求示例 为ID为53206ed0-56de-4d6b-b7ee-ffc62ca26f43的裸金属服务器增加标签baz、foo和qux。 1 PUT https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/servers/53206ed0-56de-4d6b-b7ee-ffc62ca26f43/tags 1 2 3 4 5 6 7 { "tags": [ "baz", "foo", "qux" ] }

基本概念 账号 用户注册时的账号，账号对其所拥有的资源及云服务具有完全的访问权限，可以重置用户密码、分配用户权限等。由于账号是付费主体，为了确保账号安全，建议您不要直接使用账号进行日常管理工作，而是创建用户并使用用户进行日常管理工作。 用户 由账号在IAM中创建的用户，是云服务的使用人员，具有身份凭证（密码和访问密钥）。 在我的凭证下，您可以查看账号ID和IAM用户ID。通常在调用API的鉴权过程中，您需要用到账号、用户和密码等信息。 区域（Region） 从地理位置和网络时延维度划分，同一个Region内共享弹性计算、块存储、对象存储、VPC网络、弹性公网IP、镜像等公共服务。Region分为通用Region和专属Region，通用Region指面向公共租户提供通用云服务的Region；专属Region指只承载同一类业务或只面向特定租户提供业务服务的专用Region。 详情请参见区域和可用区。 可用区（AZ，Availability Zone） 一个可用区是一个或多个物理数据中心的集合，有独立的风火水电，AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连，以满足用户跨AZ构建高可用性系统的需求。 项目 区域默认对应一个项目，这个项目由系统预置，用来隔离物理区域间的资源（计算资源、存储资源和网络资源），以默认项目为单位进行授权，用户可以访问您账号中该区域的所有资源。如果您希望进行更加精细的权限控制，可以在区域默认的项目中创建子项目，并在子项目中创建资源，然后以子项目为单位进行授权，使得用户仅能访问特定子项目中的资源，使得资源的权限控制更加精确。 图1 项目隔离模型 同样在我的凭证下，您可以查看项目ID。 企业项目 企业项目是项目的升级版，针对企业不同项目间的资源进行分组和管理，是逻辑隔离。企业项目中可以包含多个区域的资源，且项目中的资源可以迁入迁出。 关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理用户指南》。 父主题： 使用前必读

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

请求示例 启动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 { "os-start": { "servers": [ { "id": "616fb98f-46ca-475e-917e-2563e5a8cd19" }, { "id": "726fb98f-46ca-475e-917e-2563e5a8cd20" } ] } }

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

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

请求示例 启动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-start": {} }

URI DELETE /v2.1/{project_id}/servers/{server_id}/tags/{tag} 参数说明请参见表1。 表1 参数说明 参数 是否必选 描述 project_id 是 项目ID。 获取方式请参见获取项目ID。 server_id 是 裸金属服务器ID。 可以从裸金属服务器控制台查询，或者通过调用查询裸金属服务器列表（OpenStack原生）获取。 tag 是 标签信息。 约束： 标签的长度不超过80个字符，标签中如果包含non-URL-safe的字符，要进行URLEncode。 如果未指定具体的标签key，将删除该裸金属服务器的所有标签。

约束 tag的长度不超过80个字符。 tag中如果包含non-URL-safe的字符，要进行URLEncode。 “__type_baremetal”标识是一台裸金属服务器，建议不要删除“__type_baremetal”标签，否则，裸金属服务器将仅在ECS控制台可见，而不在BMS控制台。 “__type_baremetal”删除后可通过为裸金属服务器添加一个标签（OpenStack原生）进行重新添加，添加后裸金属服务器会重新显示在BMS的控制台。

响应参数 参数 参数类型 描述 versions Array of objects 描述裸金属服务器API版本信息列表。详情请参见表1。 表1 versions字段数据结构说明 参数 参数类型 描述 id String API版本ID。 links Array of objects API的url地址。详情请参见表2。 min_version String API支持的最小微版本号。 status String API版本状态： CURRENT：表示该版本为主推版本。 SUPPORTED：表示为老版本，但是现在还在继续支持。 DEPRECATED：表示为废弃版本，存在后续删除的可能。 updated String API版本发布时间。 时间戳格式为ISO 8601：YYYY-MM-DDTHH:MM:SSZ，例如：2018-09-30T00:00:00Z version String API支持的最大微版本号。 表2 links字段数据结构说明 参数 参数类型 描述 href String API的url地址。 rel String API的url地址依赖。取值为： self：包含版本号的资源链接，需要立即跟踪时使用此类链接。 bookmark：提供了适合长期存储的资源链接。

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

请求参数 参数 是否必选 参数类型 描述 remote_console 是 Object 标记为获取裸金属服务器远程登录地址。详情请参见表2。 表2 remote_console字段数据结构说明 参数 是否必选 参数类型 描述 protocol 是 String 远程登录协议，请将protocol配置为“serial”。 type 是 String 远程登录的类型，请将type配置为“serial”。