网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts盘古助手
华为云Astro大屏应用
计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
云手机服务器 CPH
专属主机 DeH
弹性伸缩 AS
镜像服务 IMS
函数工作流 FunctionGraph
云耀云服务器(旧版)
VR云渲游平台 CVR
Huawei Cloud EulerOS
云化数据中心 CloudDC
网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
CDN与智能边缘
内容分发网络 CDN
智能边缘云 IEC
智能边缘平台 IEF
CloudPond云服务
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
可信智能计算服务 TICS
推荐系统 RES
云搜索服务 CSS
数据可视化 DLV
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
湖仓构建 LakeFormation
智能数据洞察 DataArts Insight
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
开天aPaaS
应用平台 AppStage
开天企业工作台 MSSE
开天集成工作台 MSSI
API中心 API Hub
云消息服务 KooMessage
交换数据空间 EDS
云地图服务 KooMap
云手机服务 KooPhone
组织成员账号 OrgID
云空间服务 KooDrive
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
区块链
区块链服务 BCS
数字资产链 DAC
华为云区块链引擎服务 HBS
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
价格
成本优化最佳实践
专属云商业逻辑
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
其他
管理控制台
消息中心
产品价格详情
系统权限
客户关联华为云合作伙伴须知
公共问题
宽限期保留期
奖励推广计划
活动
云服务信任体系能力说明
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts盘古助手
华为云Astro大屏应用
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
存储容灾服务 SDRS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
云存储网关 CSG
专属分布式存储服务 DSS
数据工坊 DWR
地图数据 MapDS
键值存储服务 KVS
容器
云容器引擎 CCE
云容器实例 CCI
容器镜像服务 SWR
云原生服务中心 OSC
应用服务网格 ASM
华为云UCS
数据库
云数据库 RDS
数据复制服务 DRS
文档数据库服务 DDS
分布式数据库中间件 DDM
云数据库 GaussDB
云数据库 GeminiDB
数据管理服务 DAS
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
AI开发平台ModelArts
华为HiLens
图引擎服务 GES
图像识别 Image
文字识别 OCR
自然语言处理 NLP
内容审核 Moderation
图像搜索 ImageSearch
医疗智能体 EIHealth
企业级AI应用开发专业套件 ModelArts Pro
人脸识别服务 FRS
对话机器人服务 CBS
语音交互服务 SIS
人证核身服务 IVS
视频智能分析服务 VIAS
城市智能体
自动驾驶云服务 Octopus
盘古大模型 PanguLargeModels
IoT物联网
设备接入 IoTDA
全球SIM联接 GSL
IoT数据分析 IoTA
路网数字化服务 DRIS
IoT边缘 IoTEdge
设备发放 IoTDP
企业应用
域名注册服务 Domains
云解析服务 DNS
企业门户 EWP
ICP备案
商标注册
华为云WeLink
华为云会议 Meeting
隐私保护通话 PrivateNumber
语音通话 VoiceCall
消息&短信 MSGSMS
云管理网络
SD-WAN 云服务
边缘数据中心管理 EDCM
云桌面 Workspace
应用与数据集成平台 ROMA Connect
ROMA资产中心 ROMA Exchange
API全生命周期管理 ROMA API
政企自服务管理 ESM
视频
实时音视频 SparkRTC
视频直播 Live
视频点播 VOD
媒体处理 MPC
视频接入服务 VIS
数字内容生产线 MetaStudio
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
专属云
专属计算集群 DCC
开发者工具
SDK开发指南
API签名指南
DevStar
华为云命令行工具服务 KooCLI
Huawei Cloud Toolkit
CodeArts API
云化转型
云架构中心
云采用框架
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
客户运营能力
国际站常见问题
支持计划
专业服务
合作伙伴支持计划
我的凭证
华为云公共事业服务云平台
工业软件
工业数字模型驱动引擎
硬件开发工具链平台云服务
工业数据转换引擎云服务

创建裸金属服务器

更新时间:2025-02-21 GMT+08:00
分享

功能介绍

创建一台或多台裸金属服务器

背景信息(设置登录鉴权方式)

裸金属服务器的登录鉴权方式包括两种:密钥对、密码。为安全起见,推荐使用密钥对方式。

  • 密钥对

    指使用密钥对作为裸金属服务器的鉴权方式。

    接口调用方法:使用key_name字段,指定裸金属服务器登录时使用的密钥文件。key_name字段的使用方法请参见表2

  • 密码

    指使用设置初始密码方式作为裸金属服务器的鉴权方式,此时,您可以通过用户名密码方式登录裸金属服务器,Linux操作系统时为root用户的初始密码。

    接口调用方法:

    • 方法一(推荐):使用adminPass字段,指定管理员账号的初始登录密码,adminPass字段的使用方法请参见表2
      说明:

      此时,对于安装了Cloud-init镜像的Linux裸金属服务器,若指定user_data字段,则该adminPass字段无效。

    • 方法二:
      • 对于镜像已安装Cloud-init的Linux裸金属服务器:使用user_data字段进行注入,具体请参见表2
    说明:

    公共镜像默认已安装Cloud-init或者Cloudbase-init,私有镜像需要您自行确认是否安装。

约束

  • 不支持文件注入功能。
  • 目前仅支持创建包周期裸金属服务器
  • 不支持市场镜像创建裸金属服务器

注意事项

  • 该接口可以使用合作伙伴自身的AK/SK或者Token调用,也可以用合作伙伴子客户的AK/SK或者Token来调用。
  • 如果使用AK/SK认证方式,示例代码中的region请参考地区和终端节点中“裸金属服务器 BMS”下“区域”的内容,serviceName(英文服务名称缩写)请指定为BMS。
  • Endpoint请参考地区和终端节点中“裸金属服务器 BMS”下“终端节点(Endpoint)”的内容。
  • 请保证账户余额充足,此接口无法使用优惠券支付,若余额不足会报“BMS.0216”错误码。若想使用优惠券,请将request请求中的isAutoPay字段设置为false,然后在华为云官网页面使用优惠券进行支付或者调用“查询订单可用优惠券”和“支付包周期产品订单”接口进行支付。

调试

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

URI

POST /v1/{project_id}/baremetalservers

参数说明请参见表1

表1 参数说明

参数

是否必选

描述

project_id

项目ID。

获取方式请参见获取项目ID

请求参数

参数

是否必选

参数类型

描述

server

Object

裸金属服务器信息。详情请参见表2

表2 server字段数据结构说明

参数

是否必选

参数类型

描述

imageRef

String

裸金属服务器使用的镜像ID或者镜像资源的URL。ID格式为通用唯一识别码(Universally Unique Identifier,简称UUID)。

镜像ID可以从镜像服务控制台获取,或者参考《镜像服务API参考》的“查询镜像列表”章节查询。

在使用“查询镜像列表”API查询时,可以添加过滤字段“?virtual_env_type=Ironic”来筛选裸金属服务器镜像。

flavorRef

String

裸金属服务器使用的规格ID,格式为physical.x.x。

规格ID可以从裸金属服务器控制台获取,也可以通过查询规格详情和规格扩展信息列表API查询。

说明:

裸金属服务器规格与镜像间的约束关系请参见裸金属服务器类型与支持的操作系统版本

对于physical.x.x.hba类型的规格,申请的租户只能是DeC租户,且只能挂载DESS卷。

name

String

裸金属服务器名称。

取值范围:

  • 只能由中文字符、英文字母(a~z,A~Z)、数字(0~9)、下划线(_)、中划线(-)、点(.)组成,且长度为[1-63]个字符。
  • 创建的裸金属服务器数量大于1时,为区分不同裸金属服务器,创建过程中系统会自动在名称后加“-0000”的类似标记。故此时名称的长度为[1-58]个字符。

metadata

Object

裸金属服务器元数据,key和value的长度均不大于255字节。详情请参见表3

user_data

String

创建裸金属服务器过程中待注入的用户数据。支持注入文本。

约束:

  • 注入内容,需要进行base64格式编码。注入内容(编码之前的内容)最大长度32KB。
  • 当key_name没有指定时,user_data注入的数据默认为裸金属服务器root账户的登录密码。
  • 创建密码方式鉴权的Linux裸金属服务器时为必填项,为root用户注入自定义初始化密码。

建议密码复杂度如下:

  • 长度为8-26位。
  • 密码至少必须包含大写字母(A-Z)、小写字母(a-z)、数字(0-9)和特殊字符(!@$%^-_=+[{}]:,./?)中的三种。
示例:
1
2
#!/bin/bash 
echo 'root:$6$V6azyeLwcD3CHlpY$BN3VVq18fmCkj66B4zdHLWevqcxlig' | chpasswd -e

其中,$6$V6azyeLwcD3CHlpY$BN3VVq18fmCkj66B4zdHLWevqcxlig为密文密码,生成方法如下:

  1. 生成加密盐值
    1
    2
    [root@test linux]# python -c "import crypt, getpass, pwd;print crypt.mksalt()" 
    $6$V6azyeLwcD3CHlpY
    
  2. 根据盐值生成密文密码
    1
    2
    [root@test linux]# python -c "import crypt, getpass, pwd;print crypt.crypt('Cloud.1234','\$6\$V6azyeLwcD3CHlpY')" 
     $6$V6azyeLwcD3CHlpY$BN3VVq18fmCkj66B4zdHLWevqcxlig
    
说明:

使用Linux镜像并且采用密码登录裸金属服务器时,不支持数据注入。如何注入请参见用户数据注入

adminPass

String

如果需要使用密码方式登录裸金属服务器,可使用adminPass字段指定裸金属服务器管理员账户初始登录密码。其中,Linux管理员账户为root。

密码复杂度要求:
  • 长度为8-26位。
  • 密码至少必须包含大写字母、小写字母、数字和特殊字符(!@$%^-_=+[{}]:,./?)中的三种。
  • Linux系统密码不能包含用户名或用户名的逆序。

key_name

String

扩展属性,指定密钥的名称。如果需要使用SSH密钥方式登录裸金属服务器,请指定已有密钥的名称。

密钥可以通过创建和导入SSH密钥(OpenStack原生)API创建,或者使用查询SSH密钥列表(OpenStack原生)API查询已有的密钥。

约束:

  • 当key_name和user_data同时指定时,user_data只能用做用户数据注入。
  • 当使用Windows镜像创建裸金属服务器时,该字段不能为空(即Windows镜像只支持密钥登录)。
  • Windows裸金属服务器登录时,首先需要将密钥解析为密码,然后通过远程登录工具进行登录。具体请参见“MSTSC密码方式登录”。

security_groups

Array of objects

指定裸金属服务器的安全组。详情请参见表4

nics

Array of objects

指定裸金属服务器的网卡信息。详情请参见表5

约束:

一个裸金属服务器最多挂载2个网卡,参数中第一个网卡会作为裸金属服务器的主网卡。若用户指定了多组网卡参数,需保证各组参数都属于同一VPC。

availability_zone

String

裸金属服务器对应可用区信息,需要指定可用区(AZ)的名称。

请参考地区和终端节点获取。

vpcid

String

裸金属服务器所属虚拟私有云(VPC),需要指定已有VPC的ID,UUID格式。VPC的ID可以从网络控制台或者参考《虚拟私有云API参考》的“查询VPC”章节获取。

publicip

Object

配置裸金属服务器的弹性公网IP信息,弹性公网IP有三种配置方式:

  • 不使用(无该字段)。
  • 自动分配,需要指定新创建弹性公网IP的信息。
  • 使用已有,需要指定已创建弹性公网IP的信息。

详情请参见表7

count

Integer

创建裸金属服务器的数量。

约束:

  • 不传该字段时默认取值为1。
  • 租户的配额足够时,最大值为100。

root_volume

Object

裸金属服务器对应系统盘相关配置。详情请参见表8

约束:

当规格是快速发放时,该参数必选;当规格不是快速发放时,不传该参数。查询规格是否为快速发放,参见查询裸金属服务器规格extra_specs参数的详情(废弃)

data_volumes

Array of objects

裸金属服务器对应数据盘相关配置。每一个数据结构代表一个待创建的数据盘。详情请参见表9

约束:

目前裸金属服务器最多可挂载60块云硬盘(包括系统盘和数据盘)。

extendparam

Object

创建裸金属服务器的附加信息。详情请参见表10

schedulerHints

Object

裸金属服务器的调度信息。当需要在专属云中创建裸金属服务器时,该字段必选。

详情请参见表11

server_tags

List <resource_tag>

裸金属服务器的标签,详见表12

说明:

创建裸金属服务器时,一台裸金属服务器最多可以添加10个标签。其中,__type_baremetal为系统内部标签,因此实际能添加的标签为9个。

表3 metadata字段数据结构说明

参数

是否必选

参数类型

描述

op_svc_userid

String

用户ID(登录管理控制台,进入我的凭证,即可看到“用户ID”)。

BYOL

String

是否自带许可,取值“true”或“false”。

admin_pass

String

如果需要使用密码方式登录裸金属服务器,可使用admin_pass字段指定裸金属服务器管理员账户初始登录密码。其中,Linux管理员账户为root。

密码复杂度要求:
  • 长度为8-26位。
  • 密码至少必须包含大写字母、小写字母、数字和特殊字符(!@$%^-_=+[{}]:,./?)中的三种。
  • 密码不能包含用户名或用户名的逆序,不能包含用户名中超过两个连续字符的部分。

agency_name

String

委托的名称。

委托是由租户管理员在统一身份认证服务(Identity and Access Management,IAM)上创建的,可以作为其他租户访问此裸金属服务器的临时凭证。

说明:

委托获取、更新请参考如下步骤:

  1. 使用IAM服务提供的查询指定条件下的委托列表接口,获取有效可用的委托名称。
  2. 使用更新裸金属服务器元数据接口,更新metadata中agency_name字段为新的委托名称。
表4 security_groups字段数据结构说明

参数

是否必选

参数类型

描述

id

String

裸金属服务器对应的安全组ID,对创建裸金属服务器中配置的所有网卡生效。

  • 当该参数未指定时默认给裸金属服务器绑定default安全组。
  • 当该参数传值(UUID格式)时需要指定已有安全组的ID。获取已有安全组的方法请参见《虚拟私有云API参考》的“查询安全组列表”章节。
表5 nics字段数据结构说明

参数

是否必选

参数类型

描述

subnet_id

String

裸金属服务器网卡所在的子网信息。

需要指定vpcid对应VPC下已创建的子网(subnet)的网络ID(network_id),UUID格式。子网(subnet)的网络ID(network_id)可以从虚拟私有云控制台或者参考《虚拟私有云API参考》的“查询子网列表”章节获取。

ip_address

String

裸金属服务器网卡的IP地址,IPv4格式。

约束:

  • 不填或空字符串,默认在子网中自动分配一个未使用的IP作为网卡的IP地址。
  • 若指定IP地址,该IP地址必须在子网的网段内,且未被使用。
  • 批量创建裸金属服务器时,不支持指定IP地址。

allowed_address_pairs

Array of allow_address_pair objects

IP/Mac对列表,详情请参见表6(扩展属性)。

约束:IP地址不允许为 “0.0.0.0/0”

  • 如果allowed_address_pairs配置地址池较大的CIDR(掩码小于24位),建议为该port配置一个单独的安全组
  • 如果allowed_address_pairs为“1.1.1.1/0”,表示关闭源目的地址检查开关
  • 如果是虚拟IP绑定云服务器,
    • 则mac_address可为空或者填写被绑定云服务器网卡的Mac地址。
    • 被绑定的云服务器网卡allowed_address_pairs的IP地址填“1.1.1.1/0”。
表6 allow_address_pair字段数据结构说明

名称

是否必选

参数类型

说明

ip_address

String

IP地址。

约束:不支持0.0.0.0/0

如果allowed_address_pairs配置地址池较大的CIDR(掩码小于24位),建议为该port配置一个单独的安全组。

mac_address

String

MAC地址。

表7 publicip字段数据结构说明

参数

是否必选

参数类型

描述

id

String

创建裸金属服务器分配已有弹性公网IP时,分配的弹性公网IP的ID,UUID格式。弹性公网IP的ID可以从网络控制台或者参考《弹性公网IP API参考》的“查询弹性公网IP列表”章节获取。

约束:

  • 只能分配状态(status)为DOWN的弹性公网IP。
  • 批量创建裸金属服务器时,不能使用已有弹性公网IP,即不支持此参数。

eip

Object

配置裸金属服务器自动分配弹性公网IP时,创建弹性公网IP的配置参数。详情请参见表13

说明:

输入publicip字段数据结构中的id和eip参数值时,只能选择其中一个输入。

表8 root_volume字段数据结构说明

参数

是否必选

参数类型

描述

volumetype

String

裸金属服务器系统盘对应的磁盘类型,需要与系统所提供的磁盘类型相匹配。

  • GPSSD:通用型SSD磁盘类型
  • SAS:高IO磁盘类型
  • SSD:超高IO磁盘类型

size

Integer

系统盘大小,容量单位为GB,输入大小范围为[40-1024]。

约束:

系统盘大小取值应不小于镜像中系统盘的最小值(min_disk属性)。

cluster_id

String

裸金属服务器系统盘对应的存储池的ID。

说明:

cluster_type

String

裸金属服务器系统盘对应的磁盘存储类型。磁盘存储类型枚举值:DSS(专属分布式存储)。

说明:
表9 data_volumes字段数据结构说明

参数

是否必选

参数类型

描述

volumetype

String

裸金属服务器数据盘对应的磁盘类型,需要与系统所提供的磁盘类型相匹配。

  • GPSSD:通用型SSD磁盘类型
  • SAS:高IO磁盘类型
  • SSD:超高IO磁盘类型

约束:

  • 在专属云中申请裸金属服务器时,须使用专属企业存储,此时该字段前缀必须是DESS_。

    枚举值如下:

    DESS_SAS_ISCSI:普通I/O企业存储

    DESS_SAS_FC:普通I/O企业存储(低延时)

    DESS_MIX_ISCSI:高I/O企业存储

    DESS_MIX_FC:高I/O企业存储(低延时)

    DESS_SSD_ISCSI:超高I/O企业存储

    DESS_SSD_FC:超高I/O企业存储(低延时)

  • 所有用户,包年包月场景下,不能挂载DESS卷。
说明:

企业存储支持的存储类型说明可以从管理控制台或参考《专属企业存储服务用户指南》的“申请专属企业存储”章节获取。

size

Integer

数据盘大小,容量单位为GB,输入大小范围为[10-32768]。

shareable

Boolean

是否为共享磁盘。

  • true为共享盘
  • false为普通云硬盘

不指定时默认为false。

cluster_id

String

裸金属服务器数据盘对应的存储池ID。

说明:

cluster_type

String

裸金属服务器数据盘对应的磁盘存储类型。磁盘存储类型枚举值:DSS(专属分布式存储)。

说明:
表10 创建裸金属服务器的extendparam字段数据结构说明

参数

是否必选

参数类型

描述

chargingMode

String

计费模式。取值范围:

prePaid:预付费,即包年包月。默认值是prePaid。

regionID

String

裸金属服务器所在区域ID。

请参考地区和终端节点获取。

periodType

String

订购周期类型。取值范围:

  • month:月
  • year:年
说明:

chargingMode为prePaid时生效,且为必选值。

periodNum

Integer

订购周期数。取值范围:

  • periodType=month(周期类型为月)时,取值为[1-9]。
  • periodType=year(周期类型为年)时,取值为1。
说明:

chargingMode为prePaid时生效,且为必选值。

isAutoRenew

String

是否自动续订。

  • true:自动续订
  • false:不自动续订
说明:

chargingMode为prePaid时生效,不指定该参数或者该参数值为空时默认为不自动续订。

isAutoPay

String

下单订购后,是否自动从客户的账户中支付,而不需要客户手动去支付。

  • true:是(自动支付)
  • false:否(需要客户手动支付)
说明:

chargingMode为prePaid时生效,不指定该参数或者该参数值为空时默认为客户手动支付。

enterprise_project_id

String

企业项目ID。

该字段不传(或传为字符串“0”),则将资源绑定给默认企业项目。

说明:

关于企业项目ID的获取及企业项目特性的详细信息,请参见《企业管理API参考》。

表11 schedulerHints字段数据结构说明

参数

是否必选

参数类型

描述

dec_baremetal

String

是否在专属云中创建裸金属服务器,参数值为share或dedicate。

约束:

  • 该值不传时默认为share。
  • 在专属云中创建裸金属服务器时,必须指定该字段为dedicate。
表12 server_tags字段数据结构说明

参数

是否必选

参数类型

描述

key

String

  • 最大长度36个unicode字符,不能为空。
  • 不能包含非打印字符ASCII(0-31),以及以下特殊字符:=*<>\,|/
  • 同一资源的key值不能重复。

value

String

  • 每个值最大长度43个unicode字符,可以为空字符串。
  • 不能包含非打印字符ASCII(0-31),以及以下特殊字符:=*<>\,|/
表13 eip字段数据结构说明

参数

是否必选

参数类型

描述

iptype

String

弹性公网IP地址类型。

类型枚举值:5_bgp、5_sbgp

详情请参见《弹性公网IP API参考》“申请弹性公网IP”章节的“publicip”字段说明。

bandwidth

Object

弹性公网IP带宽。详情请参见表14

extendparam

Object

创建弹性公网IP的附加信息。详情请参见表15

表14 bandwidth字段数据结构说明

参数

是否必选

参数类型

描述

name

String

带宽名称。

sharetype

String

带宽的共享类型。

共享类型枚举:PER,表示独享;WHOLE,表示共享

id

String

共享带宽ID。创建WHOLE类型带宽的弹性公网IP时可以指定之前的共享带宽创建。

共享带宽的使用限制请参见“共享带宽简介”。

说明:

当创建WHOLE类型的带宽时,该字段必选。

size

Integer

  • 取值范围:默认5Mbit/s~2000Mbit/s(具体范围以各Region配置为准,请参见管理控制台对应页面显示)。
  • 功能说明:带宽大小。共享带宽的大小有最小值限制,默认为5M。
说明:
  • 如果传入的参数为小数(如10.2)或者字符类型(如10),会自动强制转换为整数。带宽小于300Mbit/s时,步长支持1Mbit/s;带宽为300Mbit/s~1000Mbit/s时,步长支持50Mbit/s;带宽为1000Mbit/s~2000Mbit/s时,步长支持1000Mbit/s。
  • 如果sharetype是PER,该参数必选;如果sharetype是WHOLE并且id有值,该参数会忽略。

chargemode

String

带宽的计费类型。

取值为:traffic(按流量计费)、bandwidth(按带宽计费)

  • 未传该字段,表示按带宽计费。
  • 字段值为空,表示按带宽计费。
说明:

如果sharetype是WHOLE并且id有值,仅支持按带宽计费,该参数会忽略。

表15 创建弹性公网IP的extendparam字段数据结构说明

参数

是否必选

参数类型

描述

chargingMode

String

弹性公网IP的计费模式。若chargemode取值为bandwidth,则支持prePaid和postPaid;若chargemode取值为traffic,则仅支持postPaid。

取值范围:

  • prePaid:预付费,即包年包月
  • postPaid:后付费,即按需付费
说明:

如果bandwidth对象中sharetype是WHOLE且id有值,弹性公网IP只能创建为按需付费的,故该参数传参“prePaid”无效。

请求示例

  • 创建一个裸金属服务器,镜像ID为766a545a-02e1-433e-b1d1-733b5dc95e94,规格为physical.s3.large,计费模式为包年包月,使用密码方式远程登录。
    1
    POST https://{BMS Endpoint}/v1/{project_id}/baremetalservers
    
     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
    {
        "server": {
            "availability_zone": "az1",
            "name": "bms-75c7",
            "imageRef": "766a545a-02e1-433e-b1d1-733b5dc95e94",
            "flavorRef": "physical.s3.large",
            "data_volumes": [
                {
                    "volumetype": "SAS",
                    "size": 10,
                    "shareable": false
                }
            ],
            "vpcid": "8df83bf2-fd2e-4ee0-9692-c0b7736513fb",
            "nics": [
                {
                    "subnet_id": "c6bb8788-4fd1-4a8f-adab-7eba3bed8616",
                    "ip_address": ""
                }
            ],
            "count": 1,
            "schedulerHints": {
                "dec_baremetal": "share"
            },
            "extendparam": {    
                "chargingMode": "prePaid",
                "periodType": "month",
                "periodNum": 1,
                "isAutoRenew": "true",
                "isAutoPay": "true",
                "regionID": "region01"
            },
            "metadata": {
                "op_svc_userid": "59781460e9e54886a7d03df7d3f3fc81",
                "BYOL": "false",
                "admin_pass": "$ADMIN_PASS"
            },
            "publicip": {
                "id": "1b036bce-26b4-465c-acea-99fdbb0573a3"
            },
            "user_data": "$USER_DATA",
            "security_groups": [
                {
                    "id": "993f2916-5bad-4f24-bc3c-db539f1a6d19"
                }
            ]
        }
    }
    
  • 创建一个包年包月的Linux裸金属服务器,可用区为az1,名称为bms-3b91,镜像ID为766a545a-02e1-433e-b1d1-733b5dc95e94规格为physical.o2.large且使用密钥方式远程登录。
     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
    {
        "server": {
            "availability_zone": "az1",
            "name": "bms-3b91",
            "imageRef": "766a545a-02e1-433e-b1d1-733b5dc95e94",
            "flavorRef": "physical.o2.large",
            "data_volumes": [
                {
                    "volumetype": "SAS",
                    "size": 10,
                    "shareable": true
                }
            ],
            "vpcid": "8df83bf2-fd2e-4ee0-9692-c0b7736513fb",
            "nics": [
                {
                    "subnet_id": "c6bb8788-4fd1-4a8f-adab-7eba3bed8616",
                    "ip_address": ""
                },
                {
                    "subnet_id": "2b8bcf33-33f2-4a63-aa9c-b1e17ff0ed7f",
                    "ip_address": ""
                }
            ],
            "count": 1,
            "schedulerHints": {
                "dec_baremetal": "share"
            },
            "extendparam": {
                "chargingMode": "prePaid",
                "periodType": "month",
                "periodNum": 1,
                "isAutoRenew": "true",
                "isAutoPay": "true",
                "regionID": "region01"
            },
            "metadata": {
                "op_svc_userid": "59781460e9e54886a7d03df7d3f3fc81",
                "BYOL": "false"
            },
            "publicip": {
                "eip": {
                    "iptype": "5_bpg",
                    "bandwidth": {
                        "chargemode": "",
                        "name": "bms-3b91-bandwidth",
                        "size": 1,
                        "sharetype": "PER"
                    },
                    "extendparam": {
                       "chargingMode": "prePaid"
                    }
                }
            },
            "security_groups": [
                {
                    "id": "993f2916-5bad-4f24-bc3c-db539f1a6d19"
                }
            ],
            "key_name": "$key_name"
        }
    }
    

    Java语言生成user_data示例如下:

    1
    2
    3
    String userData_org = "#!/bin/bash \r\n echo    'root:xxxxx' | chpasswd ;";
    byte[] userData_byte = userData_org.getBytes();
    String userData = new BASE64Encoder().encode(userData_byte);
    
  • 创建包年包月的Windows操作系统的裸金属服务器,可用区为az1,名称为bms-6a1e,镜像ID为fd04041a-5f35-45ae-a27c-bf30f921c6b5,规格为physical.s3.large且使用密钥方式远程登录。
     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
    { 
         "server": { 
             "availability_zone": "az1", 
             "name": "bms-6a1e", 
             "imageRef": "fd04041a-5f35-45ae-a27c-bf30f921c6b5", 
             "flavorRef": "physical.s3.large", 
             "data_volumes": [ 
                 { 
                     "volumetype": "SAS", 
                     "size": 10, 
                     "shareable": false 
                 } 
             ], 
             "vpcid": "0adc2847-c160-4263-be1f-e03d36e93e32", 
             "nics": [ 
                 { 
                     "subnet_id": "4f1cf6cc-4cc3-41d3-8192-625293dccce0", 
                     "ip_address": "" 
                 } 
             ], 
             "count": 1, 
             "schedulerHints": { 
                 "dec_baremetal": "share" 
             }, 
            "extendparam": { 
                "chargingMode": "prePaid", 
                "periodType": "month", 
                "periodNum": 1, 
                "isAutoRenew": "true", 
                "isAutoPay": "true", 
                "regionID": "region1" 
             }, 
             "metadata": { 
                "op_svc_userid": "8a74baed155b47e8b59fbca853d6cb48", 
                "BYOL": "false" 
             }, 
             "publicip": { 
                 "id": "db9c4f39-fabd-4cc2-8685-82e7715d099f" 
             }, 
             "user_data": "$USER_DATA", 
             "security_groups": [ 
                 { 
                     "id": "33cf5e40-0b65-4e03-867d-4c67947c49be" 
                 } 
             ], 
             "key_name": "$key_name"
         } 
     }
    

响应参数

表16 正常响应要素说明

名称

参数类型

说明

order_id

String

提交订单成功后返回的订单ID,用户可以使用该ID对订单的处理情况进行查询(在管理控制台的“费用中心 > 我的订单”页面查询)。

job_id

String

提交任务成功后返回的任务ID,用户可以使用该ID对任务执行情况进行查询。

如何根据job_id来查询Job的执行状态,请参考查询Job状态

表17 异常响应要素说明

名称

参数类型

说明

error

字典数据结构[1]

提交任务异常时返回的异常信息,详情请参见表18

表18 error数据结构

名称

参数类型

说明

message

String

任务异常错误信息描述。

code

String

任务异常错误信息编码。

响应示例

  • 正常响应
    { 
        "order_id": "CS2009141523OQSEQ",
        "job_id": "ff808081748b760c01748b7f80370003"
    }

返回值

正常返回值:

返回值

说明

200

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

其他返回值请参考状态码

错误码

请参考错误码

提示

您即将访问非华为云网站,请注意账号财产安全

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容