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

Inherits:
TencentCloud::Common::AbstractModel
  • Object
show all
Defined in:
lib/v20170312/models.rb

Overview

ModifyInstancesAttribute请求参数结构体

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

Returns a new instance of ModifyInstancesAttributeRequest.



6701
6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
 
# File 'lib/v20170312/models.rb', line 6701

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

举例：一般CamRoleName中包含“LinkedRoleIn”（如TKE_QCSLinkedRoleInPrometheusService）时，DescribeRoleList和GetRole返回的RoleType为service_linked，则本参数也需要传递service_linked。 该参数默认值为user，若CameRoleName为非service_linked类型，本参数可不传递。

  • true: 修改主机名，并自动重启实例；
  • false: 修改主机名，不自动重启实例，需要手动重启使新主机名生效。 注意点：本参数仅对修改主机名生效。

Parameters:

  • InstanceIds: —

    一个或多个待操作的实例ID。可通过DescribeInstances API返回值中的InstanceId获取。每次请求允许操作的实例数量上限是100。

  • InstanceName: —

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

  • UserData: —

    提供给实例使用的用户数据，需要以 base64 方式编码，支持的最大数据大小为 16 KB。关于获取此参数的详细介绍，请参阅 Windows 和 Linux 启动时运行命令。

  • SecurityGroups: —

    指定实例的修改后的安全组Id列表，子机将重新关联指定列表的安全组，原本关联的安全组会被解绑。

  • CamRoleName: —

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

  • HostName: —

    修改后实例的主机名。

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

  • DisableApiTermination: —

    实例销毁保护标志，表示是否允许通过api接口删除实例。取值范围：

  • true：表示开启实例保护，不允许通过api接口删除实例
  • false：表示关闭实例保护，允许通过api接口删除实例
    • 默认取值：false。

  • CamRoleType: —

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

  • AutoReboot: —

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

    • 

6699
6700
6701
    		 
    # File 'lib/v20170312/models.rb', line 6699

def AutoReboot
  @AutoReboot
end

    #CamRoleName ⇒ Object

    举例：一般CamRoleName中包含“LinkedRoleIn”（如TKE_QCSLinkedRoleInPrometheusService）时，DescribeRoleList和GetRole返回的RoleType为service_linked，则本参数也需要传递service_linked。 该参数默认值为user，若CameRoleName为非service_linked类型，本参数可不传递。

    • true: 修改主机名，并自动重启实例；
    • false: 修改主机名，不自动重启实例，需要手动重启使新主机名生效。 注意点：本参数仅对修改主机名生效。

    Parameters:

    • InstanceIds: —

      一个或多个待操作的实例ID。可通过DescribeInstances API返回值中的InstanceId获取。每次请求允许操作的实例数量上限是100。

    • InstanceName: —

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

    • UserData: —

      提供给实例使用的用户数据，需要以 base64 方式编码，支持的最大数据大小为 16 KB。关于获取此参数的详细介绍，请参阅 Windows 和 Linux 启动时运行命令。

    • SecurityGroups: —

      指定实例的修改后的安全组Id列表，子机将重新关联指定列表的安全组，原本关联的安全组会被解绑。

    • CamRoleName: —

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

    • HostName: —

      修改后实例的主机名。

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

  • DisableApiTermination: —

    实例销毁保护标志，表示是否允许通过api接口删除实例。取值范围：

  • true：表示开启实例保护，不允许通过api接口删除实例
  • false：表示关闭实例保护，允许通过api接口删除实例
    • 默认取值：false。

  • CamRoleType: —

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

  • AutoReboot: —

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

    • 

6699
6700
6701
    		 
    # File 'lib/v20170312/models.rb', line 6699

def CamRoleName
  @CamRoleName
end

    #CamRoleType ⇒ Object

    举例：一般CamRoleName中包含“LinkedRoleIn”（如TKE_QCSLinkedRoleInPrometheusService）时，DescribeRoleList和GetRole返回的RoleType为service_linked，则本参数也需要传递service_linked。 该参数默认值为user，若CameRoleName为非service_linked类型，本参数可不传递。

    • true: 修改主机名，并自动重启实例；
    • false: 修改主机名，不自动重启实例，需要手动重启使新主机名生效。 注意点：本参数仅对修改主机名生效。

    Parameters:

  • DisableApiTermination: —

    实例销毁保护标志，表示是否允许通过api接口删除实例。取值范围：

  • true：表示开启实例保护，不允许通过api接口删除实例
  • false：表示关闭实例保护，允许通过api接口删除实例
    • 默认取值：false。

  • CamRoleType: —

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

  • AutoReboot: —

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

    • 

6699
6700
6701
    		 
    # File 'lib/v20170312/models.rb', line 6699

def CamRoleType
  @CamRoleType
end

    #DisableApiTermination ⇒ Object

    举例：一般CamRoleName中包含“LinkedRoleIn”（如TKE_QCSLinkedRoleInPrometheusService）时，DescribeRoleList和GetRole返回的RoleType为service_linked，则本参数也需要传递service_linked。 该参数默认值为user，若CameRoleName为非service_linked类型，本参数可不传递。

    • true: 修改主机名，并自动重启实例；
    • false: 修改主机名，不自动重启实例，需要手动重启使新主机名生效。 注意点：本参数仅对修改主机名生效。

    Parameters:

  • DisableApiTermination: —

    实例销毁保护标志，表示是否允许通过api接口删除实例。取值范围：

  • true：表示开启实例保护，不允许通过api接口删除实例
  • false：表示关闭实例保护，允许通过api接口删除实例
    • 默认取值：false。

  • CamRoleType: —

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

  • AutoReboot: —

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

    • 

6699
6700
6701
    		 
    # File 'lib/v20170312/models.rb', line 6699

def DisableApiTermination
  @DisableApiTermination
end

    #HostName ⇒ Object

    举例：一般CamRoleName中包含“LinkedRoleIn”（如TKE_QCSLinkedRoleInPrometheusService）时，DescribeRoleList和GetRole返回的RoleType为service_linked，则本参数也需要传递service_linked。 该参数默认值为user，若CameRoleName为非service_linked类型，本参数可不传递。

    • true: 修改主机名，并自动重启实例；
    • false: 修改主机名，不自动重启实例，需要手动重启使新主机名生效。 注意点：本参数仅对修改主机名生效。

    Parameters:

  • DisableApiTermination: —

    实例销毁保护标志，表示是否允许通过api接口删除实例。取值范围：

  • true：表示开启实例保护，不允许通过api接口删除实例
  • false：表示关闭实例保护，允许通过api接口删除实例
    • 默认取值：false。

  • CamRoleType: —

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

  • AutoReboot: —

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

    • 

6699
6700
6701
    		 
    # File 'lib/v20170312/models.rb', line 6699

def HostName
  @HostName
end

    #InstanceIds ⇒ Object

    举例：一般CamRoleName中包含“LinkedRoleIn”（如TKE_QCSLinkedRoleInPrometheusService）时，DescribeRoleList和GetRole返回的RoleType为service_linked，则本参数也需要传递service_linked。 该参数默认值为user，若CameRoleName为非service_linked类型，本参数可不传递。

    • true: 修改主机名，并自动重启实例；
    • false: 修改主机名，不自动重启实例，需要手动重启使新主机名生效。 注意点：本参数仅对修改主机名生效。

    Parameters:

  • DisableApiTermination: —

    实例销毁保护标志，表示是否允许通过api接口删除实例。取值范围：

  • true：表示开启实例保护，不允许通过api接口删除实例
  • false：表示关闭实例保护，允许通过api接口删除实例
    • 默认取值：false。

  • CamRoleType: —

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

  • AutoReboot: —

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

    • 

6699
6700
6701
    		 
    # File 'lib/v20170312/models.rb', line 6699

def InstanceIds
  @InstanceIds
end

    #InstanceName ⇒ Object

    举例：一般CamRoleName中包含“LinkedRoleIn”（如TKE_QCSLinkedRoleInPrometheusService）时，DescribeRoleList和GetRole返回的RoleType为service_linked，则本参数也需要传递service_linked。 该参数默认值为user，若CameRoleName为非service_linked类型，本参数可不传递。

    • true: 修改主机名，并自动重启实例；
    • false: 修改主机名，不自动重启实例，需要手动重启使新主机名生效。 注意点：本参数仅对修改主机名生效。

    Parameters:

  • DisableApiTermination: —

    实例销毁保护标志，表示是否允许通过api接口删除实例。取值范围：

  • true：表示开启实例保护，不允许通过api接口删除实例
  • false：表示关闭实例保护，允许通过api接口删除实例
    • 默认取值：false。

  • CamRoleType: —

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

  • AutoReboot: —

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

    • 

6699
6700
6701
    		 
    # File 'lib/v20170312/models.rb', line 6699

def InstanceName
  @InstanceName
end

    #SecurityGroups ⇒ Object

    举例：一般CamRoleName中包含“LinkedRoleIn”（如TKE_QCSLinkedRoleInPrometheusService）时，DescribeRoleList和GetRole返回的RoleType为service_linked，则本参数也需要传递service_linked。 该参数默认值为user，若CameRoleName为非service_linked类型，本参数可不传递。

    • true: 修改主机名，并自动重启实例；
    • false: 修改主机名，不自动重启实例，需要手动重启使新主机名生效。 注意点：本参数仅对修改主机名生效。

    Parameters:

  • DisableApiTermination: —

    实例销毁保护标志，表示是否允许通过api接口删除实例。取值范围：

  • true：表示开启实例保护，不允许通过api接口删除实例
  • false：表示关闭实例保护，允许通过api接口删除实例
    • 默认取值：false。

  • CamRoleType: —

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

  • AutoReboot: —

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

    • 

6699
6700
6701
    		 
    # File 'lib/v20170312/models.rb', line 6699

def SecurityGroups
  @SecurityGroups
end

    #UserData ⇒ Object

    举例：一般CamRoleName中包含“LinkedRoleIn”（如TKE_QCSLinkedRoleInPrometheusService）时，DescribeRoleList和GetRole返回的RoleType为service_linked，则本参数也需要传递service_linked。 该参数默认值为user，若CameRoleName为非service_linked类型，本参数可不传递。

    • true: 修改主机名，并自动重启实例；
    • false: 修改主机名，不自动重启实例，需要手动重启使新主机名生效。 注意点：本参数仅对修改主机名生效。

    Parameters:

  • DisableApiTermination: —

    实例销毁保护标志，表示是否允许通过api接口删除实例。取值范围：

  • true：表示开启实例保护，不允许通过api接口删除实例
  • false：表示关闭实例保护，允许通过api接口删除实例
    • 默认取值：false。

  • CamRoleType: —

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

  • AutoReboot: —

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

    • 

6699
6700
6701
    		 
    # File 'lib/v20170312/models.rb', line 6699

def UserData
  @UserData
end

    Instance Method Details

    #deserialize(params) ⇒ Object 

    

6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
    		 
    # File 'lib/v20170312/models.rb', line 6713

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