创建实例

最近更新时间:2020-09-22 08:03:23

1. 接口描述

接口请求域名: cvm.tencentcloudapi.com 。

本接口 (RunInstances) 用于创建一个或多个指定配置的实例。

  • 实例创建成功后将自动开机启动,实例状态变为“运行中”。
  • 预付费实例的购买会预先扣除本次实例购买所需金额,按小时后付费实例购买会预先冻结本次实例购买一小时内所需金额,在调用本接口前请确保账户余额充足。
  • 本接口允许购买的实例数量遵循CVM实例购买限制,所创建的实例和官网入口创建的实例共用配额。
  • 本接口为异步接口,当创建实例请求下发成功后会返回一个实例ID列表和一个RequestId,此时创建实例操作并未立即完成。在此期间实例的状态将会处于“PENDING”,实例创建结果可以通过调用 DescribeInstances 接口查询,如果实例状态(InstanceState)由“PENDING”变为“RUNNING”,则代表实例创建成功,“LAUNCH_FAILED”代表实例创建失败。

默认接口请求频率限制:10次/秒。

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:cvm.ap-shanghai-fsi.tencentcloudapi.com。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:RunInstances。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
Placement Placement 实例所在的位置。通过该参数可以指定实例所属可用区,所属项目,所属宿主机(在专用宿主机上创建子机时指定)等属性。
ImageId String 指定有效的镜像ID,格式形如img-xxx。镜像类型分为四种:
  • 公共镜像
  • 自定义镜像
  • 共享镜像
  • 服务市场镜像

  • 可通过以下方式获取可用的镜像ID:
  • 公共镜像自定义镜像共享镜像的镜像ID可通过登录控制台查询;服务镜像市场的镜像ID可通过云市场查询。
  • 通过调用接口 DescribeImages ,传入InstanceType获取当前机型支持的镜像列表,取返回信息中的ImageId字段。
  • InstanceChargeType String 实例计费类型
  • PREPAID:预付费,即包年包月
  • POSTPAID_BY_HOUR:按小时后付费
  • CDHPAID:独享子机(基于专用宿主机创建,宿主机部分的资源不收费)
  • SPOTPAID:竞价付费
    默认值:POSTPAID_BY_HOUR。
  • InstanceChargePrepaid InstanceChargePrepaid 预付费模式,即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。若指定实例的付费模式为预付费则该参数必传。
    InstanceType String 实例机型。不同实例机型指定了不同的资源规格。

  • 对于付费模式为PREPAID或POSTPAID_BY_HOUR的实例创建,具体取值可通过调用接口DescribeInstanceTypeConfigs来获得最新的规格表或参见实例规格描述。若不指定该参数,则系统将根据当前地域的资源售卖情况动态指定默认机型。
  • 对于付费模式为CDHPAID的实例创建,该参数以"CDH_"为前缀,根据CPU和内存配置生成,具体形式为:CDH_XCXG,例如对于创建CPU为1核,内存为1G大小的专用宿主机的实例,该参数应该为CDH_1C1G。
  • SystemDisk SystemDisk 实例系统盘配置信息。若不指定该参数,则按照系统默认值进行分配。
    DataDisks.N Array of DataDisk 实例数据盘配置信息。若不指定该参数,则默认不购买数据盘。支持购买的时候指定21块数据盘,其中最多包含1块LOCAL_BASIC数据盘或者LOCAL_SSD数据盘,最多包含20块CLOUD_BASIC数据盘、CLOUD_PREMIUM数据盘或者CLOUD_SSD数据盘。
    VirtualPrivateCloud VirtualPrivateCloud 私有网络相关信息配置。通过该参数可以指定私有网络的ID,子网ID等信息。若不指定该参数,则默认使用基础网络。若在此参数中指定了私有网络IP,即表示每个实例的主网卡IP;同时,InstanceCount参数必须与私有网络IP的个数一致且不能大于20。
    InternetAccessible InternetAccessible 公网带宽相关信息设置。若不指定该参数,则默认公网带宽为0Mbps。
    InstanceCount Integer 购买实例数量。包年包月实例取值范围:[1,300],按量计费实例取值范围:[1,100]。默认取值:1。指定购买实例的数量不能超过用户所能购买的剩余配额数量,具体配额相关限制详见CVM实例购买限制
    InstanceName String 实例显示名称。
  • 不指定实例显示名称则默认显示‘未命名’。
  • 购买多台实例,如果指定模式串{R:x},表示生成数字[x, x+n-1],其中n表示购买实例的数量,例如server_{R:3},购买1台时,实例显示名称为server_3;购买2台时,实例显示名称分别为server_3server_4。支持指定多个模式串{R:x}
  • 购买多台实例,如果不指定模式串,则在实例显示名称添加后缀1、2...n,其中n表示购买实例的数量,例如server_,购买2台时,实例显示名称分别为server_1server_2
  • 最多支持60个字符(包含模式串)。
  • LoginSettings LoginSettings 实例登录设置。通过该参数可以设置实例的登录方式密码、密钥或保持镜像的原始登录设置。默认情况下会随机生成密码,并以站内信方式知会到用户。
    SecurityGroupIds.N Array of String 实例所属安全组。该参数可以通过调用 DescribeSecurityGroups 的返回值中的sgId字段来获取。若不指定该参数,则绑定默认安全组。
    EnhancedService EnhancedService 增强服务。通过该参数可以指定是否开启云安全、云监控等服务。若不指定该参数,则默认公共镜像开启云监控、云安全服务;自定义镜像与镜像市场镜像默认不开启云监控,云安全服务,而使用镜像里保留的服务。
    ClientToken String 用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。
    HostName String 云服务器的主机名。
  • 点号(.)和短横线(-)不能作为 HostName 的首尾字符,不能连续使用。
  • Windows 实例:名字符长度为[2, 15],允许字母(不限制大小写)、数字和短横线(-)组成,不支持点号(.),不能全是数字。
  • 其他类型(Linux 等)实例:字符长度为[2, 60],允许支持多个点号,点之间为一段,每段允许字母(不限制大小写)、数字和短横线(-)组成。
  • ActionTimer ActionTimer 定时任务。通过该参数可以为实例指定定时任务,目前仅支持定时销毁。
    DisasterRecoverGroupIds.N Array of String 置放群组id,仅支持指定一个。
    TagSpecification.N Array of TagSpecification 标签描述列表。通过指定该参数可以同时绑定标签到相应的资源实例,当前仅支持绑定标签到云服务器实例。
    InstanceMarketOptions InstanceMarketOptionsRequest 实例的市场相关选项,如竞价实例相关参数,若指定实例的付费模式为竞价付费则该参数必传。
    UserData String 提供给实例使用的用户数据,需要以 base64 方式编码,支持的最大数据大小为 16KB。关于获取此参数的详细介绍,请参阅WindowsLinux启动时运行命令。
    DryRun Boolean 是否只预检此次请求。
    true:发送检查请求,不会创建实例。检查项包括是否填写了必需参数,请求格式,业务限制和云服务器库存。
    如果检查不通过,则返回对应错误码;
    如果检查通过,则返回RequestId.
    false(默认):发送正常请求,通过检查后直接创建实例
    CamRoleName String CAM角色名称。可通过DescribeRoleList接口返回值中的roleName获取。
    HpcClusterId String 高性能计算集群ID。若创建的实例为高性能计算实例,需指定实例放置的集群,否则不可指定。

    3. 输出参数

    参数名称 类型 描述
    InstanceIdSet Array of String 当通过本接口来创建实例时会返回该参数,表示一个或多个实例ID。返回实例ID列表并不代表实例创建成功,可根据 DescribeInstances 接口查询返回的InstancesSet中对应实例的ID的状态来判断创建是否完成;如果实例状态由“准备中”变为“正在运行”,则为创建成功。
    RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 最简单参数的购买

    只传必传的Zone和镜像ID,其他均采用系统默认值,具体配置如下:实例所在位置为上海二区,镜像ID为:img-pmqg1cw7。

    输入示例

    GET https://cvm.tencentcloudapi.com/?Action=RunInstances
    &Placement.Zone=ap-shanghai-2
    &ImageId=img-pmqg1cw7
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "InstanceIdSet": [
          "ins-1vogaxgk"
        ],
        "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
      }
    }

    示例2 包年包月实例购买

    实例所在位置为上海二区,付费模式为包年包月,购买一个月,到期自动续费,镜像ID为:img-pmqg1cw7,选择机型为:64C128G标准型(S5.16XLARGE256),50G大小高性能云系统盘,挂载100G大小高性能云数据盘,私有网络,公网付费模式为流量按小时后付费,外网带宽上限10Mbps,分配公网IP,实例命名为QCLOUD-TEST,设置登录密码未Qcloud@TestApi123++,安装云监控云安全,购买数量为1台。

    输入示例

    GET https://cvm.tencentcloudapi.com/?Action=RunInstances
    &Placement.Zone=ap-shanghai-2
    &InstanceChargeType=PREPAID
    &InstanceChargePrepaid.Period=1
    &InstanceChargePrepaid.RenewFlag=NOTIFY_AND_AUTO_RENEW
    &ImageId=img-pmqg1cw7
    &InstanceType=S5.16XLARGE256
    &SystemDisk.DiskType=CLOUD_PREMIUM
    &SystemDisk.DiskSize=50
    &DataDisks.0.DiskType=CLOUD_PREMIUM
    &DataDisks.0.DiskSize=100
    &InternetAccessible.InternetChargeType=TRAFFIC_POSTPAID_BY_HOUR
    &InternetAccessible.InternetMaxBandwidthOut=10
    &InternetAccessible.PublicIpAssigned=TRUE
    &InstanceName=QCLOUD-TEST
    &LoginSettings.Password=Qcloud@TestApi123++
    &EnhancedService.SecurityService.Enabled=TRUE
    &EnhancedService.MonitorService.Enabled=TRUE
    &InstanceCount=1
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "InstanceIdSet": [
          "ins-bfw5zq3y"
        ],
        "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
      }
    }

    示例3 按小时后付费实例购买

    实例所在位置为上海二区,付费模式为按小时后付费,镜像ID为:img-pmqg1cw7,选择机型为:64C128G标准型(S5.16XLARGE256),50G大小高性能云系统盘,挂载100G大小高性能云数据盘,私有网络,公网付费模式为流量按小时后付费,外网带宽上限10Mbps,分配公网IP,实例命名为QCLOUD-TEST,设置登录密码为Qcloud@TestApi123++,安装云监控云安全,购买数量为1台。

    输入示例

    GET https://cvm.tencentcloudapi.com/?Action=RunInstances
    &Placement.Zone=ap-shanghai-2
    &InstanceChargeType=POSTPAID_BY_HOUR
    &ImageId=img-pmqg1cw7
    &InstanceType=S5.16XLARGE256
    &SystemDisk.DiskType=CLOUD_PREMIUM
    &SystemDisk.DiskSize=50
    &DataDisks.0.DiskType=CLOUD_PREMIUM
    &DataDisks.0.DiskSize=100
    &InternetAccessible.InternetChargeType=TRAFFIC_POSTPAID_BY_HOUR
    &InternetAccessible.InternetMaxBandwidthOut=10
    &InternetAccessible.PublicIpAssigned=TRUE
    &InstanceName=QCLOUD-TEST
    &LoginSettings.Password=Qcloud@TestApi123++
    &EnhancedService.SecurityService.Enabled=TRUE
    &EnhancedService.MonitorService.Enabled=TRUE
    &InstanceCount=1
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "InstanceIdSet": [
          "ins-32kcaqoa"
        ],
        "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
      }
    }

    示例4 独享子机购买

    实例所在位置为上海二区,在专用宿主机host-q88gab4i上创建,付费模式为独享子机付费,镜像ID为:img-pmqg1cw7,实例配置为:1C1G,50G大小高性能云系统盘,挂载100G大小高性能云数据盘,私有网络,公网付费模式为流量按小时后付费,外网带宽上限10Mbps,分配公网IP,实例命名为QCLOUD-TEST,设置登录密码为Qcloud@TestApi123++,安装云监控云安全,购买数量为1台。

    输入示例

    GET https://cvm.tencentcloudapi.com/?Action=RunInstances
    &Placement.Zone=ap-shanghai-2
    &Placement.HostIds.0=host-q88gab4i
    &InstanceChargeType=CDHPAID
    &ImageId=img-pmqg1cw7
    &InstanceType=CDH_1C1G
    &SystemDisk.DiskType=CLOUD_PREMIUM
    &SystemDisk.DiskSize=50
    &DataDisks.0.DiskType=CLOUD_PREMIUM
    &DataDisks.0.DiskSize=100
    &InternetAccessible.InternetChargeType=TRAFFIC_POSTPAID_BY_HOUR
    &InternetAccessible.InternetMaxBandwidthOut=10
    &InternetAccessible.PublicIpAssigned=TRUE
    &InstanceName=QCLOUD-TEST
    &LoginSettings.Password=Qcloud@TestApi123++
    &EnhancedService.SecurityService.Enabled=TRUE
    &EnhancedService.MonitorService.Enabled=TRUE
    &InstanceCount=1
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "InstanceIdSet": [
          "ins-0s7wsh5x"
        ],
        "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
      }
    }

    示例5 指定私有网络ip创建实例

    实例所在位置为上海二区,付费模式为按小时后付费,镜像ID为:img-dkwyg6sr,选择机型为:64C128G标准型(S5.16XLARGE256),50G大小高性能云系统盘,私有网络,vpcId为1urkhbj4,子网ID为dcs9x3gz,指定私有网络ip为10.0.0.18,10.0.0.19,购买数量为2台。

    输入示例

    GET https://cvm.tencentcloudapi.com/?Action=RunInstances
    &InstanceType=S5.16XLARGE256
    &SystemDisk.DiskType=CLOUD_PREMIUM
    &SystemDisk.DiskSize=50
    &Placement.Zone=ap-shanghai-2
    &ImageId=img-dkwyg6sr
    &VirtualPrivateCloud.SubnetId=subnet-dcs9x3gz
    &VirtualPrivateCloud.VpcId=vpc-1urkhbj4
    &VirtualPrivateCloud.PrivateIpAddresses.0=10.0.0.18
    &VirtualPrivateCloud.PrivateIpAddresses.1=10.0.0.19
    &InstanceCount=2
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "InstanceIdSet": [
          "ins-0s7wsh5x",
          "ins-03lw8hok"
        ],
        "RequestId": "3c14def19-cfes-470e-b241-90787u6jf5uj"
      }
    }

    5. 开发者资源

    API Explorer

    该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

    SDK

    云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

    命令行工具

    6. 错误码

    以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

    错误码 描述
    AccountQualificationRestrictions 该请求账户未通过资格审计。
    InstancesQuotaLimitExceeded 表示当前创建的实例个数超过了该账户允许购买的剩余配额数。
    InternalError.TradeUnknownError 内部错误
    InvalidAccount.InsufficientBalance 账户余额不足。
    InvalidClientToken.TooLong 指定的ClientToken字符串长度超出限制,必须小于等于64字节。
    InvalidHostId.Malformed 无效CDH ID。指定的CDH ID格式错误。例如ID长度错误host-1122
    InvalidHostId.NotFound 指定的HostId不存在,或不属于该请求账号所有。
    InvalidImageId.Malformed 错误的镜像Id格式。
    InvalidImageId.NotFound 未找到该镜像。
    InvalidInstanceName.TooLong 指定的InstanceName字符串长度超出限制,必须小于等于60字节。
    InvalidInstanceType.Malformed 指定InstanceType参数格式不合法。
    InvalidParameter.InstanceImageNotSupport 当前接口不支持实例镜像。
    InvalidParameter.InvalidIpFormat 指定的私有网络ip格式不正确。
    InvalidParameter.LackCoreCountOrThreadPerCore CoreCount和ThreadPerCore必须同时提供。
    InvalidParameter.SnapshotNotFound 指定的快照不存在。
    InvalidParameterCombination 表示参数组合不正确。
    InvalidParameterValue 参数取值错误。
    InvalidParameterValue.CloudSsdDataDiskSizeTooSmall SSD云硬盘为数据盘时,购买大小不得小于100GB
    InvalidParameterValue.CoreCountValue 核心计数不合法。
    InvalidParameterValue.IllegalHostName HostName参数值不合法
    InvalidParameterValue.InstanceTypeNotSupportHpcCluster 实例类型不可加入高性能计算集群。
    InvalidParameterValue.InstanceTypeRequiredHpcCluster 高性能计算实例需指定对应的高性能计算集群。
    InvalidParameterValue.InsufficientOffering 竞价数量不足。
    InvalidParameterValue.InsufficientPrice 竞价失败。
    InvalidParameterValue.InvalidImageState 镜像状态不合规范
    InvalidParameterValue.InvalidUserDataFormat UserData格式错误, 需要base64编码格式
    InvalidParameterValue.LimitExceeded 参数值数量超过限制。
    InvalidParameterValue.MustDhcpEnabledVpc 参数值必须为开启DHCP的VPC
    InvalidParameterValue.Range 无效参数值。参数值取值范围不合法。
    InvalidParameterValue.SnapshotIdMalformed 快照ID不合要求,请提供规范的快照ID,类似snap-xxxxxxxx,字母x代表小写字符或者数字
    InvalidParameterValue.SubnetNotExist 创建失败,您指定的子网不存在,请您重新指定
    InvalidParameterValue.ThreadPerCoreValue 每核心线程数不合法。
    InvalidParameterValue.VpcIdZoneIdNotMatch VPC网络与实例不在同一可用区
    InvalidParameterValue.ZoneNotSupported 请求不支持该可用区
    InvalidPassword 无效密码。指定的密码不符合密码复杂度限制。例如密码长度不符合限制等。
    InvalidPeriod 无效时长。目前只支持时长:[1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36],单位:月。
    InvalidPermission 账户不支持该操作。
    InvalidProjectId.NotFound 无效的项目ID,指定的项目ID不存在。
    InvalidSecurityGroupId.NotFound 指定的安全组ID不存在。
    InvalidZone.MismatchRegion 指定的zone不存在。
    LimitExceeded.InstanceQuota 当前配额不足够生产指定数量的实例
    LimitExceeded.SpotQuota 竞价实例类型配额不足
    LimitExceeded.UserSpotQuota 竞价实例配额不足
    LimitExceeded.VpcSubnetNum 子网IP不足
    MissingParameter 缺少参数错误。
    MissingParameter.DPDKInstanceTypeRequiredVPC DPDK实例机型要求VPC网络
    ResourceInsufficient.CloudDiskSoldOut 指定的云盘规格已售罄
    ResourceInsufficient.CloudDiskUnavailable 云盘参数不符合规范
    ResourceInsufficient.SpecifiedInstanceType 指定的实例类型库存不足。
    ResourceNotFound.HpcCluster 高性能计算集群不存在。
    ResourceNotFound.NoDefaultCbs 无可用的缺省类型的CBS资源。
    ResourceNotFound.NoDefaultCbsWithReason 无可用的缺省类型的CBS资源。
    ResourceUnavailable.InstanceType 该可用区不售卖此机型
    ResourcesSoldOut.EipInsufficient 公网IP已售罄。
    ResourcesSoldOut.SpecifiedInstanceType 指定的实例类型已售罄。
    UnsupportedOperation.BandwidthPackageIdNotSupported 指定的实例付费模式或者网络付费模式不支持共享带宽包
    UnsupportedOperation.InvalidDisk 不支持指定的磁盘
    UnsupportedOperation.KeyPairUnsupportedWindows 密钥不支持Windows操作系统
    UnsupportedOperation.NoInstanceTypeSupportSpot 该实例类型不支持竞价计费
    VpcAddrNotInSubNet 私有网络ip不在子网内。
    VpcIpIsUsed 私有网络ip已经被使用。
    目录