com.tencentcloudapi.cvm.v20170312.models

Class ModifyInstancesAttributeRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.cvm.v20170312.models.ModifyInstancesAttributeRequest

public class ModifyInstancesAttributeRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
ModifyInstancesAttributeRequest()
ModifyInstancesAttributeRequest(ModifyInstancesAttributeRequest 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
Boolean	getAutoReboot() Get Whether to automatically restart an instance when modifying a hostname.
String	getCamRoleName() Get The role bound with the instance.
String	getCamRoleType() Get The role type, which is used in conjunction with `CamRoleName`.
Boolean	getDisableApiTermination() Get Instance termination protection flag, indicating whether an instance is allowed to be deleted through an API.
String	getHostName() Get Modified hostname of an instance.Period (.) and hyphen (-) should not be used as the first or last character of the hostname, and should not be used consecutively.Windows instances: The hostname should contain 2 to 15 characters, including letters (case insensitive), digits, and hyphens (-), does not support periods (.), and should not be all digits.Instances of other types (such as Linux instances): The hostname should contain 2 to 60 characters, including multiple periods (.), with each segment between periods considered as one section.
String[]	getInstanceIds() Get Instance ID(s).
String	getInstanceName() Get The instance name, which can not exceed 60 characters Either `InstanceName` or `SecurityGroups` must be specified, but they can not be both specified.
String[]	getSecurityGroups() Get IDs of security groups associated with the specified instance.
String	getUserData() Get User data provided to an instance, which needs to be encoded in Base64 format with a maximum size of 16 KB.
void	setAutoReboot(Boolean AutoReboot) Set Whether to automatically restart an instance when modifying a hostname.
void	setCamRoleName(String CamRoleName) Set The role bound with the instance.
void	setCamRoleType(String CamRoleType) Set The role type, which is used in conjunction with `CamRoleName`.
void	setDisableApiTermination(Boolean DisableApiTermination) Set Instance termination protection flag, indicating whether an instance is allowed to be deleted through an API.
void	setHostName(String HostName) Set Modified hostname of an instance.Period (.) and hyphen (-) should not be used as the first or last character of the hostname, and should not be used consecutively.Windows instances: The hostname should contain 2 to 15 characters, including letters (case insensitive), digits, and hyphens (-), does not support periods (.), and should not be all digits.Instances of other types (such as Linux instances): The hostname should contain 2 to 60 characters, including multiple periods (.), with each segment between periods considered as one section.
void	setInstanceIds(String[] InstanceIds) Set Instance ID(s).
void	setInstanceName(String InstanceName) Set The instance name, which can not exceed 60 characters Either `InstanceName` or `SecurityGroups` must be specified, but they can not be both specified.
void	setSecurityGroups(String[] SecurityGroups) Set IDs of security groups associated with the specified instance.
void	setUserData(String UserData) Set User data provided to an instance, which needs to be encoded in Base64 format with a maximum size of 16 KB.
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, GetHeader, getMultipartRequestParams, getSkipSign, isStream, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonString

Methods inherited from class java.lang.Object

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

Constructor Detail

ModifyInstancesAttributeRequest

public ModifyInstancesAttributeRequest()

ModifyInstancesAttributeRequest

public ModifyInstancesAttributeRequest(ModifyInstancesAttributeRequest 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

getInstanceIds

public String[] getInstanceIds()

Get Instance ID(s). To obtain the instance IDs, you can call [`DescribeInstances`](https://intl.cloud.tencent.com/document/api/213/15728?from_cn_redirect=1) and look for `InstanceId` in the response. The maximum number of instances in each request is 100.

Returns:

InstanceIds Instance ID(s). To obtain the instance IDs, you can call [`DescribeInstances`](https://intl.cloud.tencent.com/document/api/213/15728?from_cn_redirect=1) and look for `InstanceId` in the response. The maximum number of instances in each request is 100.

setInstanceIds

public void setInstanceIds(String[] InstanceIds)

Set Instance ID(s). To obtain the instance IDs, you can call [`DescribeInstances`](https://intl.cloud.tencent.com/document/api/213/15728?from_cn_redirect=1) and look for `InstanceId` in the response. The maximum number of instances in each request is 100.

Parameters:

InstanceIds - Instance ID(s). To obtain the instance IDs, you can call [`DescribeInstances`](https://intl.cloud.tencent.com/document/api/213/15728?from_cn_redirect=1) and look for `InstanceId` in the response. The maximum number of instances in each request is 100.

getInstanceName

public String getInstanceName()

Get The instance name, which can not exceed 60 characters Either `InstanceName` or `SecurityGroups` must be specified, but they can not be both specified.

Returns:

InstanceName The instance name, which can not exceed 60 characters Either `InstanceName` or `SecurityGroups` must be specified, but they can not be both specified.

setInstanceName

public void setInstanceName(String InstanceName)

Set The instance name, which can not exceed 60 characters Either `InstanceName` or `SecurityGroups` must be specified, but they can not be both specified.

Parameters:

InstanceName - The instance name, which can not exceed 60 characters Either `InstanceName` or `SecurityGroups` must be specified, but they can not be both specified.

getUserData

public String getUserData()

Get User data provided to an instance, which needs to be encoded in Base64 format with a maximum size of 16 KB. For details on obtaining this parameter, refer to the startup commands for [Windows](https://intl.cloud.tencent.com/document/product/213/17526?from_cn_redirect=1) and [Linux](https://intl.cloud.tencent.com/document/product/213/17525?from_cn_redirect=1).

Returns:

UserData User data provided to an instance, which needs to be encoded in Base64 format with a maximum size of 16 KB. For details on obtaining this parameter, refer to the startup commands for [Windows](https://intl.cloud.tencent.com/document/product/213/17526?from_cn_redirect=1) and [Linux](https://intl.cloud.tencent.com/document/product/213/17525?from_cn_redirect=1).

setUserData

public void setUserData(String UserData)

Set User data provided to an instance, which needs to be encoded in Base64 format with a maximum size of 16 KB. For details on obtaining this parameter, refer to the startup commands for [Windows](https://intl.cloud.tencent.com/document/product/213/17526?from_cn_redirect=1) and [Linux](https://intl.cloud.tencent.com/document/product/213/17525?from_cn_redirect=1).

Parameters:

UserData - User data provided to an instance, which needs to be encoded in Base64 format with a maximum size of 16 KB. For details on obtaining this parameter, refer to the startup commands for [Windows](https://intl.cloud.tencent.com/document/product/213/17526?from_cn_redirect=1) and [Linux](https://intl.cloud.tencent.com/document/product/213/17525?from_cn_redirect=1).

getSecurityGroups

public String[] getSecurityGroups()

Get IDs of security groups associated with the specified instance. You can associate with a security group by adding its ID, or cancel the association with a security group by removing its ID. Either `InstanceName` or `SecurityGroups` must be specified, but they cannot be both set.

Returns:

SecurityGroups IDs of security groups associated with the specified instance. You can associate with a security group by adding its ID, or cancel the association with a security group by removing its ID. Either `InstanceName` or `SecurityGroups` must be specified, but they cannot be both set.

setSecurityGroups

public void setSecurityGroups(String[] SecurityGroups)

Set IDs of security groups associated with the specified instance. You can associate with a security group by adding its ID, or cancel the association with a security group by removing its ID. Either `InstanceName` or `SecurityGroups` must be specified, but they cannot be both set.

Parameters:

SecurityGroups - IDs of security groups associated with the specified instance. You can associate with a security group by adding its ID, or cancel the association with a security group by removing its ID. Either `InstanceName` or `SecurityGroups` must be specified, but they cannot be both set.

getCamRoleName

public String getCamRoleName()

Get The role bound with the instance. If it is not specified, it indicates to unbind the current role of the CVM.

Returns:

CamRoleName The role bound with the instance. If it is not specified, it indicates to unbind the current role of the CVM.

setCamRoleName

public void setCamRoleName(String CamRoleName)

Set The role bound with the instance. If it is not specified, it indicates to unbind the current role of the CVM.

Parameters:

CamRoleName - The role bound with the instance. If it is not specified, it indicates to unbind the current role of the CVM.

getHostName

public String getHostName()

Get Modified hostname of an instance.

Period (.) and hyphen (-) should not be used as the first or last character of the hostname, and should not be used consecutively.Windows instances: The hostname should contain 2 to 15 characters, including letters (case insensitive), digits, and hyphens (-), does not support periods (.), and should not be all digits.Instances of other types (such as Linux instances): The hostname should contain 2 to 60 characters, including multiple periods (.), with each segment between periods considered as one section. Each section can contain letters (case insensitive), digits, and hyphens (-).Note: After the hostname is modified, the instance will restart immediately, and the new hostname will take effect after the restart.

Returns:

HostName Modified hostname of an instance.

Period (.) and hyphen (-) should not be used as the first or last character of the hostname, and should not be used consecutively.

Windows instances: The hostname should contain 2 to 15 characters, including letters (case insensitive), digits, and hyphens (-), does not support periods (.), and should not be all digits.

Instances of other types (such as Linux instances): The hostname should contain 2 to 60 characters, including multiple periods (.), with each segment between periods considered as one section. Each section can contain letters (case insensitive), digits, and hyphens (-).

Note: After the hostname is modified, the instance will restart immediately, and the new hostname will take effect after the restart.

setHostName

public void setHostName(String HostName)

Set Modified hostname of an instance.

Period (.) and hyphen (-) should not be used as the first or last character of the hostname, and should not be used consecutively.Windows instances: The hostname should contain 2 to 15 characters, including letters (case insensitive), digits, and hyphens (-), does not support periods (.), and should not be all digits.Instances of other types (such as Linux instances): The hostname should contain 2 to 60 characters, including multiple periods (.), with each segment between periods considered as one section. Each section can contain letters (case insensitive), digits, and hyphens (-).Note: After the hostname is modified, the instance will restart immediately, and the new hostname will take effect after the restart.