接口功能介绍

创建物理机

URI

POST /v4/ebm/create-instance

路径参数

无

Query参数

无

请求参数

请求头header参数

无

请求体body参数

参数	是否必填	参数类型	说明	示例	下级对象
regionID	是	String	资源池ID，您可以查看地域和可用区来了解资源池您可以调用资源池列表查询获取最新的天翼云资源池列表	73f321ea-62ff-11ec-a8bc-005056898fe0
azName	是	String	可用区名称，您可以查看地域和可用区来了解可用区您可以调用资源池可用区查询注：查询结果中zoneList内返回存在可用区名称(即多可用区，本字段填写实际可用区名称)，若查询结果中zoneList为空（即为单可用区，本字段填写default）	default
deviceType	是	String	物理机套餐类型	physical.t3.large
instanceName	是	String	物理机名称，长度为2-31位；支持模式串{R:x}，表示生成数字[x,x+n-1]，其中n表示购买实例的数量，1 ≤ x ≤ 9799且x只能为整数。例子：填写server{R:3}pm，购买1台时，实例主机名为server0003pm；购买2台时，实例主机名分别为server0003pm，server0004pm)；除使用模式串外，不支持冒号“:”以及大括号“{}”两类字符单独存在或其它组合方式	pm-3301
hostname	是	String	hostname，linux系统2到63位长度；windows系统2-15位长度；允许使用大小写字母、数字、连字符'-'，必须以字母开头（大小写均可），不能连续使用'-'，'-'不能用于结尾，不能仅使用数字；支持模式串{R:x}，表示生成数字[x,x+n-1]，其中n表示购买实例的数量，1 ≤ x ≤ 9799且x只能为整数。例子：填写server{R:3}pm，购买1台时，实例主机名为server0003pm；购买2台时，实例主机名分别为server0003pm，server0004pm )	host-pm-3301
imageUUID	是	String	物理机镜像id	im-xevpi6apqilz1bixmogofyref9qm
password	否	String	用户密码，满足以下规则：长度在8～30个字符；必须包含大小写字母和（至少一个数字或者特殊字符）；特殊符号可选： ()`~!@#$%&*_-+=\|{}[]:;'<>,.?/，未传入有效的keyName时必须传入password	****************
projectID	否	String	企业项目ID，企业项目管理服务提供统一的云资源按企业项目管理，以及企业项目内的资源管理，成员管理。您可以通过查看创建企业项目了解如何创建企业项目注：默认值为"0"	6732237e53bc4591b0e67d750030ebe3
systemVolumeRaidUUID	否	String	本地系统盘raid类型，如果有本地盘则必填	r-wtzluqacgzzxgunnabdkpnpjew3d
dataVolumeRaidUUID	否	String	本地数据盘raid类型，如果有本地盘则必填	r-wtzluqacgzzxgunnabdkpnpjew3d
vpcID	是	String	主网卡网络ID	4797e8a1-722d-4996-9362-458001813e41
extIP	是	String	是否使用弹性公网IP ，取值范围:[1=自动分配,0=不使用,2=使用已有]	1
ipType	否	String	弹性IP版本，取值范围:[ipv4=v4地址,ipv6=v6地址]，默认值:ipv4	ipv4
bandWidth	否	Integer	带宽，取值范围:[1~2000]，默认值:100	100
publicIP	否	String	弹性公网IP的id	259b0c37-1044-41d8-989e
securityGroupID	否	String	安全组ID，用','分隔；套餐smartNicExist为true可支持安全组。创建弹性裸金属必须传入安全组ID，标准裸金属不支持传入安全组ID	259b0c37-1044-41d8-989e-c6f20486c0f4
diskList	否	Array of Objects	云盘信息列表，套餐中supportCloud为true表示支持云盘		diskList
networkCardList	是	Array of Objects	网卡		networkCardList
userData	否	String	用户自定义数据,需要以Base64方式编码,Base64编码后的长度限制为1-16384字符	ZWNobyBoZWxsbyBnb3N0YWNrIQ==
keyName	否	String	密钥对名称	my-keyname
payVoucherPrice	否	Float	代金券，满足以下规则：两位小数，不足两位自动补0，超过两位小数的部分无效；不可为负数；字段为0时表示不使用代金券	20.55
autoRenewStatus	否	Integer	是否自动续订，默认非自动续订。取值范围： 0（不续费）， 1（自动续费），注：按月购买，自动续订周期为1个月；按年购买，自动续订周期为1年	1
instanceChargeType	否	String	实例计费类型，默认为ORDER_ON_CYCLE（包年包月）。 * ORDER_ON_CYCLE：包年包月 * ORDER_ON_DEMAND：按量付费	ORDER_ON_DEMAND
cycleCount	否	Integer	订购时长，该参数需要与cycleType一同使用注：最长订购周期为60个月（5年）；cycleType与cycleCount一起填写；按量付费（即instanceChargeType为ORDER_ON_DEMAND）时，无需填写该参数（填写无效）	6
cycleType	否	String	订购周期类型，取值范围:[MONTH=按月,YEAR=按年] 注：cycleType与cycleCount一起填写；按量付费（即instanceChargeType为ORDER_ON_DEMAND）时，无需填写该参数（填写无效）	MONTH
orderCount	是	Integer	购买数量	1
clientToken	是	String	客户端存根，用于保证订单幂等性。要求单个云平台账户内唯一，使用同一个ClientToken值，其他请求参数相同时，则代表为同一个请求。保留时间为24小时	4cf2962d-e92c-4c00-9181-cfbb2218636c

表diskList

参数	是否必填	参数类型	说明	示例
diskType	是	String	磁盘类型 system或data，套餐中cloudBoot为true表示支持云盘系统盘	data
title	否	String	磁盘名称，长度2~64,不支持中文
type	是	String	磁盘分类，取值范围:[SAS=SAS盘,SATA=SATA盘,SSD=SSD盘]	SSD
size	是	Integer	磁盘容量	100

表networkCardList

参数	是否必填	参数类型	说明	示例
title	否	String	网卡名称
fixedIP	否	String	内网IPv4地址，默认为自动分配	192.168.1.1
master	是	Boolean	是否主节点(True代表主节点)	true
ipv6	否	String	内网IPv6地址
subnetID	是	String	子网id	84c95842-13da-47e0-ac94-8fd0861295ad

响应参数

参数	参数类型	说明	示例	下级对象
statusCode	Integer	返回状态码(800为成功，900为失败)，默认值:800	800
errorCode	String	业务细分码，为product.module.code三段式码，详见错误码说明	Ebm.Create.NotValid
message	String	响应结果的描述，一般为英文描述	error request
description	String	响应结果的描述，一般为中文描述	错误请求
returnObj	Object	返回参数，参考returnObj	{}	returnObj

表returnObj

参数	参数类型	说明	示例
regionID	String	资源池ID	100054c0416811e9a6690242ac110002
masterOrderID	String	订单ID	86f7f49e241a11edb4f83003c86a1328
masterOrderNO	String	订单号	20220825100639650114

请求示例

请求头header

无

请求体body

{
	"regionID": "100054c0416811e9a6690242ac110002",
	"azName": "az2",
	"instanceName": "pm-3301",
	"hostname": "host-pm-3301",
	"deviceType": "physical.t3.large",
	"imageUUID": "im-xevpi6apqilz1bixmogofyref9qm",
	"password": "xxxxxxx",
	"systemVolumeRaidUUID": "r-wtzluqacgzzxgunnabdkpnpjew3d",
	"dataVolumeRaidUUID": "r-wtzluqacgzzxgunnabdkpnpjew3d",
	"vpcID": "4797e8a1-722d-4996-9362-458001813e41",
	"securityGroupID": "259b0c37-1044-41d8-989e-c6f20486c0f4",
	"extIP": "1",
	"ipType": "ipv4",
	"bandWidth": 100,
	"publicIP": "259b0c37-1044-41d8-989e",
	"diskList": [
	{
        "title": "disk1",
		"diskType": "data",
		"type": "SSD",
		"size": 100
	}],
	"networkCardList": [
	{
		"fixedIP": "192.168.1.1",
		"master": true,
		"subnetID": "84c95842-13da-47e0-ac94-8fd0861295ad"
	}],
	"instanceChargeType": "ORDER_ON_CYCLE",
	"cycleCount": 6,
	"cycleType": "MONTH",
	"orderCount": 1,
    "clientToken": "znHVWmmsTO"
}

响应示例

{
	"statusCode": 800,
	"errorCode": "",
	"message": "SUCCESS", 
	"description": "成功",
	"returnObj": 
	{
		"regionID": "100054c0416811e9a6690242ac110002",
		"masterOrderID": "86f7f49e241a11edb4f83003c86a1328",
		"masterOrderNO": "20220825100639650114"
	}
}

状态码

状态码	描述
200	表示请求成功

错误码

错误码	描述
Ebm.Create.NotValid	请求参数非法
Ebm.DeviceType.NotFound	请求参数非法
Ebm.FlavorCheck.SoldOut	主机规格已售罄
Ebm.VpcCheck.NotFound	vpc不存在
Ebm.PublicIp.NotFound	公网ip不存在
Ebm.PublicIp.SoldOut	该公网ip已售罄
Ebm.SecurityGroup.NotFound	安全组不存在
Ebm.Image.NotFound	镜像不存在
Ebm.Common.CheckError	内部错误，请重试
其他	参见公共错误码说明

智算服务

应用商城

合作伙伴

开发者

支持与服务

了解天翼云

物理机

物理机

接口功能介绍

URI

请求参数

响应参数

请求示例

响应示例

状态码

错误码

活动

智算服务

应用商城

合作伙伴

开发者

支持与服务

了解天翼云

物理机

物理机

接口功能介绍

URI

请求参数

响应参数

请求示例

响应示例

状态码

错误码