接口请求域名: cvm.tencentcloudapi.com 。
本接口 (RunInstances) 用于创建一个或多个指定配置的实例。
ID
列表和一个RequestId
,此时创建实例操作并未立即完成。在此期间实例的状态将会处于“PENDING”,实例创建结果可以通过调用 DescribeInstances 接口查询,如果实例状态(InstanceState)由“PENDING”变为“RUNNING”,则代表实例创建成功,“LAUNCH_FAILED”代表实例创建失败。默认接口请求频率限制:10次/秒。
注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:cvm.ap-shanghai-fsi.tencentcloudapi.com。
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:RunInstances。 |
Version | 是 | String | 公共参数,本接口取值:2017-03-12。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
InstanceChargeType | 否 | String | 实例计费类型。 默认值:POSTPAID_BY_HOUR。 |
InstanceChargePrepaid | 否 | InstanceChargePrepaid | 预付费模式,即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。若指定实例的付费模式为预付费则该参数必传。 |
Placement | 否 | Placement | 实例所在的位置。通过该参数可以指定实例所属可用区,所属项目,所属宿主机(在专用宿主机上创建子机时指定)等属性。 |
InstanceType | 否 | String | 实例机型。不同实例机型指定了不同的资源规格。 |
ImageId | 否 | String | 指定有效的镜像ID,格式形如img-xxx 。镜像类型分为四种:可通过以下方式获取可用的镜像ID: 公共镜像 、自定义镜像 、共享镜像 的镜像ID可通过登录控制台查询;服务镜像市场 的镜像ID可通过云市场查询。ImageId 字段。 |
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_3 ,server_4 。支持指定多个模式串{R:x} 。1、2...n ,其中n 表示购买实例的数量,例如server_ ,购买2台时,实例显示名称分别为server_1 ,server_2 。 |
LoginSettings | 否 | LoginSettings | 实例登录设置。通过该参数可以设置实例的登录方式密码、密钥或保持镜像的原始登录设置。默认情况下会随机生成密码,并以站内信方式知会到用户。 |
SecurityGroupIds.N | 否 | Array of String | 实例所属安全组。该参数可以通过调用 DescribeSecurityGroups 的返回值中的sgId字段来获取。若不指定该参数,则绑定默认安全组。 |
EnhancedService | 否 | EnhancedService | 增强服务。通过该参数可以指定是否开启云安全、云监控等服务。若不指定该参数,则默认公共镜像开启云监控、云安全服务;自定义镜像与镜像市场镜像默认不开启云监控,云安全服务,而使用镜像里保留的服务。 |
ClientToken | 否 | String | 用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。 |
HostName | 否 | String | 云服务器的主机名。 |
ActionTimer | 否 | ActionTimer | 定时任务。通过该参数可以为实例指定定时任务,目前仅支持定时销毁。 |
DisasterRecoverGroupIds.N | 否 | Array of String | 置放群组id,仅支持指定一个。 |
TagSpecification.N | 否 | Array of TagSpecification | 标签描述列表。通过指定该参数可以同时绑定标签到相应的云服务器、云硬盘实例。 |
InstanceMarketOptions | 否 | InstanceMarketOptionsRequest | 实例的市场相关选项,如竞价实例相关参数,若指定实例的付费模式为竞价付费则该参数必传。 |
UserData | 否 | String | 提供给实例使用的用户数据,需要以 base64 方式编码,支持的最大数据大小为 16KB。关于获取此参数的详细介绍,请参阅Windows和Linux启动时运行命令。 |
DryRun | 否 | Boolean | 是否只预检此次请求。 true:发送检查请求,不会创建实例。检查项包括是否填写了必需参数,请求格式,业务限制和云服务器库存。 如果检查不通过,则返回对应错误码; 如果检查通过,则返回RequestId. false(默认):发送正常请求,通过检查后直接创建实例 |
CamRoleName | 否 | String | CAM角色名称。可通过DescribeRoleList 接口返回值中的roleName 获取。 |
HpcClusterId | 否 | String | 高性能计算集群ID。若创建的实例为高性能计算实例,需指定实例放置的集群,否则不可指定。 |
参数名称 | 类型 | 描述 |
---|---|---|
InstanceIdSet | Array of String | 当通过本接口来创建实例时会返回该参数,表示一个或多个实例ID 。返回实例ID 列表并不代表实例创建成功,可根据 DescribeInstances 接口查询返回的InstancesSet中对应实例的ID 的状态来判断创建是否完成;如果实例状态由“准备中”变为“正在运行”,则为创建成功。 |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
只传必传的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"
}
}
实例所在位置为上海二区,付费模式为包年包月,购买一个月,到期自动续费,镜像ID为:img-pmqg1cw7,选择机型为:64C256G标准型(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"
}
}
实例所在位置为上海二区,付费模式为按小时后付费,镜像ID为:img-pmqg1cw7,选择机型为:64C256G标准型(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"
}
}
实例所在位置为上海二区,在专用宿主机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"
}
}
实例所在位置为上海二区,付费模式为按小时后付费,镜像ID为:img-dkwyg6sr,选择机型为:64C256G标准型(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"
}
}
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AccountQualificationRestrictions | 该请求账户未通过资格审计。 |
AuthFailure.CamRoleNameAuthenticateFailed | 角色名鉴权失败 |
FailedOperation.DisasterRecoverGroupNotFound | 未找到指定的容灾组 |
FailedOperation.InquiryPriceFailed | 询价失败 |
FailedOperation.SecurityGroupActionFailed | 安全组操作失败。 |
FailedOperation.SnapshotSizeLessThanDataSize | 不支持快照size小于云盘size。 |
FailedOperation.TagKeyReserved | 请求中指定的标签键为系统预留标签,禁止创建 |
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.ParameterConflict | 不支持同时指定密钥登陆和保持镜像登陆方式。 |
InvalidParameter.SnapshotNotFound | 指定的快照不存在。 |
InvalidParameterCombination | 表示参数组合不正确。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.BandwidthPackageIdNotFound | 请确认指定的带宽包是否存在。 |
InvalidParameterValue.CloudSsdDataDiskSizeTooSmall | SSD云硬盘为数据盘时,购买大小不得小于100GB |
InvalidParameterValue.CoreCountValue | 核心计数不合法。 |
InvalidParameterValue.Duplicate | 参数值重复。 |
InvalidParameterValue.IllegalHostName | HostName参数值不合法 |
InvalidParameterValue.InstanceTypeNotSupportHpcCluster | 实例类型不可加入高性能计算集群。 |
InvalidParameterValue.InstanceTypeRequiredHpcCluster | 高性能计算实例需指定对应的高性能计算集群。 |
InvalidParameterValue.InsufficientOffering | 竞价数量不足。 |
InvalidParameterValue.InsufficientPrice | 竞价失败。 |
InvalidParameterValue.InvalidImageState | 镜像状态不合规范 |
InvalidParameterValue.InvalidIpFormat | IP地址不符合规范 |
InvalidParameterValue.InvalidTimeFormat | 时间格式不合法。 |
InvalidParameterValue.InvalidUserDataFormat | UserData格式错误, 需要base64编码格式 |
InvalidParameterValue.KeyPairNotFound | 请确认密钥是否存在。 |
InvalidParameterValue.LaunchTemplateIdNotExisted | 实例启动模板ID不存在。 |
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.CvmsVifsPerSecGroupLimitExceeded | 安全组关联云主机弹性网卡配额超限。 |
LimitExceeded.DisasterRecoverGroup | 指定置放群组配额不足。 |
LimitExceeded.InstanceQuota | 当前配额不足够生产指定数量的实例 |
LimitExceeded.SingleUSGQuota | 安全组限额不足 |
LimitExceeded.SpotQuota | 竞价实例类型配额不足 |
LimitExceeded.UserSpotQuota | 竞价实例配额不足 |
LimitExceeded.VpcSubnetNum | 子网IP不足 |
MissingParameter | 缺少参数错误。 |
MissingParameter.DPDKInstanceTypeRequiredVPC | DPDK实例机型要求VPC网络 |
MissingParameter.MonitorService | 该实例类型必须开启云监控服务 |
ResourceInsufficient.AvailabilityZoneSoldOut | 该可用区已售罄 |
ResourceInsufficient.CloudDiskSoldOut | 指定的云盘规格已售罄 |
ResourceInsufficient.CloudDiskUnavailable | 云盘参数不符合规范 |
ResourceInsufficient.DisasterRecoverGroupCvmQuota | 实例个数超过容灾组的配额 |
ResourceInsufficient.SpecifiedInstanceType | 指定的实例类型库存不足。 |
ResourceNotFound.HpcCluster | 高性能计算集群不存在。 |
ResourceNotFound.NoDefaultCbs | 无可用的缺省类型的CBS资源。 |
ResourceNotFound.NoDefaultCbsWithReason | 无可用的缺省类型的CBS资源。 |
ResourceUnavailable.InstanceType | 该可用区不售卖此机型 |
ResourcesSoldOut.EipInsufficient | 公网IP已售罄。 |
ResourcesSoldOut.SpecifiedInstanceType | 指定的实例类型已售罄。 |
UnsupportedOperation.BandwidthPackageIdNotSupported | 指定的实例付费模式或者网络付费模式不支持共享带宽包 |
UnsupportedOperation.InstanceStateIsolating | 请求不支持正在隔离状态的实例。 |
UnsupportedOperation.InvalidDisk | 不支持指定的磁盘 |
UnsupportedOperation.KeyPairUnsupportedWindows | 密钥不支持Windows操作系统 |
UnsupportedOperation.NoInstanceTypeSupportSpot | 该实例类型不支持竞价计费 |
UnsupportedOperation.OnlyForPrepaidAccount | 该操作仅支持预付费账户 |
UnsupportedOperation.UnsupportedInternationalUser | 请求不支持国际版账号 |
VpcAddrNotInSubNet | 私有网络ip不在子网内。 |
VpcIpIsUsed | 私有网络ip已经被使用。 |
3月24日,腾讯发布2020年Q4及全年财报,其中金融科技及企业服务第四季收入385亿...
注册了 域名 不备案可以吗?可以的。 注册域名 并不是一定要备案的,只有搭 建网...
客户简介 趣医网(quyiyuan.com)创立于2014年,为京颐集团重要成员企业之一,是...
API风格说明 当前ECS服务对外开放两类风格的API: ECS服务自定义规范的API(以下...
排查思路 无法通过远程桌面连接裸金属服务器时,我们推荐您按照以下思路排查问题...
客户简介 全民直播是一家涵盖游戏、娱乐、户外等多领域泛娱乐的直播平台。2015年...
??提到慕尼黑,大家第一个想到总是啤酒节,其实慕尼黑的文化同样闻名世界。慕尼...
公司介绍 我们公司是全球法律服务整合平台,已有的4万多名律师遍布全国359个城市...
案例背景 高校健康打卡项目发起于北京大学软件与微电子学院,是该学院张齐勋老师...
云虚拟主机 可以干什么?云 虚拟主机 可以是搭 建网站 的重要产品,可用来存放网...