云主机

云主机

产品文档

云主机

帮助中心 > OpenAPI & SDK > 云主机 > createInstances

createInstances

描述

创建一台或多台指定配置的云主机，创建模式分为三种：1.普通方式、2.使用高可用组、3.使用启动模板。三种方式创建云主机时参数的必传与非必传是不同的，具体请参考参数详细说明

  • 创建云主机需要通过实名认证
  • 实例规格
    • 可查询DescribeInstanceTypes接口获得指定地域或可用区的规格信息。
    • 不能使用已下线、或已售馨的规格ID
  • 镜像
    • Windows Server所有镜像不可选超过64核的规格。
    • 可查询DescribeImages接口获得指定地域的镜像信息。
    • 选择的镜像必须支持选择的实例规格。可查询DescribeImageConstraints接口获得指定镜像的实例规格限制信息。
  • 网络配置
    • 指定主网卡配置信息
      • 必须指定subnetId
      • 可以指定elasticIp规格来约束创建的弹性IP，带宽取值范围[1,200]Mbps，步进1Mbps
      • 可以指定主网卡的内网主IP(primaryIpAddress)，此时maxCount只能为1
      • 安全组securityGroup需与子网Subnet在同一个私有网络VPC内
      • 一台云主机创建时必须至少指定一个安全组，至多指定5个安全组，如果没有指定安全组，默认使用默认安全组
      • 主网卡deviceIndex设置为1
  • 存储
    • 系统盘
      • 磁盘分类，系统盘支持local或cloud
      • 磁盘大小
        • local：不能指定大小，默认为40GB
        • cloud：取值范围: [40,500]GB，并且不能小于镜像的最小系统盘大小，如果没有指定，默认以镜像中的系统盘大小为准
      • 随主机删除
        • 如果是local类型，默认为True，随主机删除，不可修改
        • 如果是cloud类型的按配置计费的云硬盘，默认为True，可修改
        • 如果是cloud类型的包年包月的云硬盘，默认为False，不可修改
    • 数据盘
      • 磁盘分类，数据盘仅支持cloud
      • 云硬盘类型可以选择hdd.std1、ssd.gp1、ssd.io1
      • 磁盘大小
        • 范围[20,16000]GB，步长为10GB
      • 随主机删除
        • 默认为True，随主机删除，如果是包年包月的云硬盘，此参数不生效
      • 可以从快照创建磁盘
    • iops
      • 仅当云盘类型为ssd.io1时，可指定iops值，范围为[200， min(32000,size*50)]，步长为10，若不指定则按此公式计算默认值
    • 系统盘为local类型系统的云主机可以挂载8块云硬盘
    • 系统盘为cloud类型系统的云主机可以挂载7块云硬盘
  • 计费
    • 弹性IP的计费模式，如果选择按用量类型可以单独设置，其它计费模式都以主机为准
    • 云硬盘的计费模式以主机为准
  • 其他
    • 创建完成后，主机状态为running
    • 仅Linux系统云主机可以指定密钥
    • maxCount为最大努力，不保证一定能达到maxCount
    • 虚机的az会覆盖磁盘的az属性
  • 密码

请求方式

POST

请求地址

https://vm.jdcloud-api.com/v1/regions/{regionId}/instances

名称 类型 是否必需 默认值 描述
regionId String True 地域ID

请求参数

名称 类型 是否必需 默认值 描述
instanceSpec InstanceSpec True 描述云主机配置
maxCount Integer False 1 购买云主机的数量；取值范围：[1,100]，默认为1。
clientToken String False 用于保证请求的幂等性。由客户端生成，长度不能超过64个字符。

InstanceSpec

名称 类型 是否必需 默认值 描述
agId String False 高可用组Id。指定了此参数后，只能通过高可用组关联的实例模板创建虚机，并且实例模板中的参数不可覆盖替换。实例模板以外的参数还可以指定。
instanceTemplateId String False 实例模板id，如果没有使用高可用组，那么对于实例模板中没有的信息，需要使用创建虚机的参数进行补充，或者选择覆盖启动模板中的参数。
az String False 云主机所属的可用区。
instanceType String False 实例规格。可查询DescribeInstanceTypes接口获得指定地域或可用区的规格信息。
imageId String False 镜像ID。可查询DescribeImages接口获得指定地域的镜像信息。
name String True 云主机名称，不为空且只允许中文、数字、大小写字母、英文下划线（_）、连字符（-）及点（.），不能以（.）作为首尾，长度为2~128个字符。
批量创建多台云主机时，可在name中非首位位置以[start_number]格式来设置有序name。start_number为起始序号，取值范围[0,9999]。例如：name设置为“instance-[000]-ops”，则第一台主机name为“instance-000-ops”，第二台主机name为“instance-001-ops”。再如：name设置为“instance-[0]-ops”，则第一台主机name为“instance-0-ops”，第二台主机name为“instance-1-ops”。若未设置起始序号，则会默认追加从1开始的数字，例如批量创建两台云主机，且指定name是instance，则name默认是instance1，instance2
hostname String False 云主机hostname，若不指定hostname，则hostname默认使用云主机名称name，但是会以RFC 952和RFC 1123命名规范做一定转义。
Windows Server系统：长度为2-15个字符，允许大小写字母、数字或连字符（-）。不能以连字符（-）开头或结尾，不能连续使用连字符（-），也不能全部使用数字。不支持点号（.）。
Linux系统：长度为2-64个字符，允许支持多个点号，点之间为一段，每段允许使用大小写字母、数字或连字符（-），但不能连续使用点号（.）或连字符（-），不能以点号（.）或连字符（-）开头或结尾。
批量创建多台云主机时，可在hostname中非首位位置以[start_number]格式来设置有序hostname。start_number为起始序号，取值范围[0,9999]。例如：hostname设置为“instance-[000]-ops”，则第一台主机hostname为“instance-000-ops”，第二台主机hostname为“instance-001-ops”。再如：hostname设置为“instance-[0]-ops”，则第一台主机hostname为“instance-0-ops”，第二台主机hostname为“instance-1-ops”。若指定hostname但未设置起始序号，则会默认追加从1开始的数字，例如批量创建两台云主机，且指定hostname是test，则hostname默认是test1，test2。
password String False 密码，参考公共参数规范。
keyNames String[ ] False 密钥对名称，当前只支持传入一个。
elasticIp ElasticIpSpec False 主网卡主IP关联的弹性IP配置。
primaryNetworkInterface InstanceNetworkInterfaceAttachmentSpec False 主网卡配置信息。
systemDisk InstanceDiskAttachmentSpec False 系统盘配置信息。
dataDisks InstanceDiskAttachmentSpec[ ] False 数据盘配置信息，本地盘(local类型)做系统盘的云主机可挂载8块数据盘，云硬盘(cloud类型)做系统盘的云主机可挂载7块数据盘。
charge ChargeSpec False 计费配置
云主机不支持按用量方式计费，默认为按配置计费。
打包创建数据盘的情况下，数据盘的计费方式只能与云主机保持一致。
打包创建弹性公网IP的情况下，若公网IP的计费方式没有指定为按用量计费，那么公网IP计费方式只能与云主机保持一致。
userdata Userdata[ ] False 自定义脚本，目前只支持传入一个key为"launch-script"，表示首次启动脚本。value为base64格式，编码前数据不能大于16KB。
launch-script：linux系统支持bash和python，编码前须分别以 #!/bin/bash 和 #!/usr/bin/env python 作为内容首行;
launch-script：windows系统支持bat和powershell，编码前须分别以 和 作为内容首、尾行。
metadata Metadate[ ] False 用户自定义元数据信息，key-value键值对总数量不超过40对。不区分大小写。
注意：key不要以连字符(-)结尾，否则此key不生效。
description String False 主机描述，参考公共参数规范。
noPassword Boolean False 不使用模板中的密码。
仅当不使用Ag，并且使用了模板，并且password参数为空时，此参数(值为true)生效。
若使用模板创建虚机时，又指定了password参数时，此参数无效，以新指定的为准。
noKeyNames Boolean False 不使用模板中的密钥。
仅当不使用Ag，并且使用了模板，并且keynames参数为空时，此参数(值为true)生效。
若使用模板创建虚机时，又指定了keynames参数时，此参数无效，以新指定的为准。
noElasticIp Boolean False 不使用模板中的弹性公网IP。
仅当不使用Ag，并且使用了模板，并且elasticIp参数为空时，此参数(值为true)生效。
若使用模板创建虚机时，又指定了elasticIp参数时，此参数无效，以新指定的为准。
userTags Tag[ ] False 用户普通标签集合。
chargeOnStopped String False 关机模式，只支持云盘做系统盘的按配置计费云主机。keepCharging：关机后继续计费；stopCharging：关机后停止计费。
autoImagePolicyId String False 自动镜像策略ID。
passwordAuth String False 当存在密钥时，是否同时使用密码登录，"yes"为使用，"no"为禁用，默认为"yes"。
autoImagePolicyId String False 使用镜像中的原有的登录凭证不再额外指定，仅使用私有镜像和共享镜像时此参数有效。"yes"为使用，"no"为不使用，默认为"no"。

Tag

名称 类型 是否必需 默认值 描述
key String False Tag键
value String False Tag值

Userdata

名称 类型 是否必需 默认值 描述
key String False 键，当前仅支持launch-script
value String False 值，最大长度21848字符

Metadata

名称 类型 是否必需 默认值 描述
key String False 键，最大长度256，支持全字符
value String False 值，最大长度16k，支持全字符

ChargeSpec

名称 类型 是否必需 默认值 描述
chargeMode String False postpaid_by_duration 计费模式，取值为：prepaid_by_duration，postpaid_by_usage或postpaid_by_duration，prepaid_by_duration表示预付费，postpaid_by_usage表示按用量后付费，postpaid_by_duration表示按配置后付费，默认为postpaid_by_duration.请参阅具体产品线帮助文档确认该产品线支持的计费类型
chargeUnit String False 预付费计费单位，预付费必填，当chargeMode为prepaid_by_duration时有效，取值为：month、year，默认为month
chargeDuration Integer False 预付费计费时长，预付费必填，当chargeMode取值为prepaid_by_duration时有效。当chargeUnit为month时取值为：1~9，当chargeUnit为year时取值为：1、2、3
autoRenew Boolean False True=OPEN——开通自动续费；False=CLOSE—— 不开通自动续费，默认为CLOSE
buyScenario String False 产品线统一活动凭证JSON字符串，需要BASE64编码，目前要求编码前格式为 {"activity":{"activityType":必填字段, "activityIdentifier":必填字段}}

InstanceDiskAttachmentSpec

名称 类型 是否必需 默认值 描述
diskCategory String False 磁盘分类，取值为本地盘(local)或者云硬盘(cloud)。
系统盘支持本地盘(local)或者云硬盘(cloud)。系统盘选择local类型，必须使用localDisk类型的镜像；同理系统盘选择cloud类型，必须使用cloudDisk类型的镜像。
数据盘仅支持云硬盘(cloud)。
autoDelete Boolean False 是否随云主机一起删除，即删除主机时是否自动删除此磁盘，默认为true，本地盘(local)不能更改此值。
如果云主机中的数据盘(cloud)是包年包月计费方式，此参数不生效。
如果云主机中的数据盘(cloud)是共享型数据盘，此参数不生效。
cloudDiskSpec DiskSpec False 数据盘配置
deviceName String False 数据盘逻辑挂载点，取值范围：vda,vdb,vdc,vdd,vde,vdf,vdg,vdh,vdi,vmj,vdk,vdl,vdm
noDevice Boolean False 排除设备，使用此参数noDevice配合deviceName一起使用。
创建整机镜像：如deviceName:vdb、noDevice:true，则表示云主机中的数据盘vdb不参与创建镜像。
创建模板：如deviceName:vdb、noDevice:true，则表示镜像中的数据盘vdb不参与创建主机。
创建主机：如deviceName:vdb、noDevice:true，则表示镜像中的数据盘vdb，或者模板(使用模板创建主机)中的数据盘vdb不参与创建主机。

DiskSpec

名称 类型 是否必需 默认值 描述
az String True 云硬盘所属的可用区
name String True 云硬盘名称
description String False 云硬盘描述
diskType String True 云硬盘类型，取值为ssd、premium-hdd、ssd.gp1、ssd.io1、hdd.std1之一
diskSizeGB Integer True 云硬盘大小，单位为 GiB，ssd 类型取值范围[20,1000]GB，步长为10G，premium-hdd 类型取值范围[20,3000]GB，步长为10G, ssd.gp1, ssd.io1, hdd.std1 类型取值均是范围[20,16000]GB，步长为10G
iops Integer False 云硬盘IOPS的大小，当且仅当云盘类型是ssd.io1型的云盘有效，步长是10.
snapshotId String False 用于创建云硬盘的快照ID
charge ChargeSpec False 计费配置；如不指定，默认计费类型是后付费-按使用时常付费
multiAttachable Boolean False 云硬盘是否支持一盘多主机挂载，默认为false（不支持）
encrypt Boolean False 云硬盘是否加密，默认为false（不加密）

InstanceNetworkInterfaceAttachmentSpec

名称 类型 是否必需 默认值 描述
deviceIndex Integer False 网卡设备Index，主网卡只能是1
networkInterface NetworkInterfaceSpec False 网卡接口规范

NetworkInterfaceSpec

名称 类型 是否必需 默认值 描述
subnetId String True 子网ID
az String False 可用区，用户的默认可用区，该参数无效，不建议使用
networkInterfaceName String False 网卡名称，只允许输入中文、数字、大小写字母、英文下划线“_”及中划线“-”，不允许为空且不超过32字符。
primaryIpAddress String False 网卡主IP，如果不指定，会自动从子网中分配
secondaryIpAddresses String[ ] False SecondaryIp列表
secondaryIpCount Integer False 自动分配的SecondaryIp数量
securityGroups String[ ] False 要绑定的安全组ID列表，最多指定5个安全组
sanityCheck Integer False 源和目标IP地址校验，取值为0或者1,默认为1
description String False 描述,​ 允许输入UTF-8编码下的全部字符，不超过256字符

ElasticIpSpec

名称 类型 是否必需 默认值 描述
bandwidthMbps Integer True 弹性公网IP的限速（单位：Mbps），取值范围为[1-200]
provider String True IP线路信息。当IP类型为标准公网IP时，取值为bgp或no_bgp，cn-north-1：bgp；cn-south-1：bgp；cn-east-1：bgp；cn-east-2：bgp。当IP类型为边缘公网IP时，其值可通过调用describeEdgeIpProviders、获取不同边缘节点的边缘公网IP线路信息
chargeSpec ChargeSpec False 计费配置。边缘公网IP支持包年包月、按配置；标准公网IP支持包年包月、按配置、按流量

返回参数

名称 类型 描述
result Result
requestId String

Result

名称 类型 描述
instanceIds String[ ]

返回码

返回码 描述
200 OK
400 Invalid parameter
401 Authentication failed
404 Not found
429 Quota exceeded
500 Internal server error
503 Service unavailable
更新时间：2021-02-23 11:17:09