Class: TencentCloud::Cvm::V20170312::ModifyInstancesAttributeRequest

Inherits:

TencentCloud::Common::AbstractModel

Object
TencentCloud::Common::AbstractModel
TencentCloud::Cvm::V20170312::ModifyInstancesAttributeRequest

show all

Defined in:: lib/v20170312/models.rb

Overview

ModifyInstancesAttribute请求参数结构体

Instance Attribute Summary collapse

#AutoReboot ⇒ Object

<dx-alert infotype=“explain” title=“”>必须指定InstanceName与SecurityGroups的其中一个，但不能同时设置</dx-alert> 举例：一般CamRoleName中包含“LinkedRoleIn”（如TKE_QCSLinkedRoleInPrometheusService）时，DescribeRoleList和GetRole返回的RoleType为service_linked，则本参数也需要传递service_linked。该参数默认值为user，若CameRoleName为非service_linked类型，本参数可不传递。 - true: 修改主机名，并自动重启实例； - false: 修改主机名，不自动重启实例，需要手动重启使新主机名生效。注意点：本参数仅对修改主机名生效。.
#CamRoleName ⇒ Object

<dx-alert infotype=“explain” title=“”>必须指定InstanceName与SecurityGroups的其中一个，但不能同时设置</dx-alert> 举例：一般CamRoleName中包含“LinkedRoleIn”（如TKE_QCSLinkedRoleInPrometheusService）时，DescribeRoleList和GetRole返回的RoleType为service_linked，则本参数也需要传递service_linked。该参数默认值为user，若CameRoleName为非service_linked类型，本参数可不传递。 - true: 修改主机名，并自动重启实例； - false: 修改主机名，不自动重启实例，需要手动重启使新主机名生效。注意点：本参数仅对修改主机名生效。.
#CamRoleType ⇒ Object

<dx-alert infotype=“explain” title=“”>必须指定InstanceName与SecurityGroups的其中一个，但不能同时设置</dx-alert> 举例：一般CamRoleName中包含“LinkedRoleIn”（如TKE_QCSLinkedRoleInPrometheusService）时，DescribeRoleList和GetRole返回的RoleType为service_linked，则本参数也需要传递service_linked。该参数默认值为user，若CameRoleName为非service_linked类型，本参数可不传递。 - true: 修改主机名，并自动重启实例； - false: 修改主机名，不自动重启实例，需要手动重启使新主机名生效。注意点：本参数仅对修改主机名生效。.
#DisableApiTermination ⇒ Object

<dx-alert infotype=“explain” title=“”>必须指定InstanceName与SecurityGroups的其中一个，但不能同时设置</dx-alert> 举例：一般CamRoleName中包含“LinkedRoleIn”（如TKE_QCSLinkedRoleInPrometheusService）时，DescribeRoleList和GetRole返回的RoleType为service_linked，则本参数也需要传递service_linked。该参数默认值为user，若CameRoleName为非service_linked类型，本参数可不传递。 - true: 修改主机名，并自动重启实例； - false: 修改主机名，不自动重启实例，需要手动重启使新主机名生效。注意点：本参数仅对修改主机名生效。.
#HostName ⇒ Object

<dx-alert infotype=“explain” title=“”>必须指定InstanceName与SecurityGroups的其中一个，但不能同时设置</dx-alert> 举例：一般CamRoleName中包含“LinkedRoleIn”（如TKE_QCSLinkedRoleInPrometheusService）时，DescribeRoleList和GetRole返回的RoleType为service_linked，则本参数也需要传递service_linked。该参数默认值为user，若CameRoleName为非service_linked类型，本参数可不传递。 - true: 修改主机名，并自动重启实例； - false: 修改主机名，不自动重启实例，需要手动重启使新主机名生效。注意点：本参数仅对修改主机名生效。.
#InstanceIds ⇒ Object

<dx-alert infotype=“explain” title=“”>必须指定InstanceName与SecurityGroups的其中一个，但不能同时设置</dx-alert> 举例：一般CamRoleName中包含“LinkedRoleIn”（如TKE_QCSLinkedRoleInPrometheusService）时，DescribeRoleList和GetRole返回的RoleType为service_linked，则本参数也需要传递service_linked。该参数默认值为user，若CameRoleName为非service_linked类型，本参数可不传递。 - true: 修改主机名，并自动重启实例； - false: 修改主机名，不自动重启实例，需要手动重启使新主机名生效。注意点：本参数仅对修改主机名生效。.
#InstanceName ⇒ Object

<dx-alert infotype=“explain” title=“”>必须指定InstanceName与SecurityGroups的其中一个，但不能同时设置</dx-alert> 举例：一般CamRoleName中包含“LinkedRoleIn”（如TKE_QCSLinkedRoleInPrometheusService）时，DescribeRoleList和GetRole返回的RoleType为service_linked，则本参数也需要传递service_linked。该参数默认值为user，若CameRoleName为非service_linked类型，本参数可不传递。 - true: 修改主机名，并自动重启实例； - false: 修改主机名，不自动重启实例，需要手动重启使新主机名生效。注意点：本参数仅对修改主机名生效。.
#SecurityGroups ⇒ Object

<dx-alert infotype=“explain” title=“”>必须指定InstanceName与SecurityGroups的其中一个，但不能同时设置</dx-alert> 举例：一般CamRoleName中包含“LinkedRoleIn”（如TKE_QCSLinkedRoleInPrometheusService）时，DescribeRoleList和GetRole返回的RoleType为service_linked，则本参数也需要传递service_linked。该参数默认值为user，若CameRoleName为非service_linked类型，本参数可不传递。 - true: 修改主机名，并自动重启实例； - false: 修改主机名，不自动重启实例，需要手动重启使新主机名生效。注意点：本参数仅对修改主机名生效。.
#UserData ⇒ Object

<dx-alert infotype=“explain” title=“”>必须指定InstanceName与SecurityGroups的其中一个，但不能同时设置</dx-alert> 举例：一般CamRoleName中包含“LinkedRoleIn”（如TKE_QCSLinkedRoleInPrometheusService）时，DescribeRoleList和GetRole返回的RoleType为service_linked，则本参数也需要传递service_linked。该参数默认值为user，若CameRoleName为非service_linked类型，本参数可不传递。 - true: 修改主机名，并自动重启实例； - false: 修改主机名，不自动重启实例，需要手动重启使新主机名生效。注意点：本参数仅对修改主机名生效。.

Instance Method Summary collapse

#deserialize(params) ⇒ Object
#initialize(instanceids = nil, instancename = nil, userdata = nil, securitygroups = nil, camrolename = nil, hostname = nil, disableapitermination = nil, camroletype = nil, autoreboot = nil) ⇒ ModifyInstancesAttributeRequest constructor

A new instance of ModifyInstancesAttributeRequest.

Constructor Details

#initialize(instanceids = nil, instancename = nil, userdata = nil, securitygroups = nil, camrolename = nil, hostname = nil, disableapitermination = nil, camroletype = nil, autoreboot = nil) ⇒ `ModifyInstancesAttributeRequest`

Returns a new instance of ModifyInstancesAttributeRequest.

# File 'lib/v20170312/models.rb', line 6482

def initialize(instanceids=nil, instancename=nil, userdata=nil, securitygroups=nil, camrolename=nil, hostname=nil, disableapitermination=nil, camroletype=nil, autoreboot=nil)
  @InstanceIds = instanceids
  @InstanceName = instancename
  @UserData = userdata
  @SecurityGroups = securitygroups
  @CamRoleName = camrolename
  @HostName = hostname
  @DisableApiTermination = disableapitermination
  @CamRoleType = camroletype
  @AutoReboot = autoreboot
end

Instance Attribute Details

#AutoReboot ⇒ `Object`

<dx-alert infotype=“explain” title=“”>必须指定InstanceName与SecurityGroups的其中一个，但不能同时设置</dx-alert> 举例：一般CamRoleName中包含“LinkedRoleIn”（如TKE_QCSLinkedRoleInPrometheusService）时，DescribeRoleList和GetRole返回的RoleType为service_linked，则本参数也需要传递service_linked。该参数默认值为user，若CameRoleName为非service_linked类型，本参数可不传递。

true: 修改主机名，并自动重启实例；
false: 修改主机名，不自动重启实例，需要手动重启使新主机名生效。

注意点：本参数仅对修改主机名生效。

Parameters:

InstanceIds: —

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

修改后实例名称。可任意命名，但不得超过60个字符。
UserData: —

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

指定实例的修改后的安全组Id列表，子机将重新关联指定列表的安全组，原本关联的安全组会被解绑。<dx-alert infotype=“explain” title=“”>必须指定SecurityGroups与InstanceName的其中一个，但不能同时设置</dx-alert>
CamRoleName: —

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

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

实例销毁保护标志，表示是否允许通过api接口删除实例。取值范围：<li>true：表示开启实例保护，不允许通过api接口删除实例</li><li>false：表示关闭实例保护，允许通过api接口删除实例</li>默认取值：false。
CamRoleType: —

角色类别，与CamRoleName搭配使用，该值可从CAM DescribeRoleList, GetRole接口返回RoleType字段获取，当前只接受user、system和service_linked三种类别。
AutoReboot: —

修改实例主机名是否自动重启实例，不传默认自动重启。



6480
6481
6482

# File 'lib/v20170312/models.rb', line 6480

def AutoReboot
  @AutoReboot
end

#CamRoleName ⇒ `Object`

true: 修改主机名，并自动重启实例；
false: 修改主机名，不自动重启实例，需要手动重启使新主机名生效。

注意点：本参数仅对修改主机名生效。

Parameters:

InstanceIds: —

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

修改后实例名称。可任意命名，但不得超过60个字符。
UserData: —

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

指定实例的修改后的安全组Id列表，子机将重新关联指定列表的安全组，原本关联的安全组会被解绑。<dx-alert infotype=“explain” title=“”>必须指定SecurityGroups与InstanceName的其中一个，但不能同时设置</dx-alert>
CamRoleName: —

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

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

实例销毁保护标志，表示是否允许通过api接口删除实例。取值范围：<li>true：表示开启实例保护，不允许通过api接口删除实例</li><li>false：表示关闭实例保护，允许通过api接口删除实例</li>默认取值：false。
CamRoleType: —

角色类别，与CamRoleName搭配使用，该值可从CAM DescribeRoleList, GetRole接口返回RoleType字段获取，当前只接受user、system和service_linked三种类别。
AutoReboot: —

修改实例主机名是否自动重启实例，不传默认自动重启。



6480
6481
6482

# File 'lib/v20170312/models.rb', line 6480

def CamRoleName
  @CamRoleName
end

#CamRoleType ⇒ `Object`

true: 修改主机名，并自动重启实例；
false: 修改主机名，不自动重启实例，需要手动重启使新主机名生效。

注意点：本参数仅对修改主机名生效。

Parameters:

InstanceIds: —

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

修改后实例名称。可任意命名，但不得超过60个字符。
UserData: —

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

指定实例的修改后的安全组Id列表，子机将重新关联指定列表的安全组，原本关联的安全组会被解绑。<dx-alert infotype=“explain” title=“”>必须指定SecurityGroups与InstanceName的其中一个，但不能同时设置</dx-alert>
CamRoleName: —

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

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

实例销毁保护标志，表示是否允许通过api接口删除实例。取值范围：<li>true：表示开启实例保护，不允许通过api接口删除实例</li><li>false：表示关闭实例保护，允许通过api接口删除实例</li>默认取值：false。
CamRoleType: —

角色类别，与CamRoleName搭配使用，该值可从CAM DescribeRoleList, GetRole接口返回RoleType字段获取，当前只接受user、system和service_linked三种类别。
AutoReboot: —

修改实例主机名是否自动重启实例，不传默认自动重启。



6480
6481
6482

# File 'lib/v20170312/models.rb', line 6480

def CamRoleType
  @CamRoleType
end

#DisableApiTermination ⇒ `Object`

true: 修改主机名，并自动重启实例；
false: 修改主机名，不自动重启实例，需要手动重启使新主机名生效。

注意点：本参数仅对修改主机名生效。

Parameters:

InstanceIds: —

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

修改后实例名称。可任意命名，但不得超过60个字符。
UserData: —

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

指定实例的修改后的安全组Id列表，子机将重新关联指定列表的安全组，原本关联的安全组会被解绑。<dx-alert infotype=“explain” title=“”>必须指定SecurityGroups与InstanceName的其中一个，但不能同时设置</dx-alert>
CamRoleName: —

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

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

实例销毁保护标志，表示是否允许通过api接口删除实例。取值范围：<li>true：表示开启实例保护，不允许通过api接口删除实例</li><li>false：表示关闭实例保护，允许通过api接口删除实例</li>默认取值：false。
CamRoleType: —

角色类别，与CamRoleName搭配使用，该值可从CAM DescribeRoleList, GetRole接口返回RoleType字段获取，当前只接受user、system和service_linked三种类别。
AutoReboot: —

修改实例主机名是否自动重启实例，不传默认自动重启。



6480
6481
6482

# File 'lib/v20170312/models.rb', line 6480

def DisableApiTermination
  @DisableApiTermination
end

#HostName ⇒ `Object`

true: 修改主机名，并自动重启实例；
false: 修改主机名，不自动重启实例，需要手动重启使新主机名生效。

注意点：本参数仅对修改主机名生效。

Parameters:

InstanceIds: —

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

修改后实例名称。可任意命名，但不得超过60个字符。
UserData: —

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

指定实例的修改后的安全组Id列表，子机将重新关联指定列表的安全组，原本关联的安全组会被解绑。<dx-alert infotype=“explain” title=“”>必须指定SecurityGroups与InstanceName的其中一个，但不能同时设置</dx-alert>
CamRoleName: —

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

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

实例销毁保护标志，表示是否允许通过api接口删除实例。取值范围：<li>true：表示开启实例保护，不允许通过api接口删除实例</li><li>false：表示关闭实例保护，允许通过api接口删除实例</li>默认取值：false。
CamRoleType: —

角色类别，与CamRoleName搭配使用，该值可从CAM DescribeRoleList, GetRole接口返回RoleType字段获取，当前只接受user、system和service_linked三种类别。
AutoReboot: —

修改实例主机名是否自动重启实例，不传默认自动重启。



6480
6481
6482

# File 'lib/v20170312/models.rb', line 6480

def HostName
  @HostName
end

#InstanceIds ⇒ `Object`

true: 修改主机名，并自动重启实例；
false: 修改主机名，不自动重启实例，需要手动重启使新主机名生效。

注意点：本参数仅对修改主机名生效。

Parameters:

InstanceIds: —

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

修改后实例名称。可任意命名，但不得超过60个字符。
UserData: —

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

指定实例的修改后的安全组Id列表，子机将重新关联指定列表的安全组，原本关联的安全组会被解绑。<dx-alert infotype=“explain” title=“”>必须指定SecurityGroups与InstanceName的其中一个，但不能同时设置</dx-alert>
CamRoleName: —

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

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

实例销毁保护标志，表示是否允许通过api接口删除实例。取值范围：<li>true：表示开启实例保护，不允许通过api接口删除实例</li><li>false：表示关闭实例保护，允许通过api接口删除实例</li>默认取值：false。
CamRoleType: —

角色类别，与CamRoleName搭配使用，该值可从CAM DescribeRoleList, GetRole接口返回RoleType字段获取，当前只接受user、system和service_linked三种类别。
AutoReboot: —

修改实例主机名是否自动重启实例，不传默认自动重启。



6480
6481
6482

# File 'lib/v20170312/models.rb', line 6480

def InstanceIds
  @InstanceIds
end

#InstanceName ⇒ `Object`

true: 修改主机名，并自动重启实例；
false: 修改主机名，不自动重启实例，需要手动重启使新主机名生效。

注意点：本参数仅对修改主机名生效。

Parameters:

InstanceIds: —

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

修改后实例名称。可任意命名，但不得超过60个字符。
UserData: —

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

指定实例的修改后的安全组Id列表，子机将重新关联指定列表的安全组，原本关联的安全组会被解绑。<dx-alert infotype=“explain” title=“”>必须指定SecurityGroups与InstanceName的其中一个，但不能同时设置</dx-alert>
CamRoleName: —

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

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

实例销毁保护标志，表示是否允许通过api接口删除实例。取值范围：<li>true：表示开启实例保护，不允许通过api接口删除实例</li><li>false：表示关闭实例保护，允许通过api接口删除实例</li>默认取值：false。
CamRoleType: —

角色类别，与CamRoleName搭配使用，该值可从CAM DescribeRoleList, GetRole接口返回RoleType字段获取，当前只接受user、system和service_linked三种类别。
AutoReboot: —

修改实例主机名是否自动重启实例，不传默认自动重启。



6480
6481
6482

# File 'lib/v20170312/models.rb', line 6480

def InstanceName
  @InstanceName
end

#SecurityGroups ⇒ `Object`

true: 修改主机名，并自动重启实例；
false: 修改主机名，不自动重启实例，需要手动重启使新主机名生效。

注意点：本参数仅对修改主机名生效。

Parameters:

InstanceIds: —

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

修改后实例名称。可任意命名，但不得超过60个字符。
UserData: —

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

指定实例的修改后的安全组Id列表，子机将重新关联指定列表的安全组，原本关联的安全组会被解绑。<dx-alert infotype=“explain” title=“”>必须指定SecurityGroups与InstanceName的其中一个，但不能同时设置</dx-alert>
CamRoleName: —

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

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

实例销毁保护标志，表示是否允许通过api接口删除实例。取值范围：<li>true：表示开启实例保护，不允许通过api接口删除实例</li><li>false：表示关闭实例保护，允许通过api接口删除实例</li>默认取值：false。
CamRoleType: —

角色类别，与CamRoleName搭配使用，该值可从CAM DescribeRoleList, GetRole接口返回RoleType字段获取，当前只接受user、system和service_linked三种类别。
AutoReboot: —

修改实例主机名是否自动重启实例，不传默认自动重启。



6480
6481
6482

# File 'lib/v20170312/models.rb', line 6480

def SecurityGroups
  @SecurityGroups
end

#UserData ⇒ `Object`

true: 修改主机名，并自动重启实例；
false: 修改主机名，不自动重启实例，需要手动重启使新主机名生效。

注意点：本参数仅对修改主机名生效。

Parameters:

InstanceIds: —

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

修改后实例名称。可任意命名，但不得超过60个字符。
UserData: —

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

指定实例的修改后的安全组Id列表，子机将重新关联指定列表的安全组，原本关联的安全组会被解绑。<dx-alert infotype=“explain” title=“”>必须指定SecurityGroups与InstanceName的其中一个，但不能同时设置</dx-alert>
CamRoleName: —

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

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

实例销毁保护标志，表示是否允许通过api接口删除实例。取值范围：<li>true：表示开启实例保护，不允许通过api接口删除实例</li><li>false：表示关闭实例保护，允许通过api接口删除实例</li>默认取值：false。
CamRoleType: —

角色类别，与CamRoleName搭配使用，该值可从CAM DescribeRoleList, GetRole接口返回RoleType字段获取，当前只接受user、system和service_linked三种类别。
AutoReboot: —

修改实例主机名是否自动重启实例，不传默认自动重启。



6480
6481
6482

# File 'lib/v20170312/models.rb', line 6480

def UserData
  @UserData
end

Instance Method Details

#deserialize(params) ⇒ `Object`

# File 'lib/v20170312/models.rb', line 6494

def deserialize(params)
  @InstanceIds = params['InstanceIds']
  @InstanceName = params['InstanceName']
  @UserData = params['UserData']
  @SecurityGroups = params['SecurityGroups']
  @CamRoleName = params['CamRoleName']
  @HostName = params['HostName']
  @DisableApiTermination = params['DisableApiTermination']
  @CamRoleType = params['CamRoleType']
  @AutoReboot = params['AutoReboot']
end

Class: TencentCloud::Cvm::V20170312::ModifyInstancesAttributeRequest

Overview

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(instanceids = nil, instancename = nil, userdata = nil, securitygroups = nil, camrolename = nil, hostname = nil, disableapitermination = nil, camroletype = nil, autoreboot = nil) ⇒ ModifyInstancesAttributeRequest

Instance Attribute Details

#AutoReboot ⇒ Object

#CamRoleName ⇒ Object

#CamRoleType ⇒ Object

#DisableApiTermination ⇒ Object

#HostName ⇒ Object

#InstanceIds ⇒ Object

#InstanceName ⇒ Object

#SecurityGroups ⇒ Object

#UserData ⇒ Object

Instance Method Details

#deserialize(params) ⇒ Object

#initialize(instanceids = nil, instancename = nil, userdata = nil, securitygroups = nil, camrolename = nil, hostname = nil, disableapitermination = nil, camroletype = nil, autoreboot = nil) ⇒ `ModifyInstancesAttributeRequest`

#AutoReboot ⇒ `Object`

#CamRoleName ⇒ `Object`

#CamRoleType ⇒ `Object`

#DisableApiTermination ⇒ `Object`

#HostName ⇒ `Object`

#InstanceIds ⇒ `Object`

#InstanceName ⇒ `Object`

#SecurityGroups ⇒ `Object`

#UserData ⇒ `Object`

#deserialize(params) ⇒ `Object`