华为云用户手册

请求方法 HTTP请求方法（也称为操作或动词），它告诉服务您正在请求什么类型的操作。 表2 HTTP方法 方法 说明 GET 请求服务器返回指定资源。 PUT 请求服务器更新指定资源。 POST 请求服务器新增资源或执行特殊操作。 DELETE 请求服务器删除指定资源，如删除对象等。 HEAD 请求服务器资源头部。 PATCH 请求服务器更新资源的部分内容。 当资源不存在的时候，PATCH可能会去创建一个新的资源。 在管理员创建 IAM 用户的URI部分，您可以看到其请求方法为“POST”，则其请求为： 1 POST https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/users

请求消息头 附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。 详细的公共请求消息头字段请参见表3。 表3 公共请求消息头 名称 描述 是否必选 示例 Host 请求的服务器信息，从服务API的URL中获取。值为hostname[:port]。端口缺省时使用默认的端口，https的默认端口为443。 否 使用AK/SK认证时该字段必选。 code.test.com or code.test.com:443 Content-Type 消息体的类型（格式）。推荐用户使用默认值application/json，有其他取值时会在具体接口中专门说明。 是 application/json Content-Length 请求body长度，单位为Byte。 否 3495 X-Project-Id project id，项目编号。请参考获取项目ID章节获取项目编号。 否 如果是专属云场景采用AK/SK认证方式的接口请求，或者多project场景采用AK/SK认证的接口请求，则该字段必选。 e9993fc787d94b6c886cbaa340f9c0f4 X-Auth-Token 用户Token。 用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头（Headers）中包含的“X-Subject-Token”的值即为Token值。 否 使用Token认证时该字段必选。 注：以下仅为Token示例片段。 MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ API同时支持使用AK/SK认证，AK/SK认证使用SDK对请求进行签名，签名过程会自动往请求中添加Authorization（签名认证信息）和X-Sdk-Date（请求发送的时间）请求头。 AK/SK认证的详细说明请参见认证鉴权的“AK/SK认证”。 对于管理员创建IAM用户接口，使用AK/SK方式认证时，添加消息头后的请求如下所示。 1234 POST https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/usersContent-Type: application/json X-Sdk-Date: 20240416T095341Z Authorization: SDK-HMAC-SHA256 Access=****************, SignedHeaders=content-type;host;x-sdk-date, Signature=****************

前提条件 由于某些机型的服务器没有配备SDI卡，或者其他服务器本身的原因，有些规格的裸金属服务器不支持挂载云硬盘。因此，您需要先确认裸金属服务器是否支持挂载云硬盘。判断方式如下： 调用查询规格详情和规格扩展信息列表API，确定响应参数中某个规格对应的“baremetal:__support_evs”的取值，如果为“true”表示支持挂载云硬盘，为“false”表示不支持。有些裸金属服务器规格中无此参数，也表示不支持云硬盘。

操作步骤 创建云硬盘。 接口相关信息 URI格式：POST /v2/{project_id}/volumes 详情请参考“创建云硬盘”。 请求示例 POST https://{EVS Endpoint}/v2/05041fffa40025702f6dc009cc6f8f33/volumes {EVS Endpoint}信息请从“地区和终端节点”获取。 Body： { "volume": { "name": "openapi_vol01", "availability_zone": "cn-north-4a", "description": "create for api test", "volume_type": "SSD", "metadata": { "hw:passthrough": "true" }, "size": 40 }} 裸金属服务器仅支持挂载S CS I类型的云硬盘，因此“hw:passthrough”参数必须取值“true”。 响应示例 { "volume": { "attachments": [], "links": [ { "href": "https://evs.cn-north-4.myhuaweicloud.com/v2/05041fffa40025702f6dc009cc6f8f33/volumes/8ae4ff5b-7e6e-492f-b83a-8a51fdfa3111", "rel": "self" }, { "href": "https://evs.cn-north-4.myhuaweicloud.com/05041fffa40025702f6dc009cc6f8f33/volumes/8ae4ff5b-7e6e-492f-b83a-8a51fdfa3111", "rel": "bookmark" } ], "availability_zone": "cn-north-4a", "encrypted": false, "updated_at": "2020-11-09T08:19:22.077967", "replication_status": "disabled", "storage_cluster_id": null, "snapshot_id": null, "id": "8ae4ff5b-7e6e-492f-b83a-8a51fdfa3111", "size": 40, "user_id": "0504186e6a8010e01f3ec009a7279baa", "metadata": { "hw:passthrough": "true" }, "status": "creating", "description": "create for api test", "multiattach": false, "source_volid": null, "consistencygroup_id": null, "name": "openapi_vol01", "bootable": "false", "created_at": "2020-11-09T08:19:22.061273", "volume_type": "SSD", "shareable": false }} 记录响应中volume的“ID”。 挂载云硬盘。 接口相关信息 URI格式：POST /v1/{project_id}/baremetalservers/{server_id}/attachvolume 详情请参考裸金属服务器挂载云硬盘。 请求示例 POST https://{BMS Endpoint}/v1/05041fffa40025702f6dc009cc6f8f33/baremetalservers/9ab74d89-61e7-4259-8546-465fdebe4944/attachvolume {BMS Endpoint}信息请从“地区和终端节点”获取。 Body： { "volumeAttachment": { "volumeId": "8ae4ff5b-7e6e-492f-b83a-8a51fdfa3111", "device": "/dev/sdb" }} 响应示例 { "volumeAttachment": { "id": "b53f23bd-ee8f-49ec-9420-d1acfeaf91d6", "volumeId": "8ae4ff5b-7e6e-492f-b83a-8a51fdfa3111", "serverId": "9ab74d89-61e7-4259-8546-465fdebe4944", "device": "/dev/sdb" }} 确认挂载云硬盘是否成功。 接口相关信息 URI格式：GET /v1/{project_id}/baremetalservers/{server_id}/os-volume_attachments 详情请参考查询裸金属服务器挂载的云硬盘信息。 请求示例 GET https://{BMS Endpoint}/v1/05041fffa40025702f6dc009cc6f8f33/baremetalservers/9ab74d89-61e7-4259-8546-465fdebe4944/os-volume_attachments {BMS Endpoint}信息请从“地区和终端节点”获取。 响应示例 1 2 3 4 5 6 7 8 910111213141516 { "volumeAttachments": [ { "device": "/dev/sdd", "id": "a26887c6-c47b-4654-abb5-dfadf7d3f803", "serverId": "9ab74d89-61e7-4259-8546-465fdebe4944", "volumeId": "a26887c6-c47b-4654-abb5-dfadf7d3f803" }, { "device": "/dev/sdb", "id": "b53f23bd-ee8f-49ec-9420-d1acfeaf91d6", "serverId": "9ab74d89-61e7-4259-8546-465fdebe4944", "volumeId": "8ae4ff5b-7e6e-492f-b83a-8a51fdfa3111" } ]}

BMS接口使用限制 表2 BMS接口使用限制 类型 API URI 使用限制 查询API版本信息 查询API版本信息列表 GET / 每分钟2000次 查询指定API版本信息 GET /{api_version} 每分钟2000次 生命周期管理 创建裸金属服务器 POST /v1/{project_id}/baremetalservers 每分钟50次 查询裸金属服务器详情 GET /v1/{project_id}/baremetalservers/detail 每分钟500次 查询裸金属服务器详情列表 GET /v1/{project_id}/baremetalservers/{server_id} 每分钟1000次 状态管理 修改裸金属服务器名称 PUT /v1/{project_id}/baremetalservers/{server_id} 每分钟100次 重装裸金属服务器操作系统 POST /v1/{project_id}/baremetalservers/{server_id}/reinstallos 每分钟50次 启动裸金属服务器 POST /v1/{project_id}/baremetalservers/action 每分钟50次 重启裸金属服务器 POST /v1/{project_id}/baremetalservers/action 每分钟50次 关闭裸金属服务器 POST /v1/{project_id}/baremetalservers/action 每分钟50次 规格管理 查询规格详情和规格扩展信息列表 GET /v1/{project_id}/baremetalservers/flavors 每分钟500次 网卡管理 查询裸金属服务器网卡信息 GET /v1/{project_id}/baremetalservers/{server_id}/os-interface 每分钟500次 云硬盘管理 裸金属服务器挂载云硬盘 POST /v1/{project_id}/baremetalservers/{server_id}/attachvolume 每分钟100次 裸金属服务器卸载云硬盘 DELETE /v1/{project_id}/baremetalservers/{server_id}/detachvolume/{attachment_id} 每分钟100次 查询裸金属服务器挂载的磁盘信息 GET /v1/{project_id}/baremetalservers/{server_id}/os-volume_attachments 每分钟500次 元数据管理 更新裸金属服务器元数据 POST /v1/{project_id}/baremetalservers/{server_id}/metadata 每分钟100次 租户配额管理 查询租户配额 GET /v1/{project_id}/baremetalservers/limits 每分钟500次 密码管理 查询是否支持一键重置密码 GET /v1/{project_id}/baremetalservers/{server_id}/os-resetpwd-flag 每分钟500次 一键重置裸金属服务器密码 PUT /v1/{project_id}/baremetalservers/{server_id}/os-reset-password 每分钟50次 Windows裸金属服务器获取密码 GET /v1/{project_id}/baremetalservers/{server_id}/os-server-password 每分钟50次 Windows裸金属服务器清除密码 DELETE /v1/{project_id}/baremetalservers/{server_id}/os-server-password 每分钟50次 Job管理 查询Job状态 GET /v1/{project_id}/jobs/{jobId} 每分钟2000次

接口介绍 裸金属服务器所提供的接口分为BMS接口与OpenStack原生接口。推荐您使用BMS接口。 表1 接口说明 类型 子类型 说明 BMS接口 查询API版本信息 查询裸金属服务器服务当前所用的API版本。 生命周期管理 可以实现包周期裸金属服务器的创建、裸金属服务器详情查询等操作。 状态管理 裸金属服务器修改名称、重装系统、启动、重启、关闭等功能。 规格管理 用于查询裸金属服务器的规格详情和规格扩展信息，比如规格ID、规格名称、CPU核数、启动源。 网卡管理 可以查询裸金属服务器网卡信息，比如网卡的IP地址、MAC地址。 云硬盘管理 裸金属服务器云硬盘挂载、卸载，以及挂载的磁盘信息查询。 元数据管理 裸金属服务器元数据包含了裸金属服务器在云平台的基本信息，例如服务器ID、主机名、网络信息等。您可以更新裸金属服务器的元数据。 租户配额管理 查询某租户名下，所有资源的配额信息，包括已使用配额。 密码管理 查询是否支持一键重置密码，如果支持，您可以对裸金属服务器重置密码。还包括Windows裸金属服务器的密码获取与清除。 查询Job状态 对于创建裸金属服务器、挂卸卷等异步API，命令下发后，会返回“job_id”，通过“job_id”可以查询任务的执行状态。 OpenStack原生接口（v2.1版本） 生命周期管理 查询类接口，包括查询裸金属服务器详情、查询裸金属服务器列表、查询裸金属服务器详情信息列表。 状态管理 状态管理接口，包括对裸金属服务器的启动、重启、关闭等接口。 元数据管理 裸金属服务器元数据包含了裸金属服务器在云平台的基本信息，例如服务器ID、主机名、网络信息等。您可以查询、更新、删除裸金属服务器的元数据。 IP信息查询 查询裸金属服务器的私有IP地址信息，包括IP地址版本（IPv4或者IPv6）和具体的IP地址。 裸金属服务器规格查询 查询裸金属服务器规格信息列表：查询系统中的所有规格，或者指定过滤条件检索需要的规格。 查询裸金属服务器规格详情：根据裸金属服务器的规格ID，查询规格的详细信息，比如规格名称、CPU核数、内存大小等。 查询裸金属服务器规格extra_specs参数的详情：“extra_specs”参数用于描述裸金属服务器规格的键值对，如果您想确认某个规格是否支持快速发放，可以调用该接口进行查询。 裸金属服务器网卡查询 您可以查询裸金属服务器的所有网卡；或者根据网卡ID，查询某一个网卡的详细信息，比如网卡的IP地址、MAC地址。 云硬盘管理 您可以查询裸金属服务器所挂载的云硬盘信息；或者根据磁盘ID，查询裸金属服务器挂载的某个云硬盘信息，比如挂载目录。 SSH密钥管理 查询SSH密钥信息列表、详情，创建、删除SSH密钥等功能。 一维标签管理 裸金属服务器一维标签的增删改查。 使用BMS提供的接口时，您需要使用BMS服务自身的Endpoint。 使用OpenStack原生接口时，您需要使用ECS服务注册的Endpoint。 当前版本调用OpenStack接口不支持HTTP长连接。

响应示例 1 2 3 4 5 6 7 8 9101112131415 { "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：提供了适合长期存储的资源链接。

生命周期管理 权限 对应API接口 授权项（Action） IAM项目（Project） 企业项目（Enterprise Project） 创建裸金属服务器 POST /v1/project_id}/baremetalservers bms:servers:create √ √ 查询裸金属服务器详情列表 GET /v1/{project_id}/baremetalservers/detail bms:servers:list √ √ 查询裸金属服务器详情 GET /v1/{project_id}/baremetalservers/{server_id} bms:servers:get √ √ 父主题： 权限和授权项

响应参数 参数 参数类型 描述 keypair Object SSH密钥信息，详情请参见表3。 表3 keypair字段数据结构说明 参数 参数类型 描述 fingerprint String 密钥对应指纹信息。 name String 密钥名称。 public_key String 密钥对应的公钥信息。 private_key String 密钥对应的私钥信息。 创建SSH密钥时，响应中包括private_key的信息。 导入SSH密钥时，响应中不包括private_key的信息。 user_id String 密钥所属用户ID。

响应示例 12345678 { "keypair": { "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQC9mC3WZN9UGLxgPBpP7H5jZMc6pKwOoSgre8yun6REFktn/Kz7DUt9jaR1UJyRzHxITfCfAIgSxPdGqB/oF1suMyWgu5i0625vavLB5z5kC8Hq3qZJ9zJO1poE1kyD+htiTtPWJ88e12xuH2XB/CZN9OpEiF98hAagiOE0EnOS5Q== Generated by Nova\n", "user_id": "f882feb345064e7d9392440a0f397c25", "name": "keypair-7d7c3650-dabe-4eb0-b904-5c464453c043", "fingerprint": "35:9d:d0:c3:4a:80:d3:d8:86:f1:ca:f7:df:c4:f9:d8" }}

请求示例 创建和导入名称为keypair-7d7c3650-dabe-4eb0-b904-5c464453c043，公钥信息为ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQC9mC3WZN9UGLxgPBpP7H5jZMc6pKwOoSgre8yun6REFktn/Kz7DUt9jaR1UJyRzHxITfCfAIgSxPdGqB/oF1suMyWgu5i0625vavLB5z5kC8Hq3qZJ9zJO1poE1kyD+htiTtPWJ88e12xuH2XB/CZN9OpEiF98hAagiOE0EnOS5Q== Generated by Nova\n的SSH密钥。 1 POST https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/os-keypairs 123456 { "keypair": { "name": "keypair-7d7c3650-dabe-4eb0-b904-5c464453c043", "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQC9mC3WZN9UGLxgPBpP7H5jZMc6pKwOoSgre8yun6REFktn/Kz7DUt9jaR1UJyRzHxITfCfAIgSxPdGqB/oF1suMyWgu5i0625vavLB5z5kC8Hq3qZJ9zJO1poE1kyD+htiTtPWJ88e12xuH2XB/CZN9OpEiF98hAagiOE0EnOS5Q== Generated by Nova\n" }}

请求参数 创建SSH密钥时，只需要提交SSH密钥的name属性。导入SSH密钥时，才需要提交public_key属性。 参数 是否必选 参数类型 描述 keypair 是 Object 创建或导入的SSH密钥信息，详情请参见表2。 表2 keypair字段数据结构说明 参数 是否必选 参数类型 描述 public_key 否 String 导入的公钥信息。导入公钥最大长度为1024字节。 注：长度超过1024字节会导致裸金属服务器注入该密钥失败。 name 是 String 密钥名称。 新创建的密钥名称不能和已有密钥名称相同。

基本概念 账号 用户注册时的账号，账号对其所拥有的资源及云服务具有完全的访问权限，可以重置用户密码、分配用户权限等。由于账号是付费主体，为了确保账号安全，建议您不要直接使用账号进行日常管理工作，而是创建用户并使用用户进行日常管理工作。 用户 由账号在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的获取及企业项目特性的详细信息，请参见《企业管理用户指南》。

接口使用说明（OpenStack Nova API） 网络相关服务API，请参考《虚拟私有云API参考》。 专属分布式存储相关API，请参考《专属分布式存储API参考》。 使用OpenStack原生接口时，您需要使用ECS服务的终端节点（Endpoint），获取方式请参见地区和终端节点。 文档中没有体现的OpenStack原生接口（例如：挂载云硬盘），请使用弹性云服务器对应的原生接口，参考《弹性云服务器API参考》了解详细操作。 为了支持功能不断扩展，Nova API支持版本号区分。Nova中有两种形式的版本号： 主版本号：具有独立的URL。 微版本号：通过HTTP请求头X-OpenStack-Nova-API-Version来使用，从2.27版本开始支持新的微版本头：OpenStack-API-Version。 父主题： 历史API

Token认证 Token的有效期为24小时，需要使用一个Token鉴权时，可以先缓存起来，避免频繁调用。 Token在计算机系统中代表令牌（临时）的意思，拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头中，从而通过身份认证，获得操作API的权限。Token可通过调用获取用户Token接口获取。 调用本服务API需要项目级别的Token，即调用获取用户Token接口时，请求body中auth.scope的取值需要选择project，如下所示。 { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", //IAM用户名 "password": "********", //IAM用户密码 "domain": { "name": "domainname" //IAM用户所属账号名 } } } }, "scope": { "project": { "name": "xxxxxxxx" //项目名称 } } }} 获取Token 后，再调用其他接口时，您需要在请求消息头中添加“X-Auth-Token”，其值即为Token。例如Token值为“ABCDEFJ....”，则调用接口时将“X-Auth-Token: ABCDEFJ....”加到请求消息头即可，如下所示。 123 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/projectsContent-Type: application/jsonX-Auth-Token: ABCDEFJ.... 您还可以通过这个视频教程了解如何使用Token认证：https://bbs.huaweicloud.com/videos/101333。

AK/SK认证 AK/SK签名认证方式仅支持消息体大小在12MB以内，12MB以上的请求请使用Token认证。 AK/SK认证就是使用AK/SK对请求进行签名，在请求时将签名信息添加到消息头，从而通过身份认证。 AK（Access Key ID）：访问密钥ID。与私有访问密钥关联的唯一标识符；访问密钥ID和私有访问密钥一起使用，对请求进行加密签名。 SK（Secret Access Key）：私有访问密钥。与访问密钥ID结合使用，对请求进行加密签名，可标识发送方，并防止请求被修改。 使用AK/SK认证时，您可以基于签名算法使用AK/SK对请求进行签名，也可以使用专门的签名SDK对请求进行签名。详细的签名方法和SDK使用方法请参见API签名指南。 签名SDK只提供签名功能，与服务提供的SDK不同，使用时请注意。

接口使用说明 网络相关服务API，请参考《虚拟私有云API参考》。 包周期裸金属服务器的创建和退订流程中涉及和运营类接口交互，详细信息请参见运营能力简介。 专属分布式存储相关API，请参考《专属分布式存储API参考》。 使用BMS提供的接口时，您需要使用BMS服务自身的终端节点（Endpoint），获取方式请参见终端节点。 使用SSH密钥管理OpenStack原生接口时，您需要使用ECS服务的终端节点（Endpoint），获取方式请参见地区和终端节点。 父主题： API

修订记录 版本日期 变更说明 2024-10-22 第十九次正式发布。 下线“API（OpenStack Nova v2.1 原生）”章节，废弃接口移至历史API。 2023-11-23 第十八次正式发布。 新增切换裸金属服务器操作系统。 2023-09-14 第十七次正式发布。 创建裸金属服务器，新增参数allowed_address_pairs。 2023-05-23 第十六次正式发布。 新增错误码BMS.0089，请参见错误码。 2023-02-28 第十五次正式发布。 优化错误码说明和补充错误码错误码。 补充约束条件创建裸金属服务器 2022-09-26 第十四次正式发布。 补充响应示例、请求示例、优化参数描述等。 涉及修改： 创建裸金属服务器 重装裸金属服务器操作系统 启动裸金属服务器 重启裸金属服务器 关闭裸金属服务器 裸金属服务器挂载云硬盘 裸金属服务器绑定弹性网卡 裸金属服务器解绑弹性网卡 查询裸金属服务器IP地址（废弃） 查询裸金属服务器的指定IP地址（废弃） 查询裸金属服务器元数据（废弃） 查询裸金属服务器挂载的云硬盘信息（废弃） 查询裸金属服务器详情（废弃） 查询裸金属服务器详情列表（废弃） 查询裸金属服务器详情 2022-09-05 第十三次正式发布。 新增如下接口： 获取裸金属服务器远程登录地址 裸金属服务器绑定弹性网卡 裸金属服务器解绑弹性网卡 修改裸金属服务器弹性网卡的属性 批量添加裸金属服务器标签 批量删除裸金属服务器标签 查询裸金属服务器标签 2020-11-09 第十二次正式发布。 新增如下应用示例： 示例1：创建裸金属服务器 示例2：查询裸金属服务器 示例3：裸金属服务器挂载磁盘 2020-01-20 第十一次正式发布。 权限及授权项说明，IAM控制台改版，修改权限相关描述。 2019-11-12 第十次正式发布。 新增如下接口： 查询API版本信息列表 查询指定API版本信息 查询裸金属服务器详情列表 重装裸金属服务器操作系统 启动裸金属服务器 重启裸金属服务器 关闭裸金属服务器 查询规格详情和规格扩展信息列表 查询裸金属服务器网卡信息 查询裸金属服务器挂载的云硬盘信息 更新裸金属服务器元数据 查询租户配额 查询是否支持一键重置密码 一键重置裸金属服务器密码 Windows裸金属服务器获取密码 Windows裸金属服务器清除密码 2019-06-24 第九次正式发布。 全文优化，包括补充接口使用场景、补充请求示例、优化参数描述等。 2019-05-30 第八次正式发布。 调整文档结构。 2019-05-07 第七次正式发布。 查询裸金属服务器详情、查询裸金属服务器详情（废弃）、查询裸金属服务器列表（废弃）、查询裸金属服务器详情列表（废弃），目前不支持带微版本号查询，删除相关描述。 2019-03-22 第六次正式发布。 支持细粒度授权功能，新增如下章节： 生命周期管理 状态管理 磁盘管理 2019-01-21 第五次正式发布。 错误码，补充缺失的“Error Message”信息。 2018-11-30 第四次正式发布。 创建裸金属服务器，增加“enhanced_high_speed_net”字段。 2018-10-22 第三次正式发布。 调整接口格式。 修改URI中的“tenant_id”为“project_id”。 2018-08-20 第二次正式发布。 调整文档结构。 2018-07-15 第一次正式发布。

响应参数 参数 参数类型 描述 status String Job的状态。 SUC CES S：成功 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 91011121314151617181920212223242526 { "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}

响应示例 1 2 3 4 5 6 7 8 9101112 { "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" } } ]}

响应参数 参数 参数类型 描述 keypairs Array of objects 密钥信息列表，详情请参见表2。 表2 keypairs字段数据结构说明 参数 参数类型 描述 keypair Object 密钥信息详情，详情请参见表3。 表3 keypair字段数据结构说明 参数 参数类型 描述 fingerprint String 密钥对应指纹信息。 name String 密钥名称。 type String 密钥类型，默认为“ssh”。 微版本2.2以上支持。 public_key String 密钥对应publicKey信息。

请求示例 绑定网卡，其中网卡的子网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参数的详情（废弃）查询。 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 任务异常错误信息编码。

请求示例 批量添加标签，标签键值对为key1和value1，key2和value3。 { "action": "create", "tags": [ { "key": "key1", "value": "value1" }, { "key": "key2", "value": "value3" } ]}

响应参数 参数 参数类型 描述 keypair Object SSH密钥信息，详情请参见表2。 表2 keypair字段数据结构说明 参数 参数类型 描述 public_key String 密钥对应publicKey信息。 name String 密钥名称。 fingerprint String 密钥对应指纹信息。 created_at String 密钥创建时间。 时间戳格式为ISO 8601，例如：2019-05-07T12:06:13.681238 deleted Boolean 密钥删除标记。 true：表示密钥已被删除。 false：表示密钥未被删除。 deleted_at String 密钥删除时间。 时间戳格式为ISO 8601，例如：2019-05-07T12:06:13.681238 id String 密钥ID。 updated_at String 密钥更新时间。 时间戳格式为ISO 8601，例如：2019-05-07T12:06:13.681238 user_id String 密钥所属用户信息。

响应示例 1 2 3 4 5 6 7 8 910111213 { "keypair": { "created_at": "2019-05-07T12:06:13.681238", "deleted": false, "deleted_at": null, "fingerprint": "9d:00:f4:d7:26:6e:52:06:4c:c1:d3:1d:fd:06:66:01", "id": 1, "name": "keypair-3582d8b7-e588-4aad-b7f7-f4e76f0e4314", "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDYJrTVpcMwFqQy/oMvtUSRofZdSRHEwrsX8AYkRvn2ZnCXM+b6+GZ2NQuuWj+ocznlnwiGFQDsL/yeE+/kurqcPJFKKp60mToXIMyzioFxW88fJtwEWawHKAclbHWpR1t4fQ4DS+/sIbX/Yd9btlVQ2tpQjodGDbM9Tr9/+/3i6rcR+EoLqmbgCgAiGiVV6VbM2Zx79yUwd+GnQejHX8BlYZoOjCnt3NREsITcmWE9FVFy6TnLmahs3FkEO/QGgWGkaohAJlsgaVvSWGgDn2AujKYwyDokK3dXyeX3m2Vmc3ejiqPa/C4nRrCOlko5nSgV/9IXRx1ERImsqZnE9usB Generated-by-Nova", "updated_at": null, "user_id": "fake" }}

响应参数 参数 参数类型 描述 version Object 描述version对象。 id String 版本ID（版本号），如v1。 links Array of objects API的URL地址。 href String 当前API版本的引用地址。 rel String 当前API版本和被引用地址的关系。 version String 若该版本API支持微版本，则为支持的最大微版本号；如果不支持微版本，则为空。 status String 版本状态，为如下3种： CURRENT：表示该版本为主推版本。 SUPPORTED：表示为老版本，但是现在还继续支持。 DEPRECATED：表示为废弃版本，存在后续删除的可能。 updated String 版本发布时间，要求用UTC时间表示。 例如v1发布的时间为：2014-06-28T12:20:21Z。 min_version String 若该版本API支持微版本，则为支持的最小微版本号；如果不支持微版本，则为空。