public class RunInstancesRequest extends AbstractModel
| 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.
|
| Modifier and Type | Method and Description |
|---|---|
ActionTimer |
getActionTimer()
Get Scheduled tasks.
|
String |
getCamRoleName()
Get CAM role name, which can be obtained from the `roleName` field in the response of the [`DescribeRoleList`](https://intl.cloud.tencent.com/document/product/598/13887?from_cn_redirect=1) API.
|
String |
getClientToken()
Get A string used to ensure the idempotency of the request, which is generated by the user and must be unique to each request.
|
DataDisk[] |
getDataDisks()
Get The configuration information of instance data disks.
|
String[] |
getDisasterRecoverGroupIds()
Get Placement group ID.
|
Boolean |
getDryRun()
Get Whether the request is a dry run only.
|
EnhancedService |
getEnhancedService()
Get Specifies whether to enable services such as Anti-DDoS and Cloud Monitor.
|
String |
getHostName()
Get Instance hostname.
|
String |
getHpcClusterId()
Get HPC cluster ID.
|
String |
getImageId()
Get The [image](https://intl.cloud.tencent.com/document/product/213/4940?from_cn_redirect=1) ID in the format of `img-xxx`.
|
InstanceChargePrepaid |
getInstanceChargePrepaid()
Get Configuration of prepaid instances.
|
String |
getInstanceChargeType()
Get Instance [billing type](https://intl.cloud.tencent.com/document/product/213/2180?from_cn_redirect=1).
|
Long |
getInstanceCount()
Get The number of instances to be purchased.
|
InstanceMarketOptionsRequest |
getInstanceMarketOptions()
Get The market options of the instance.
|
String |
getInstanceName()
Get Instance name to be displayed.
If this parameter is not specified, "Unnamed" will be displayed by default.If you purchase multiple instances at the same time and specify a pattern string `{R:x}`, numbers `[x, x+n-1]` will be generated, where `n` represents the number of instances purchased. |
String |
getInstanceType()
Get The instance model.
|
InternetAccessible |
getInternetAccessible()
Get Configuration of public network bandwidth.
|
LoginSettings |
getLoginSettings()
Get Login settings of the instance.
|
Placement |
getPlacement()
Get Location of the instance.
|
String[] |
getSecurityGroupIds()
Get Security groups to which the instance belongs.
|
SystemDisk |
getSystemDisk()
Get System disk configuration of the instance.
|
TagSpecification[] |
getTagSpecification()
Get Binds the tag with the specified resources (CVM and CLB) as well
|
String |
getUserData()
Get User data provided to the instance, which needs to be encoded in base64 format with the maximum size of 16KB.
|
VirtualPrivateCloud |
getVirtualPrivateCloud()
Get Configuration information of VPC.
|
void |
setActionTimer(ActionTimer ActionTimer)
Set Scheduled tasks.
|
void |
setCamRoleName(String CamRoleName)
Set CAM role name, which can be obtained from the `roleName` field in the response of the [`DescribeRoleList`](https://intl.cloud.tencent.com/document/product/598/13887?from_cn_redirect=1) API.
|
void |
setClientToken(String ClientToken)
Set A string used to ensure the idempotency of the request, which is generated by the user and must be unique to each request.
|
void |
setDataDisks(DataDisk[] DataDisks)
Set The configuration information of instance data disks.
|
void |
setDisasterRecoverGroupIds(String[] DisasterRecoverGroupIds)
Set Placement group ID.
|
void |
setDryRun(Boolean DryRun)
Set Whether the request is a dry run only.
|
void |
setEnhancedService(EnhancedService EnhancedService)
Set Specifies whether to enable services such as Anti-DDoS and Cloud Monitor.
|
void |
setHostName(String HostName)
Set Instance hostname.
|
void |
setHpcClusterId(String HpcClusterId)
Set HPC cluster ID.
|
void |
setImageId(String ImageId)
Set The [image](https://intl.cloud.tencent.com/document/product/213/4940?from_cn_redirect=1) ID in the format of `img-xxx`.
|
void |
setInstanceChargePrepaid(InstanceChargePrepaid InstanceChargePrepaid)
Set Configuration of prepaid instances.
|
void |
setInstanceChargeType(String InstanceChargeType)
Set Instance [billing type](https://intl.cloud.tencent.com/document/product/213/2180?from_cn_redirect=1).
|
void |
setInstanceCount(Long InstanceCount)
Set The number of instances to be purchased.
|
void |
setInstanceMarketOptions(InstanceMarketOptionsRequest InstanceMarketOptions)
Set The market options of the instance.
|
void |
setInstanceName(String InstanceName)
Set Instance name to be displayed.
If this parameter is not specified, "Unnamed" will be displayed by default.If you purchase multiple instances at the same time and specify a pattern string `{R:x}`, numbers `[x, x+n-1]` will be generated, where `n` represents the number of instances purchased. |
void |
setInstanceType(String InstanceType)
Set The instance model.
|
void |
setInternetAccessible(InternetAccessible InternetAccessible)
Set Configuration of public network bandwidth.
|
void |
setLoginSettings(LoginSettings LoginSettings)
Set Login settings of the instance.
|
void |
setPlacement(Placement Placement)
Set Location of the instance.
|
void |
setSecurityGroupIds(String[] SecurityGroupIds)
Set Security groups to which the instance belongs.
|
void |
setSystemDisk(SystemDisk SystemDisk)
Set System disk configuration of the instance.
|
void |
setTagSpecification(TagSpecification[] TagSpecification)
Set Binds the tag with the specified resources (CVM and CLB) as well
|
void |
setUserData(String UserData)
Set User data provided to the instance, which needs to be encoded in base64 format with the maximum size of 16KB.
|
void |
setVirtualPrivateCloud(VirtualPrivateCloud VirtualPrivateCloud)
Set Configuration information of VPC.
|
void |
toMap(HashMap<String,String> map,
String prefix)
Internal implementation, normal users should not use it.
|
any, fromJsonString, getBinaryParams, getMultipartRequestParams, set, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, toJsonStringpublic RunInstancesRequest()
public RunInstancesRequest(RunInstancesRequest source)
public String getInstanceChargeType()
public void setInstanceChargeType(String InstanceChargeType)
InstanceChargeType - Instance [billing type](https://intl.cloud.tencent.com/document/product/213/2180?from_cn_redirect=1). public InstanceChargePrepaid getInstanceChargePrepaid()
public void setInstanceChargePrepaid(InstanceChargePrepaid InstanceChargePrepaid)
InstanceChargePrepaid - Configuration of prepaid instances. You can use the parameter to specify the attributes of prepaid instances, such as the subscription period and the auto-renewal plan. This parameter is required for prepaid instances.public Placement getPlacement()
public void setPlacement(Placement Placement)
Placement - Location of the instance. You can use this parameter to specify the attributes of the instance, such as its availability zone, project, and CDH. You can specify a CDH for a CVM by creating the CVM on the CDH.public String getInstanceType()
public void setInstanceType(String InstanceType)
InstanceType - The instance model. Different resource specifications are specified for different instance models.
public String getImageId()
public void setImageId(String ImageId)
ImageId - The [image](https://intl.cloud.tencent.com/document/product/213/4940?from_cn_redirect=1) ID in the format of `img-xxx`. There are four types of images:public SystemDisk getSystemDisk()
public void setSystemDisk(SystemDisk SystemDisk)
SystemDisk - System disk configuration of the instance. If this parameter is not specified, the default value will be used.public DataDisk[] getDataDisks()
public void setDataDisks(DataDisk[] DataDisks)
DataDisks - The configuration information of instance data disks. If this parameter is not specified, no data disk will be purchased by default. When purchasing, you can specify 21 data disks, which can contain at most 1 LOCAL_BASIC data disk or LOCAL_SSD data disk, and at most 20 CLOUD_BASIC data disks, CLOUD_PREMIUM data disks, or CLOUD_SSD data disks.public VirtualPrivateCloud getVirtualPrivateCloud()
public void setVirtualPrivateCloud(VirtualPrivateCloud VirtualPrivateCloud)
VirtualPrivateCloud - Configuration information of VPC. This parameter is used to specify VPC ID and subnet ID, etc. If this parameter is not specified, the classic network is used by default. If a VPC IP is specified in this parameter, it indicates the primary ENI IP of each instance. The value of parameter InstanceCount must be same as the number of VPC IPs, which cannot be greater than 20.public InternetAccessible getInternetAccessible()
public void setInternetAccessible(InternetAccessible InternetAccessible)
InternetAccessible - Configuration of public network bandwidth. If this parameter is not specified, 0 Mbps will be used by default.public Long getInstanceCount()
public void setInstanceCount(Long InstanceCount)
InstanceCount - The number of instances to be purchased. Value range: [1, 100]; default value: 1. The specified number of instances to be purchased cannot exceed the remaining quota allowed for the user. For more information on the quota, see [CVM instance purchase limit](https://intl.cloud.tencent.com/document/product/213/2664).public String getInstanceName()
public void setInstanceName(String InstanceName)
InstanceName - Instance name to be displayed.public LoginSettings getLoginSettings()
public void setLoginSettings(LoginSettings LoginSettings)
LoginSettings - Login settings of the instance. You can use this parameter to set the login method, password, and key of the instance or keep the login settings of the original image. By default, a random password will be generated and sent to you via the Message Center.public String[] getSecurityGroupIds()
public void setSecurityGroupIds(String[] SecurityGroupIds)
SecurityGroupIds - Security groups to which the instance belongs. To obtain the security group IDs, you can call [DescribeSecurityGroups](https://intl.cloud.tencent.com/document/api/215/15808) and look for the `sgld` fields in the response. If this parameter is not specified, the instance will be associated with default security groups.public EnhancedService getEnhancedService()
public void setEnhancedService(EnhancedService EnhancedService)
EnhancedService - Specifies whether to enable services such as Anti-DDoS and Cloud Monitor. If this parameter is not specified, Cloud Monitor and Anti-DDoS are enabled for public images by default. However, for custom images and images from the marketplace, Anti-DDoS and Cloud Monitor are not enabled by default. The original services in the image will be retained.public String getClientToken()
public void setClientToken(String ClientToken)
ClientToken - A string used to ensure the idempotency of the request, which is generated by the user and must be unique to each request. The maximum length is 64 ASCII characters. If this parameter is not specified, the idempotency of the request cannot be guaranteed. public String getHostName()
public void setHostName(String HostName)
HostName - Instance hostname. public ActionTimer getActionTimer()
public void setActionTimer(ActionTimer ActionTimer)
ActionTimer - Scheduled tasks. You can use this parameter to specify scheduled tasks for the instance. Only scheduled termination is supported.public String[] getDisasterRecoverGroupIds()
public void setDisasterRecoverGroupIds(String[] DisasterRecoverGroupIds)
DisasterRecoverGroupIds - Placement group ID. You can only specify one.public TagSpecification[] getTagSpecification()
public void setTagSpecification(TagSpecification[] TagSpecification)
TagSpecification - Binds the tag with the specified resources (CVM and CLB) as wellpublic InstanceMarketOptionsRequest getInstanceMarketOptions()
public void setInstanceMarketOptions(InstanceMarketOptionsRequest InstanceMarketOptions)
InstanceMarketOptions - The market options of the instance.public String getUserData()
public void setUserData(String UserData)
UserData - User data provided to the instance, which needs to be encoded in base64 format with the maximum size of 16KB. For more information on how to get the value of this parameter, see the commands you need to execute on startup for [Windows](https://intl.cloud.tencent.com/document/product/213/17526) or [Linux](https://intl.cloud.tencent.com/document/product/213/17525).public Boolean getDryRun()
public void setDryRun(Boolean DryRun)
DryRun - Whether the request is a dry run only.
true: dry run only. The request will not create instance(s). A dry run can check whether all the required parameters are specified, whether the request format is right, whether the request exceeds service limits, and whether the specified CVMs are available.
If the dry run fails, the corresponding error code will be returned.
If the dry run succeeds, the RequestId will be returned.
false (default value): send a normal request and create instance(s) if all the requirements are met.public String getCamRoleName()
public void setCamRoleName(String CamRoleName)
CamRoleName - CAM role name, which can be obtained from the `roleName` field in the response of the [`DescribeRoleList`](https://intl.cloud.tencent.com/document/product/598/13887?from_cn_redirect=1) API.public String getHpcClusterId()
public void setHpcClusterId(String HpcClusterId)
HpcClusterId - HPC cluster ID. The HPC cluster must and can only be specified for a high-performance computing instance.Copyright © 2021. All rights reserved.