创建云主机-CreateUHostInstance

创建UHost实例。

Request Parameters

Parameter nameTypeDescriptionRequired
Regionstring地域。 参见 地域和可用区列表Yes
Zonestring可用区。参见 可用区列表Yes
ProjectIdstring项目ID。不填写为默认项目,子帐号必须填写。 请参考GetProjectList接口No
ImageIdstring镜像ID。 请通过 DescribeImage获取Yes
MachineTypestring云主机机型(V2.0),在本字段和字段UHostType中,仅需要其中1个字段即可;当填写了MachineType时,必须填写MinimalCpuPlatform字段。枚举值["N", "C", "G", "O"]。参考云主机机型说明No
MinimalCpuPlatformstring最低cpu平台,枚举值["Intel/Auto", "Intel/IvyBridge", "Intel/Haswell", "Intel/Broadwell", "Intel/Skylake", "Intel/Cascadelake"。No
UHostTypestring【建议后续不再使用】云主机机型(V1.0),在本字段和字段MachineType中,仅需要其中1个字段即可。参考云主机机型说明No
CPUint虚拟CPU核数。可选参数:1-64(具体机型与CPU的对应关系参照控制台)。默认值: 4。No
Memoryint内存大小。单位:MB。范围 :[1024, 262144],取值为1024的倍数(可选范围参考控制台)。默认值:8192No
GpuTypestringGPU类型,枚举值["K80", "P40", "V100"],MachineType为G时必填No
GPUintGPU卡核心数。仅GPU机型支持此字段(可选范围与MachineType+GpuType相关)No
Disks.N.IsBootstring是否是系统盘。枚举值:
> True,是系统盘
> False,是数据盘(默认)。Disks数组中有且只能有一块盘是系统盘。
Yes
Disks.N.Typestring磁盘类型。请参考磁盘类型Yes
Disks.N.Sizeint磁盘大小,单位GB,必须是10GB的整数倍。请参考磁盘类型Yes
Disks.N.BackupTypestring磁盘备份方案。枚举值:
> NONE,无备份
> DATAARK,数据方舟
当前磁盘支持的备份模式参考 磁盘类型
No
Disks.N.Encryptedbool【功能仅部分可用区开放,详询技术支持】磁盘是否加密。加密:true, 不加密: false, 加密必须传入对应的的KmsKeyIdNo
Disks.N.KmsKeyIdstring【功能仅部分可用区开放,详询技术支持】kms key id。选择加密盘时必填。No
Disks.N.CouponIdstring云盘代金券id。不适用于系统盘/本地盘。请通过DescribeCoupon接口查询,或登录用户中心查看No
NetCapabilitystring网络增强特性。枚举值:Normal(默认),不开启; Super,开启网络增强1.0; Ultra,开启网络增强2.0(仅支持部分可用区,请参考控制台)No
HotplugFeaturebool热升级特性。True为开启,False为未开启,默认False。No
VPCIdstringVPC ID。默认为当前地域的默认VPC。No
SubnetIdstring子网 ID。默认为当前地域的默认子网。No
PrivateIp.Nstring【数组】创建云主机时指定内网IP。若不传值,则随机分配当前子网下的IP。调用方式举例:PrivateIp.0=x.x.x.x。当前只支持一个内网IP。No
SecurityGroupIdstring防火墙ID,默认:Web推荐防火墙。如何查询SecurityGroupId请参见 DescribeFirewallNo
NetworkInterface.N.EIP.Bandwidthint【若绑定EIP,此参数必填】弹性IP的外网带宽, 单位为Mbps. 共享带宽模式必须指定0M带宽, 非共享带宽模式必须指定非0Mbps带宽. 各地域非共享带宽的带宽范围如下: 流量计费[1-300],带宽计费[1-800]No
NetworkInterface.N.EIP.PayModestring弹性IP的计费模式. 枚举值: "Traffic", 流量计费; "Bandwidth", 带宽计费; "ShareBandwidth",共享带宽模式. "Free":免费带宽模式.默认为 "Bandwidth".No
NetworkInterface.N.EIP.ShareBandwidthIdstring绑定的共享带宽Id,仅当PayMode为ShareBandwidth时有效No
NetworkInterface.N.EIP.GlobalSSH.Areastring填写支持SSH访问IP的地区名称,如“洛杉矶”,“新加坡”,“香港”,“东京”,“华盛顿”,“法兰克福”。Area和AreaCode两者必填其中之一。No
NetworkInterface.N.EIP.OperatorNamestring【若绑定EIP,此参数必填】弹性IP的线路。枚举值: 国际: International BGP: Bgp 各地域允许的线路参数如下: cn-sh1: Bgp cn-sh2: Bgp cn-gd: Bgp cn-bj1: Bgp cn-bj2: Bgp hk: International us-ca: International th-bkk: International kr-seoul:International us-ws:International ge-fra:International sg:International tw-kh:International.其他海外线路均为 InternationalNo
NetworkInterface.N.EIP.GlobalSSH.PortintSSH端口,1-65535且不能使用80,443端口No
NetworkInterface.N.EIP.CouponIdstring当前EIP代金券id。请通过DescribeCoupon接口查询,或登录用户中心查看。No
NetworkInterface.N.EIP.GlobalSSH.AreaCodestringGlobalSSH的地区编码,格式为区域航空港国际通用代码。Area和AreaCode两者必填其中之一。No
IsolationGroupstring硬件隔离组id。可通过DescribeIsolationGroup获取。No
AlarmTemplateIdint告警模板id,如果传了告警模板id,且告警模板id正确,则绑定告警模板。绑定告警模板失败只会在后台有日志,不会影响创建主机流程,也不会在前端报错。No
NamestringUHost实例名称。默认:UHost。请遵照字段规范设定实例名称。No
Tagstring业务组。默认:Default(Default即为未分组)。请遵照字段规范设定业务组。No
LoginModestring主机登陆模式。密码(默认选项): Password。Yes
PasswordstringUHost密码。请遵照字段规范设定密码。密码需使用base64进行编码。Yes
UserDatastring【即将支持】用户自定义数据。当镜像支持Cloud-init Feature时可填写此字段。注意:1、总数据量大小不超多16K;2、使用base64编码No
ChargeTypestring计费模式。枚举值为:
> Year,按年付费;
> Month,按月付费;
> Dynamic,按小时预付费
> Postpay,按小时后付费(支持关机不收费,目前仅部分可用区支持,请联系您的客户经理)
默认为月付
No
Quantityint购买时长。默认:值 1。按小时购买(Dynamic/Postpay)时无需此参数。 月付时,此参数传0,代表购买至月末。No
MaxCountint本次最大创建主机数量,取值范围是[1,100],默认值为1。No
CouponIdstring主机代金券ID。请通过DescribeCoupon接口查询,或登录用户中心查看No

Response Elements

Parameter nameTypeDescriptionRequired
RetCodeint操作返回码Yes
Actionstring操作名称Yes
UHostIdsarrayUHost实例Id集合No
IPsarray【批量创建不会返回】IP信息No

Request Example

https://api.ucloud.cn/?Action=CreateUHostInstance
&Region=cn-bj2
&Zone=cn-bj2-04
&ImageId=uimage-xxxx
&Password=xxx
&MachineType=N
&MinimalCPUPlatform=Intel/Auto
&CPU=1
&Memory=1024
&Disks.0.Type=CLOUD_SSD
&Disks.0.IsBoot=True
&Disks.0.Size=20
&Disks.1.Type=CLOUD_NORMAL
&Disks.1.IsBoot=False
&Disks.1.Size=100
&MaxCount=8
&NetworkInterface.0.EIP.OperatorName=Bgp
&NetworkInterface.0.EIP.Bandwidth=2
&NetworkInterface.0.EIP.PayMode=Bandwidth

Response Example

{
    "RetCode": 0,
    "Action": "CreateUHostInstanceResponse",
    "UHostIds": [
        "uhost-xxx"
    ],
    "IPs": [
        "10.19.xx.xxx"
    ]
}