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 修改实例主机名是否自动重启实例，不传默认自动重启。 - true: 修改主机名，并自动重启实例； - false: 修改主机名，不自动重启实例，需要手动重启使新主机名生效。 注意点：本参数仅对修改主机名生效。
String	getCamRoleName() Get 给实例绑定用户角色，传空值为解绑操作
String	getCamRoleType() Get 角色类别，与CamRoleName搭配使用，该值可从CAM DescribeRoleList, GetRole接口返回RoleType字段获取，当前只接受user、system和service_linked三种类别。 举例：一般CamRoleName中包含“LinkedRoleIn”（如TKE_QCSLinkedRoleInPrometheusService）时，DescribeRoleList和GetRole返回的RoleType为service_linked，则本参数也需要传递service_linked。 该参数默认值为user，若CameRoleName为非service_linked类型，本参数可不传递。
Boolean	getDisableApiTermination() Get 实例销毁保护标志，表示是否允许通过api接口删除实例。取值范围：true：表示开启实例保护，不允许通过api接口删除实例false：表示关闭实例保护，允许通过api接口删除实例默认取值：false。
String	getHostName() Get 修改后实例的主机名。点号（.）和短横线（-）不能作为 HostName 的首尾字符，不能连续使用。Windows 实例：主机名字符长度为[2, 15]，允许字母（不限制大小写）、数字和短横线（-）组成，不支持点号（.），不能全是数字。其他类型（Linux 等）实例：主机名字符长度为[2, 60]，允许支持多个点号，点之间为一段，每段允许字母（不限制大小写）、数字和短横线（-）组成。注意点：修改主机名后实例会立即重启，重启后新的主机名生效。
String[]	getInstanceIds() Get 一个或多个待操作的实例ID。可通过[DescribeInstances](https://cloud.tencent.com/document/api/213/15728) API返回值中的`InstanceId`获取。每次请求允许操作的实例数量上限是100。
String	getInstanceName() Get 修改后实例名称。可任意命名，但不得超过60个字符。 必须指定InstanceName与SecurityGroups的其中一个，但不能同时设置
String[]	getSecurityGroups() Get 指定实例的修改后的安全组Id列表，子机将重新关联指定列表的安全组，原本关联的安全组会被解绑。必须指定SecurityGroups与InstanceName的其中一个，但不能同时设置
String	getUserData() Get 提供给实例使用的用户数据，需要以 base64 方式编码，支持的最大数据大小为 16 KB。关于获取此参数的详细介绍，请参阅 [Windows](https://cloud.tencent.com/document/product/213/17526) 和 [Linux](https://cloud.tencent.com/document/product/213/17525) 启动时运行命令。
void	setAutoReboot(Boolean AutoReboot) Set 修改实例主机名是否自动重启实例，不传默认自动重启。 - true: 修改主机名，并自动重启实例； - false: 修改主机名，不自动重启实例，需要手动重启使新主机名生效。 注意点：本参数仅对修改主机名生效。
void	setCamRoleName(String CamRoleName) Set 给实例绑定用户角色，传空值为解绑操作
void	setCamRoleType(String CamRoleType) Set 角色类别，与CamRoleName搭配使用，该值可从CAM DescribeRoleList, GetRole接口返回RoleType字段获取，当前只接受user、system和service_linked三种类别。 举例：一般CamRoleName中包含“LinkedRoleIn”（如TKE_QCSLinkedRoleInPrometheusService）时，DescribeRoleList和GetRole返回的RoleType为service_linked，则本参数也需要传递service_linked。 该参数默认值为user，若CameRoleName为非service_linked类型，本参数可不传递。
void	setDisableApiTermination(Boolean DisableApiTermination) Set 实例销毁保护标志，表示是否允许通过api接口删除实例。取值范围：true：表示开启实例保护，不允许通过api接口删除实例false：表示关闭实例保护，允许通过api接口删除实例默认取值：false。
void	setHostName(String HostName) Set 修改后实例的主机名。点号（.）和短横线（-）不能作为 HostName 的首尾字符，不能连续使用。Windows 实例：主机名字符长度为[2, 15]，允许字母（不限制大小写）、数字和短横线（-）组成，不支持点号（.），不能全是数字。其他类型（Linux 等）实例：主机名字符长度为[2, 60]，允许支持多个点号，点之间为一段，每段允许字母（不限制大小写）、数字和短横线（-）组成。注意点：修改主机名后实例会立即重启，重启后新的主机名生效。
void	setInstanceIds(String[] InstanceIds) Set 一个或多个待操作的实例ID。可通过[DescribeInstances](https://cloud.tencent.com/document/api/213/15728) API返回值中的`InstanceId`获取。每次请求允许操作的实例数量上限是100。
void	setInstanceName(String InstanceName) Set 修改后实例名称。可任意命名，但不得超过60个字符。 必须指定InstanceName与SecurityGroups的其中一个，但不能同时设置
void	setSecurityGroups(String[] SecurityGroups) Set 指定实例的修改后的安全组Id列表，子机将重新关联指定列表的安全组，原本关联的安全组会被解绑。必须指定SecurityGroups与InstanceName的其中一个，但不能同时设置
void	setUserData(String UserData) Set 提供给实例使用的用户数据，需要以 base64 方式编码，支持的最大数据大小为 16 KB。关于获取此参数的详细介绍，请参阅 [Windows](https://cloud.tencent.com/document/product/213/17526) 和 [Linux](https://cloud.tencent.com/document/product/213/17525) 启动时运行命令。
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 一个或多个待操作的实例ID。可通过[DescribeInstances](https://cloud.tencent.com/document/api/213/15728) API返回值中的`InstanceId`获取。每次请求允许操作的实例数量上限是100。

Returns:

InstanceIds 一个或多个待操作的实例ID。可通过[DescribeInstances](https://cloud.tencent.com/document/api/213/15728) API返回值中的`InstanceId`获取。每次请求允许操作的实例数量上限是100。

setInstanceIds

public void setInstanceIds(String[] InstanceIds)

Set 一个或多个待操作的实例ID。可通过[DescribeInstances](https://cloud.tencent.com/document/api/213/15728) API返回值中的`InstanceId`获取。每次请求允许操作的实例数量上限是100。

Parameters:

InstanceIds - 一个或多个待操作的实例ID。可通过[DescribeInstances](https://cloud.tencent.com/document/api/213/15728) API返回值中的`InstanceId`获取。每次请求允许操作的实例数量上限是100。

getInstanceName

public String getInstanceName()

Get 修改后实例名称。可任意命名，但不得超过60个字符。 必须指定InstanceName与SecurityGroups的其中一个，但不能同时设置

Returns:

InstanceName 修改后实例名称。可任意命名，但不得超过60个字符。 必须指定InstanceName与SecurityGroups的其中一个，但不能同时设置

setInstanceName

public void setInstanceName(String InstanceName)

Set 修改后实例名称。可任意命名，但不得超过60个字符。 必须指定InstanceName与SecurityGroups的其中一个，但不能同时设置

Parameters:

InstanceName - 修改后实例名称。可任意命名，但不得超过60个字符。 必须指定InstanceName与SecurityGroups的其中一个，但不能同时设置

getUserData

public String getUserData()

Get 提供给实例使用的用户数据，需要以 base64 方式编码，支持的最大数据大小为 16 KB。关于获取此参数的详细介绍，请参阅 [Windows](https://cloud.tencent.com/document/product/213/17526) 和 [Linux](https://cloud.tencent.com/document/product/213/17525) 启动时运行命令。

Returns:

UserData 提供给实例使用的用户数据，需要以 base64 方式编码，支持的最大数据大小为 16 KB。关于获取此参数的详细介绍，请参阅 [Windows](https://cloud.tencent.com/document/product/213/17526) 和 [Linux](https://cloud.tencent.com/document/product/213/17525) 启动时运行命令。

setUserData

public void setUserData(String UserData)

Set 提供给实例使用的用户数据，需要以 base64 方式编码，支持的最大数据大小为 16 KB。关于获取此参数的详细介绍，请参阅 [Windows](https://cloud.tencent.com/document/product/213/17526) 和 [Linux](https://cloud.tencent.com/document/product/213/17525) 启动时运行命令。

Parameters:

UserData - 提供给实例使用的用户数据，需要以 base64 方式编码，支持的最大数据大小为 16 KB。关于获取此参数的详细介绍，请参阅 [Windows](https://cloud.tencent.com/document/product/213/17526) 和 [Linux](https://cloud.tencent.com/document/product/213/17525) 启动时运行命令。

getSecurityGroups

public String[] getSecurityGroups()

Get 指定实例的修改后的安全组Id列表，子机将重新关联指定列表的安全组，原本关联的安全组会被解绑。必须指定SecurityGroups与InstanceName的其中一个，但不能同时设置

Returns:

SecurityGroups 指定实例的修改后的安全组Id列表，子机将重新关联指定列表的安全组，原本关联的安全组会被解绑。必须指定SecurityGroups与InstanceName的其中一个，但不能同时设置

setSecurityGroups

public void setSecurityGroups(String[] SecurityGroups)

Set 指定实例的修改后的安全组Id列表，子机将重新关联指定列表的安全组，原本关联的安全组会被解绑。必须指定SecurityGroups与InstanceName的其中一个，但不能同时设置

Parameters:

SecurityGroups - 指定实例的修改后的安全组Id列表，子机将重新关联指定列表的安全组，原本关联的安全组会被解绑。必须指定SecurityGroups与InstanceName的其中一个，但不能同时设置

getCamRoleName

public String getCamRoleName()

Get 给实例绑定用户角色，传空值为解绑操作

Returns:

CamRoleName 给实例绑定用户角色，传空值为解绑操作

setCamRoleName

public void setCamRoleName(String CamRoleName)

Set 给实例绑定用户角色，传空值为解绑操作

Parameters:

CamRoleName - 给实例绑定用户角色，传空值为解绑操作

getHostName

public String getHostName()

Get 修改后实例的主机名。

点号（.）和短横线（-）不能作为 HostName 的首尾字符，不能连续使用。Windows 实例：主机名字符长度为[2, 15]，允许字母（不限制大小写）、数字和短横线（-）组成，不支持点号（.），不能全是数字。其他类型（Linux 等）实例：主机名字符长度为[2, 60]，允许支持多个点号，点之间为一段，每段允许字母（不限制大小写）、数字和短横线（-）组成。注意点：修改主机名后实例会立即重启，重启后新的主机名生效。

Returns:

HostName 修改后实例的主机名。

点号（.）和短横线（-）不能作为 HostName 的首尾字符，不能连续使用。

Windows 实例：主机名字符长度为[2, 15]，允许字母（不限制大小写）、数字和短横线（-）组成，不支持点号（.），不能全是数字。

其他类型（Linux 等）实例：主机名字符长度为[2, 60]，允许支持多个点号，点之间为一段，每段允许字母（不限制大小写）、数字和短横线（-）组成。

注意点：修改主机名后实例会立即重启，重启后新的主机名生效。

setHostName

public void setHostName(String HostName)

Set 修改后实例的主机名。

点号（.）和短横线（-）不能作为 HostName 的首尾字符，不能连续使用。Windows 实例：主机名字符长度为[2, 15]，允许字母（不限制大小写）、数字和短横线（-）组成，不支持点号（.），不能全是数字。其他类型（Linux 等）实例：主机名字符长度为[2, 60]，允许支持多个点号，点之间为一段，每段允许字母（不限制大小写）、数字和短横线（-）组成。注意点：修改主机名后实例会立即重启，重启后新的主机名生效。