com.tencentcloudapi.cvm.v20170312.models

Class RunInstancesRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.cvm.v20170312.models.RunInstancesRequest

public class RunInstancesRequest
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
RunInstancesRequest()
RunInstancesRequest(RunInstancesRequest source) NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Summary

Modifier and Type	Method and Description
ActionTimer	getActionTimer() Get 定时任务。通过该参数可以为实例指定定时任务，目前仅支持定时销毁。
String	getCamRoleName() Get CAM角色名称。可通过[`DescribeRoleList`](https://cloud.tencent.com/document/product/598/13887)接口返回值中的`roleName`获取。
String[]	getChcIds() Get 指定CHC物理服务器来创建CHC云主机。
String	getClientToken() Get 用于保证请求幂等性的字符串。该字符串由客户生成，需保证不同请求之间唯一，最大值不超过64个ASCII字符。若不指定该参数，则无法保证请求的幂等性。
DataDisk[]	getDataDisks() Get 实例数据盘配置信息。若不指定该参数，则默认不购买数据盘。支持购买的时候指定21块数据盘，其中最多包含1块LOCAL_BASIC数据盘或者LOCAL_SSD数据盘，最多包含20块CLOUD_BASIC数据盘、CLOUD_PREMIUM数据盘或者CLOUD_SSD数据盘。
Boolean	getDisableApiTermination() Get 实例销毁保护标志，表示是否允许通过api接口删除实例。取值范围： TRUE：表示开启实例保护，不允许通过api接口删除实例 FALSE：表示关闭实例保护，允许通过api接口删除实例 默认取值：FALSE。
String[]	getDisasterRecoverGroupIds() Get 置放群组id，仅支持指定一个。
Boolean	getDryRun() Get 是否只预检此次请求。 true：发送检查请求，不会创建实例。检查项包括是否填写了必需参数，请求格式，业务限制和云服务器库存。 如果检查不通过，则返回对应错误码； 如果检查通过，则返回RequestId.
EnhancedService	getEnhancedService() Get 增强服务。通过该参数可以指定是否开启云安全、云监控等服务。若不指定该参数，则默认公共镜像开启云监控、云安全服务；自定义镜像与镜像市场镜像默认不开启云监控，云安全服务，而使用镜像里保留的服务。
String	getHostName() Get 实例主机名。 点号（.）和短横线（-）不能作为 HostName 的首尾字符，不能连续使用。 Windows 实例：名字符长度为[2, 15]，允许字母（不限制大小写）、数字和短横线（-）组成，不支持点号（.），不能全是数字。 其他类型（Linux 等）实例：字符长度为[2, 60]，允许支持多个点号，点之间为一段，每段允许字母（不限制大小写）、数字和短横线（-）组成。 购买多台实例，如果指定模式串`{R:x}`，表示生成数字`[x, x+n-1]`，其中`n`表示购买实例的数量，例如`server{R:3}`，购买1台时，实例主机名为`server3`；购买2台时，实例主机名分别为`server3`，`server4`。支持指定多个模式串`{R:x}`。 购买多台实例，如果不指定模式串，则在实例主机名添加后缀`1、2...n`，其中`n`表示购买实例的数量，例如`server`，购买2台时，实例主机名分别为`server1`，`server2`。
String	getHpcClusterId() Get 高性能计算集群ID。若创建的实例为高性能计算实例，需指定实例放置的集群，否则不可指定。
String	getImageId() Get 指定有效的[镜像](https://cloud.tencent.com/document/product/213/4940)ID，格式形如`img-xxx`。镜像类型分为四种： 公共镜像自定义镜像共享镜像服务市场镜像 可通过以下方式获取可用的镜像ID： `公共镜像`、`自定义镜像`、`共享镜像`的镜像ID可通过登录[控制台](https://console.cloud.tencent.com/cvm/image?rid=1&imageType=PUBLIC_IMAGE)查询；`服务镜像市场`的镜像ID可通过[云市场](https://market.cloud.tencent.com/list)查询。通过调用接口 [DescribeImages](https://cloud.tencent.com/document/api/213/15715) ，传入InstanceType获取当前机型支持的镜像列表，取返回信息中的`ImageId`字段。 注：如果您不指定LaunchTemplate参数，则ImageId为必选参数。若同时传递ImageId和LaunchTemplate，则默认覆盖LaunchTemplate中对应的ImageId的值。
InstanceChargePrepaid	getInstanceChargePrepaid() Get 预付费模式，即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。若指定实例的付费模式为预付费则该参数必传。
String	getInstanceChargeType() Get 实例[计费类型](https://cloud.tencent.com/document/product/213/2180)。 PREPAID：预付费，即包年包月 POSTPAID_BY_HOUR：按小时后付费 CDHPAID：独享子机（基于专用宿主机创建，宿主机部分的资源不收费） SPOTPAID：竞价付费 CDCPAID：专用集群付费 默认值：POSTPAID_BY_HOUR。
Long	getInstanceCount() Get 购买实例数量。包年包月实例取值范围：[1，300]，按量计费实例取值范围：[1，100]。默认取值：1。指定购买实例的数量不能超过用户所能购买的剩余配额数量，具体配额相关限制详见[CVM实例购买限制](https://cloud.tencent.com/document/product/213/2664)。
InstanceMarketOptionsRequest	getInstanceMarketOptions() Get 实例的市场相关选项，如竞价实例相关参数，若指定实例的付费模式为竞价付费但没有传递该参数时，默认按当前固定折扣价格出价。
String	getInstanceName() Get 实例显示名称。 不指定实例显示名称则默认显示‘未命名’。购买多台实例，如果指定模式串`{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`。最多支持60个字符（包含模式串）。
String	getInstanceType() Get 实例机型。不同实例机型指定了不同的资源规格。 对于付费模式为PREPAID或POSTPAID\_BY\_HOUR的实例创建，具体取值可通过调用接口[DescribeInstanceTypeConfigs](https://cloud.tencent.com/document/api/213/15749)来获得最新的规格表或参见[实例规格](https://cloud.tencent.com/document/product/213/11518)描述。若不指定该参数，则系统将根据当前地域的资源售卖情况动态指定默认机型。 对于付费模式为CDHPAID的实例创建，该参数以"CDH_"为前缀，根据CPU和内存配置生成，具体形式为：CDH_XCXG，例如对于创建CPU为1核，内存为1G大小的专用宿主机的实例，该参数应该为CDH_1C1G。
InternetAccessible	getInternetAccessible() Get 公网带宽相关信息设置。若不指定该参数，则默认公网带宽为0Mbps。
LaunchTemplate	getLaunchTemplate() Get 实例启动模板。
LoginSettings	getLoginSettings() Get 实例登录设置。通过该参数可以设置实例的登录方式密码、密钥或保持镜像的原始登录设置。默认情况下会随机生成密码，并以站内信方式知会到用户。
Placement	getPlacement() Get 实例所在的位置。通过该参数可以指定实例所属可用区，所属项目，所属宿主机（在专用宿主机上创建子机时指定）等属性。 注：如果您不指定LaunchTemplate参数，则Placement为必选参数。若同时传递Placement和LaunchTemplate，则默认覆盖LaunchTemplate中对应的Placement的值。
String[]	getSecurityGroupIds() Get 实例所属安全组。该参数可以通过调用 [DescribeSecurityGroups](https://cloud.tencent.com/document/api/215/15808) 的返回值中的sgId字段来获取。若不指定该参数，则绑定默认安全组。
SystemDisk	getSystemDisk() Get 实例系统盘配置信息。若不指定该参数，则按照系统默认值进行分配。
TagSpecification[]	getTagSpecification() Get 标签描述列表。通过指定该参数可以同时绑定标签到相应的云服务器、云硬盘实例。
String	getUserData() Get 提供给实例使用的用户数据，需要以 base64 方式编码，支持的最大数据大小为 16KB。关于获取此参数的详细介绍，请参阅[Windows](https://cloud.tencent.com/document/product/213/17526)和[Linux](https://cloud.tencent.com/document/product/213/17525)启动时运行命令。
VirtualPrivateCloud	getVirtualPrivateCloud() Get 私有网络相关信息配置。通过该参数可以指定私有网络的ID，子网ID等信息。若不指定该参数，则默认使用基础网络。若在此参数中指定了私有网络IP，即表示每个实例的主网卡IP；同时，InstanceCount参数必须与私有网络IP的个数一致且不能大于20。
void	setActionTimer(ActionTimer ActionTimer) Set 定时任务。通过该参数可以为实例指定定时任务，目前仅支持定时销毁。
void	setCamRoleName(String CamRoleName) Set CAM角色名称。可通过[`DescribeRoleList`](https://cloud.tencent.com/document/product/598/13887)接口返回值中的`roleName`获取。
void	setChcIds(String[] ChcIds) Set 指定CHC物理服务器来创建CHC云主机。
void	setClientToken(String ClientToken) Set 用于保证请求幂等性的字符串。该字符串由客户生成，需保证不同请求之间唯一，最大值不超过64个ASCII字符。若不指定该参数，则无法保证请求的幂等性。
void	setDataDisks(DataDisk[] DataDisks) Set 实例数据盘配置信息。若不指定该参数，则默认不购买数据盘。支持购买的时候指定21块数据盘，其中最多包含1块LOCAL_BASIC数据盘或者LOCAL_SSD数据盘，最多包含20块CLOUD_BASIC数据盘、CLOUD_PREMIUM数据盘或者CLOUD_SSD数据盘。
void	setDisableApiTermination(Boolean DisableApiTermination) Set 实例销毁保护标志，表示是否允许通过api接口删除实例。取值范围： TRUE：表示开启实例保护，不允许通过api接口删除实例 FALSE：表示关闭实例保护，允许通过api接口删除实例 默认取值：FALSE。
void	setDisasterRecoverGroupIds(String[] DisasterRecoverGroupIds) Set 置放群组id，仅支持指定一个。
void	setDryRun(Boolean DryRun) Set 是否只预检此次请求。 true：发送检查请求，不会创建实例。检查项包括是否填写了必需参数，请求格式，业务限制和云服务器库存。 如果检查不通过，则返回对应错误码； 如果检查通过，则返回RequestId.
void	setEnhancedService(EnhancedService EnhancedService) Set 增强服务。通过该参数可以指定是否开启云安全、云监控等服务。若不指定该参数，则默认公共镜像开启云监控、云安全服务；自定义镜像与镜像市场镜像默认不开启云监控，云安全服务，而使用镜像里保留的服务。
void	setHostName(String HostName) Set 实例主机名。 点号（.）和短横线（-）不能作为 HostName 的首尾字符，不能连续使用。 Windows 实例：名字符长度为[2, 15]，允许字母（不限制大小写）、数字和短横线（-）组成，不支持点号（.），不能全是数字。 其他类型（Linux 等）实例：字符长度为[2, 60]，允许支持多个点号，点之间为一段，每段允许字母（不限制大小写）、数字和短横线（-）组成。 购买多台实例，如果指定模式串`{R:x}`，表示生成数字`[x, x+n-1]`，其中`n`表示购买实例的数量，例如`server{R:3}`，购买1台时，实例主机名为`server3`；购买2台时，实例主机名分别为`server3`，`server4`。支持指定多个模式串`{R:x}`。 购买多台实例，如果不指定模式串，则在实例主机名添加后缀`1、2...n`，其中`n`表示购买实例的数量，例如`server`，购买2台时，实例主机名分别为`server1`，`server2`。
void	setHpcClusterId(String HpcClusterId) Set 高性能计算集群ID。若创建的实例为高性能计算实例，需指定实例放置的集群，否则不可指定。
void	setImageId(String ImageId) Set 指定有效的[镜像](https://cloud.tencent.com/document/product/213/4940)ID，格式形如`img-xxx`。镜像类型分为四种： 公共镜像自定义镜像共享镜像服务市场镜像 可通过以下方式获取可用的镜像ID： `公共镜像`、`自定义镜像`、`共享镜像`的镜像ID可通过登录[控制台](https://console.cloud.tencent.com/cvm/image?rid=1&imageType=PUBLIC_IMAGE)查询；`服务镜像市场`的镜像ID可通过[云市场](https://market.cloud.tencent.com/list)查询。通过调用接口 [DescribeImages](https://cloud.tencent.com/document/api/213/15715) ，传入InstanceType获取当前机型支持的镜像列表，取返回信息中的`ImageId`字段。 注：如果您不指定LaunchTemplate参数，则ImageId为必选参数。若同时传递ImageId和LaunchTemplate，则默认覆盖LaunchTemplate中对应的ImageId的值。
void	setInstanceChargePrepaid(InstanceChargePrepaid InstanceChargePrepaid) Set 预付费模式，即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。若指定实例的付费模式为预付费则该参数必传。
void	setInstanceChargeType(String InstanceChargeType) Set 实例[计费类型](https://cloud.tencent.com/document/product/213/2180)。 PREPAID：预付费，即包年包月 POSTPAID_BY_HOUR：按小时后付费 CDHPAID：独享子机（基于专用宿主机创建，宿主机部分的资源不收费） SPOTPAID：竞价付费 CDCPAID：专用集群付费 默认值：POSTPAID_BY_HOUR。
void	setInstanceCount(Long InstanceCount) Set 购买实例数量。包年包月实例取值范围：[1，300]，按量计费实例取值范围：[1，100]。默认取值：1。指定购买实例的数量不能超过用户所能购买的剩余配额数量，具体配额相关限制详见[CVM实例购买限制](https://cloud.tencent.com/document/product/213/2664)。
void	setInstanceMarketOptions(InstanceMarketOptionsRequest InstanceMarketOptions) Set 实例的市场相关选项，如竞价实例相关参数，若指定实例的付费模式为竞价付费但没有传递该参数时，默认按当前固定折扣价格出价。
void	setInstanceName(String InstanceName) Set 实例显示名称。 不指定实例显示名称则默认显示‘未命名’。购买多台实例，如果指定模式串`{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`。最多支持60个字符（包含模式串）。
void	setInstanceType(String InstanceType) Set 实例机型。不同实例机型指定了不同的资源规格。 对于付费模式为PREPAID或POSTPAID\_BY\_HOUR的实例创建，具体取值可通过调用接口[DescribeInstanceTypeConfigs](https://cloud.tencent.com/document/api/213/15749)来获得最新的规格表或参见[实例规格](https://cloud.tencent.com/document/product/213/11518)描述。若不指定该参数，则系统将根据当前地域的资源售卖情况动态指定默认机型。 对于付费模式为CDHPAID的实例创建，该参数以"CDH_"为前缀，根据CPU和内存配置生成，具体形式为：CDH_XCXG，例如对于创建CPU为1核，内存为1G大小的专用宿主机的实例，该参数应该为CDH_1C1G。
void	setInternetAccessible(InternetAccessible InternetAccessible) Set 公网带宽相关信息设置。若不指定该参数，则默认公网带宽为0Mbps。
void	setLaunchTemplate(LaunchTemplate LaunchTemplate) Set 实例启动模板。
void	setLoginSettings(LoginSettings LoginSettings) Set 实例登录设置。通过该参数可以设置实例的登录方式密码、密钥或保持镜像的原始登录设置。默认情况下会随机生成密码，并以站内信方式知会到用户。
void	setPlacement(Placement Placement) Set 实例所在的位置。通过该参数可以指定实例所属可用区，所属项目，所属宿主机（在专用宿主机上创建子机时指定）等属性。 注：如果您不指定LaunchTemplate参数，则Placement为必选参数。若同时传递Placement和LaunchTemplate，则默认覆盖LaunchTemplate中对应的Placement的值。
void	setSecurityGroupIds(String[] SecurityGroupIds) Set 实例所属安全组。该参数可以通过调用 [DescribeSecurityGroups](https://cloud.tencent.com/document/api/215/15808) 的返回值中的sgId字段来获取。若不指定该参数，则绑定默认安全组。
void	setSystemDisk(SystemDisk SystemDisk) Set 实例系统盘配置信息。若不指定该参数，则按照系统默认值进行分配。
void	setTagSpecification(TagSpecification[] TagSpecification) Set 标签描述列表。通过指定该参数可以同时绑定标签到相应的云服务器、云硬盘实例。
void	setUserData(String UserData) Set 提供给实例使用的用户数据，需要以 base64 方式编码，支持的最大数据大小为 16KB。关于获取此参数的详细介绍，请参阅[Windows](https://cloud.tencent.com/document/product/213/17526)和[Linux](https://cloud.tencent.com/document/product/213/17525)启动时运行命令。
void	setVirtualPrivateCloud(VirtualPrivateCloud VirtualPrivateCloud) Set 私有网络相关信息配置。通过该参数可以指定私有网络的ID，子网ID等信息。若不指定该参数，则默认使用基础网络。若在此参数中指定了私有网络IP，即表示每个实例的主网卡IP；同时，InstanceCount参数必须与私有网络IP的个数一致且不能大于20。
void	toMap(HashMap<String,String> map, String prefix) Internal implementation, normal users should not use it.

Methods inherited from class com.tencentcloudapi.common.AbstractModel

any, fromJsonString, getBinaryParams, getMultipartRequestParams, set, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, toJsonString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RunInstancesRequest

public RunInstancesRequest()

RunInstancesRequest

public RunInstancesRequest(RunInstancesRequest source)

NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Detail

getInstanceChargeType

public String getInstanceChargeType()

Get 实例[计费类型](https://cloud.tencent.com/document/product/213/2180)。

PREPAID：预付费，即包年包月
POSTPAID_BY_HOUR：按小时后付费
CDHPAID：独享子机（基于专用宿主机创建，宿主机部分的资源不收费）
SPOTPAID：竞价付费
CDCPAID：专用集群付费
默认值：POSTPAID_BY_HOUR。

Returns:

InstanceChargeType 实例[计费类型](https://cloud.tencent.com/document/product/213/2180)。

PREPAID：预付费，即包年包月

POSTPAID_BY_HOUR：按小时后付费

CDHPAID：独享子机（基于专用宿主机创建，宿主机部分的资源不收费）

SPOTPAID：竞价付费

CDCPAID：专用集群付费
默认值：POSTPAID_BY_HOUR。

setInstanceChargeType

public void setInstanceChargeType(String InstanceChargeType)

Set 实例[计费类型](https://cloud.tencent.com/document/product/213/2180)。

PREPAID：预付费，即包年包月
POSTPAID_BY_HOUR：按小时后付费
CDHPAID：独享子机（基于专用宿主机创建，宿主机部分的资源不收费）
SPOTPAID：竞价付费
CDCPAID：专用集群付费
默认值：POSTPAID_BY_HOUR。